Intro
Elasticsearch is the distributed search and analytics engine at the heart of the Elastic Stack. With this connector visualize your ElasticSearch data in Domo for additional insights. Use Domo’s Elasticsearch connector to return search hits that match the query defined in the request. Get real-time dashboards of your data, available from any device. To learn more about the Elasticsearch API, visit their page (https://www.elastic.co/guide/en/elas…est-apis.htmlL ). You connect to your Elasticsearch account in the Data Center. This topic discusses the fields and menus that are specific to the Elasticsearch connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.Prerequisites
To connect to your Elasticsearch account and create a DataSet, you must have the following:- Your Elasticsearch host name
- The username and password associated with your Elasticsearch account
Connecting to Your Elasticsearch Account
This section enumerates the options in the Credentials and Details panes in the Elasticsearch Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.Credentials Pane
This pane contains fields for entering credentials to connect to your Elasticsearch account. The following table describes what is needed for each field:Field | Description |
|---|---|
| Host | Enter your Elasticsearch hostname. |
| Username | Enter the username associated with your Elasticsearch account. |
| Password | Enter the password associated with your Elasticsearch account. |
Details Pane
This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.Menu | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
Report | Select the Elasticsearch report you want to run. The following reports are available:
| ||||||||
| Field | Enter the field name to sort the data on. By default ‘_id’ will be used if not provided. Provide a custom field in the ‘Query’ text box, if it is a custom field name. Note: If ‘QUERY’ doesn’t contain the sort array support, the sort array will get added with the FIELD value. | ||||||||
| Query | Query in the Lucene query string syntax. | ||||||||
| Index | Comma-separated list or wildcard expression of index names used to limit the request. | ||||||||
| Use Advanced Sublist To Flatten options | Select ‘Yes’ if you want to use the advanced Sublist To Flatten option. If you select ‘Yes,’ the primitive arrays will be expanded in a single cell. | ||||||||
| Sublists To Flatten | Enter the comma separated lists that you would like to flatten in your data. | ||||||||
| Delimiter For Primitive Arrays | Select the delimiting character to separate the primitive array values in a cell |
Other Panes
For information about the remaining sections of the Connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.Troubleshooting
- Make sure your authentication remains valid.
- Review the configuration to make sure that all required items have been selected.
- Review the Connector history for error messages.
- In rare cases, you may be requesting too much information and reaching API limitations or timeouts. If this is the case, you can review the history of the Connector run to see the error message and duration. If this is the case, you can reduce the number of accounts that are being pulled, choose a smaller number of metrics for the report that you are pulling, or reduce the timeframe that you are trying to pull.