From 7af874eecc2d9ff45aa0344c94592e11d5bb6f22 Mon Sep 17 00:00:00 2001 From: alicejw Date: Mon, 23 May 2022 11:44:30 -0700 Subject: [PATCH] for editor's feedback updates Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index 9f720231..37fed631 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -7,35 +7,35 @@ nav_order: 30 # About search telemetry -You can use search telemetry to analyze performance for success or failed search requests in OpenSearch Dashboards. OpenSearch stores telemetry data in the `.kibana_1` index. +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 large traffic can cause significant load in an OpenSearch cluster. +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 } -## Enable search telemetry +## Turn on search telemetry -Search usage telemetry is disabled by default. To enable it, you need to set `data.search.usageTelemetry.enabled` to `true` in the `opensearch_dashboards.yml` file. +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. -Enabling 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). +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 } -### To opt-in or opt-out of search telemetry data +### Turn search telemetry on or off -The following table shows the `data.search.usageTelemetry.enabled` values you can set in `opensearch_dashboards.yml` to opt-in or opt-out of search telemetry. +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 | Opt-in or Opt-out of search telemetry +OpenSearch Dashboards YAML value | Search telemetry status: on or off :--- | :--- - `true` | Opt-in - `false` | Opt-out - `none` | Opt-out + `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 opt-in to search telemetry: + 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