Link Search Menu Expand Document Documentation Menu

Managing search telemetry settings

You can use search telemetry to analyze search request performance by success or failure in OpenSearch Dashboards. OpenSearch stores telemetry data in the .kibana_1 index.

Because there are thousands of concurrent search requests from OpenSearch Dashboards, the heavy traffic can cause significant load in an OpenSearch cluster.

OpenSearch clusters perform better with search telemetry turned off.

Turning on search telemetry

Search usage telemetry is turned off by default. To turn it on, you need to set to true in the opensearch_dashboards.yml file.

You can find the OpenSearch Dashboards YAML file in the opensearch-project repository on GitHub.

Turning on telemetry in the opensearch_dashboards.yml file overrides the default search telemetry setting of false in the Data plugin configuration file.

Turning search telemetry on or off

The following table shows the values you can set in opensearch_dashboards.yml to turn search telemetry on or off.

OpenSearch Dashboards YAML value Search telemetry status: on or off
true On
false Off
none Off

Sample opensearch_dashboards.yml with telemetry enabled

This OpenSearch Dashboards YAML file excerpt shows the telemetry setting set to true to turn on search telemetry:

# Set the value of this setting to false to suppress 
# search usage telemetry to reduce the load of the OpenSearch cluster. true
350 characters left

Want to contribute? or .