layout | title | nav_order |
---|---|---|
default |
Search telemetry |
140 |
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. {: .tip }
Search usage telemetry is turned off by default. To turn it on, you need to set data.search.usageTelemetry.enabled
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.
{: .note }
The following table shows the data.search.usageTelemetry.enabled
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 |
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.
data.search.usageTelemetry.enabled: true