Skip to content

Commit

Permalink
Updates title (#2762)
Browse files Browse the repository at this point in the history
Signed-off-by: vagimeli <vagimeli@amazon.com>
(cherry picked from commit 7ba0d6d)
  • Loading branch information
vagimeli committed Feb 9, 2023
1 parent ff078da commit 700a6d8
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions _dashboards/search-telemetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: default
title: Managing search telemetry settings
nav_order: 100
---


# 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.
{: .tip }

## Turning on search telemetry

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](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/config/opensearch_dashboards.yml) 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](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/config.ts).
{: .note }

### Turning search telemetry on or off

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

#### 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:

```json
# 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
```

0 comments on commit 700a6d8

Please sign in to comment.