Opensearch

Opensearch is a Warehouse output connector. Distributed search and analytics engine.

IP Allowlists

You might need to add the Monad IP range of 34.210.32.104/32 to your Opensearch allowlist, so Monad can connect to it.

Identify some Configurations of your Opensearch Instance

There are a number of configuration settings you will need to know about your opensearch instance.

  1. Scheme: http or https.
  2. Host: The hostname of your opensearch instance. ex) monad-def1gdsl2uyfc3b12dc.us-east-1.es.amazonaws.com
  3. Port: Usually 9200 or 443.
  4. SSL CA File: The path to SSL CA Certificate file. An optional parameter to be used with https.

You will also need one of the following types of authentication:

  • Username and Password: Consult your opensearch instance administrator for this value. It should be the same value used to log into the opensearch UI.

Required Privileges:

  • The user must have certain privileges. If you have admin permissions, you can check this by going into your opensearch instance. Navigate to Security > Roles. Click on the role then on Mapped users to see which users have the specified role. The combination of roles assigned to a user should have the following privileges.
    • Cluster Privileges: cluster:monitor/main, indices:data/write/bulk*
    • Index Privileges: create_index, write

Additionally there are a few more optional fields which are reserved mainly for advanced usage. You can specify the name of your indices via the index format field. By default it is set to **, or the name of the mom tables. For more information on how to use Index Format, Index Schema Fields, or Metadata Fields, consult the settings section here

Setting up an Opensearch output connector in Monad

To set up an Opensearch connector, you will need to know the above mentioned configuration details. Once you have this information, you set up the connector:

  1. Log in to your Monad account, and click Add connector.
  2. Select the Opensearch connector.
  3. Fill in the required fields. If you are using https for your scheme, you can supply an ssl ca cert file.
  4. Click Test Connection and standby while Monad to confirms the credentials are valid.
  5. Optionally, change the default name for the connector. This name serves as a label for the connector in the Monad app, and you can change it later.
  6. In the Models to Export field, specify which data models you wish to export to your opensearch instance.
  7. You can specify an Index Format to store exports under different indices. Read the note below for more information.
  8. Click Connect.

Monad then tests the connection to opensearch, and if successful, begins syncing data from your Monad account into your opensearch instance.

NOTE: The opensearch connector will export ALL specified data on each run. So if you run the connector multiple times you may end up with duplicate data. To avoid duplicate data within an index, you can store exports in different indices by modifying the index format field to add a prefix or suffix to an export name.

This page was last modified: 13 Dec 2023