Elasticsearch tile

About Elasticsearch tiles

The Elasticssearch tile can show data from your Elasticsearch instance. Since Elasticsearch tiles are designed specifically to integrate with Elasticsearch, they offer you a convenient way to access your Elasticsearch indices and enter search queries.

How to configure an Elasticsearch tile

If you don't already have an Elasticsearch provider, you need to create one before you can configure an Elasticsearch tile (How to add an Elasticsearch provider).

  1. Add a new tile to a dashboard and click on Integrations > Elasticsearch.
  2. Select the visualization for your Elasticsearch tile and click next.

  3. Scope
    Select the scope for your tile (optional).

  4. Provider:
    Select your Elasticsearch provider from the select provider drop-down and click next.

    You can only use providers of the same type as the tile. Providers of other types won't be shown in the select provider drop-down.

     
  5. Query:
    Index:
    Click in the field to see a list of all indices that exist in the Elasticsearch provider you chose. Choose the index or indices you want to use for your tile.
    Search type (not for line graphs and sparklines):
    Here you enter the search query for the data you want to display. You can choose between the options lucene, where you need to use Lucene query syntax, and query dsl, where you need to use Query DSL syntax. If a simple lucene query is not sufficient for your data request, switch to query dsl to specify your request.
    Search (only for line graphs and sparklines):
    Here you enter the search query for the data you want to display. You need to use Query DSL syntax. There's already a default query with a simple aggregation in the search field to help you get started.
    Note: For your queries, you need to know the names of the columns in the index you are using. You can find the column names in your elasticsearch index.
    The templates button
    to access search query templates you have created in Elasticsearch. Using a template will copy the search query template into the field, which means that if you make changes to the template in Elasticsearch, those changes will not be automatically pulled into the tile.

    If you defined a scope you can use the mustache picker

    to insert scope variables (values that refer only to the defined scope) into your query.

    You can use the clock insert time value button

    to insert page timeframe and date variables in your query.

    Click next.
  6. Response data (only for bar graphs, donuts, scalars, grids, and status icons or blocks)

    Here you can see the response data from the query in the response data field. For most use cases, you need to limit the query response to the specific property you want to use for your data. You pick the property you want to use by entering the key path to the property in the key path field. If you don't need to limit the query result and can use the entire response (for example, if the response data returns the array you want to use at the root of the response), you can leave the key path field empty.


    The structure of the response data tells you where to find the property you want to use.
    Example:

    },
"hits": {
	"total": {
		"value": 8157,
		"relation": "eq"
},


    If your response data looks like the example above and you want to display the "value" of "hits", you need to enter hits.total.value in the key path field.
    If you want to use the whole array of "hits", you need to enter hits in the key path field.

    Click next.
  7. Settings for the visualization:
    Configure the settings for the visualization you chose.

  8. Click done to save the tile.

    The tile now shows data according to your settings.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket