From edb5cccaff2793e41f040f748bc39d6673bba149 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 11:28:01 -0700 Subject: [PATCH 01/12] for telemetry issue 494 https://github.com/opensearch-project/documentation-website/issues/494 Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 40 +++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 _dashboards/search-telemetry.md diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md new file mode 100644 index 00000000..5101a896 --- /dev/null +++ b/_dashboards/search-telemetry.md @@ -0,0 +1,40 @@ +--- +layout: default +title: Search telemetry +nav_order: 21 +--- + + +# About Search telemetry + +Search Telemetry is used to analyze performance for success or failed search requests in OpenSearch Dashboards. Telemetry data is saved in the `.kibana_1` index. + +Because there are thousands of concurrent search request from OpenSearch Dashboards, the large traffic causes significant load in an OpenSearch cluster. + +To improve performance for your OpenSearch cluster, you can turn off search telemetry. + +## Disable search telemetry to improve cluster performance + +You can suppress the search usage telemetry by enabling the `data.search.usageTelemetry.enabled` setting in your `opensearch_dashboard.yml` file. + +Alternatively, you can modify the Data plugin config file to opt out of search telemetry. + +### To opt-in or opt-out of search telemetry data + +There are several combinations of OpenSearch Dashboards YAML file and Data plugin configuration file values that allow you to either opt-in or opt-out of using search telemetry in your cluster. + +The following table shows the combination of values for the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` and the Data plugin configuration file values that will result in search telemetry opt-in or opt-out. +This table refers to these settings: + +* OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` value is either `true`, `false` or `none`. +* Data plugin configuration file value is either `true`, or `false`. + +OpenSearch Dashboards YML value | Data plugin config value | Opt-in or Opt-out of search telemetry +:--- | :--- | :--- + `true` | `false` | Opt-in + `true` | `true` | Opt-in + `none` | `true` | Opt-in + `true` | `true` | Opt-in + `none` | `false` | Opt-out + `false` | `true` | Opt-out + `false` | `false` | Opt-out \ No newline at end of file From 430c9d56545f18a0734a5c0f8560384f567035b9 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 11:42:36 -0700 Subject: [PATCH 02/12] for data config file example Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index 5101a896..4b93b6c3 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -17,6 +17,9 @@ To improve performance for your OpenSearch cluster, you can turn off search tele You can suppress the search usage telemetry by enabling the `data.search.usageTelemetry.enabled` setting in your `opensearch_dashboard.yml` file. +{: note} +You can find the OpenSearch Dashboards YAML file in the opensearch-project GitHub directory: OpenSearch-Dashboards/config/opensearch_dashboards.yml + Alternatively, you can modify the Data plugin config file to opt out of search telemetry. ### To opt-in or opt-out of search telemetry data @@ -27,7 +30,7 @@ The following table shows the combination of values for the OpenSearch Dashboard This table refers to these settings: * OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` value is either `true`, `false` or `none`. -* Data plugin configuration file value is either `true`, or `false`. +* Data plugin configuration file setting `search.usageTelemetry.enabled` value is either `true`, or `false`. OpenSearch Dashboards YML value | Data plugin config value | Opt-in or Opt-out of search telemetry :--- | :--- | :--- @@ -37,4 +40,13 @@ OpenSearch Dashboards YML value | Data plugin config value | Opt-in or Opt-out o `true` | `true` | Opt-in `none` | `false` | Opt-out `false` | `true` | Opt-out - `false` | `false` | Opt-out \ No newline at end of file + `false` | `false` | Opt-out + + #### Sample opensearch_dashboards.yml + + This OpenSearch Dashboards YAML file excerpt shows the telemetry setting set to `false` to opt-out: + + ```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: false +``` \ No newline at end of file From 2e3e173d0d84af21b3e63a4ddf29cad62fed25bb Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 11:57:11 -0700 Subject: [PATCH 03/12] small rewrite Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index 4b93b6c3..c8d37d03 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -24,15 +24,11 @@ Alternatively, you can modify the Data plugin config file to opt out of search t ### To opt-in or opt-out of search telemetry data -There are several combinations of OpenSearch Dashboards YAML file and Data plugin configuration file values that allow you to either opt-in or opt-out of using search telemetry in your cluster. +You can opt-in or opt-out of using search telemetry in your cluster by changing the configuration values in both the OpenSearch Dashboards YAML and Data plugin configuration files. -The following table shows the combination of values for the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` and the Data plugin configuration file values that will result in search telemetry opt-in or opt-out. -This table refers to these settings: +The following table shows the combination of values for the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` and the Data plugin configuration file setting `search.usageTelemetry.enabled` values that will result in search telemetry opt-in or opt-out. -* OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` value is either `true`, `false` or `none`. -* Data plugin configuration file setting `search.usageTelemetry.enabled` value is either `true`, or `false`. - -OpenSearch Dashboards YML value | Data plugin config value | Opt-in or Opt-out of search telemetry +OpenSearch Dashboards YML value | Data plugin config value | Opt-in or Opt-out of search telemetry :--- | :--- | :--- `true` | `false` | Opt-in `true` | `true` | Opt-in From b56236155c4d436e31063695ec1d300fdeef1b24 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 12:10:10 -0700 Subject: [PATCH 04/12] change nav_order entry to show in left nav Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index c8d37d03..205d30f2 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -1,7 +1,7 @@ --- layout: default title: Search telemetry -nav_order: 21 +nav_order: 30 --- From 248a5cbc01e5992be72d7acd64f32d90f12fff42 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 14:37:05 -0700 Subject: [PATCH 05/12] initial tech review comments updates Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 44 +++++++++++++++++++++++---------- 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index 205d30f2..f8e46382 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -5,20 +5,25 @@ nav_order: 30 --- -# About Search telemetry +# About search telemetry -Search Telemetry is used to analyze performance for success or failed search requests in OpenSearch Dashboards. Telemetry data is saved in the `.kibana_1` index. +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. Because there are thousands of concurrent search request from OpenSearch Dashboards, the large traffic causes significant load in an OpenSearch cluster. -To improve performance for your OpenSearch cluster, you can turn off search telemetry. +By default it is disabled, so you need to do some configuration changes to enable it. -## Disable search telemetry to improve cluster performance +OpenSearch clusters perform better with search telemetry turned off. +{: .tip } -You can suppress the search usage telemetry by enabling the `data.search.usageTelemetry.enabled` setting in your `opensearch_dashboard.yml` file. +To learn more about using telemetry data with OpenSearch Dashboards, see [Trace Analytics OpenSearch Dashboards plugin](docs/2.0/observability-plugin/trace/ta-dashboards/). -{: note} -You can find the OpenSearch Dashboards YAML file in the opensearch-project GitHub directory: OpenSearch-Dashboards/config/opensearch_dashboards.yml +## Enable search telemetry + +Search usage telemetry is disabled by default. To enable it, you need to set the `data.search.usageTelemetry.enabled` setting to `true` in the `opensearch_dashboard.yml` file. + +You can find the OpenSearch Dashboards YAML file in the opensearch-project GitHub directory: `OpenSearch-Dashboards/config/opensearch_dashboards.yml` +{: .note } Alternatively, you can modify the Data plugin config file to opt out of search telemetry. @@ -26,23 +31,36 @@ Alternatively, you can modify the Data plugin config file to opt out of search t You can opt-in or opt-out of using search telemetry in your cluster by changing the configuration values in both the OpenSearch Dashboards YAML and Data plugin configuration files. -The following table shows the combination of values for the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` and the Data plugin configuration file setting `search.usageTelemetry.enabled` values that will result in search telemetry opt-in or opt-out. +The following table shows the combination of values for the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` and the Data plugin configuration file src/plugins/data/config.ts setting `search.usageTelemetry.enabled` values that will result in search telemetry opt-in or opt-out. -OpenSearch Dashboards YML value | Data plugin config value | Opt-in or Opt-out of search telemetry +In the data configuration file (), + + + +OpenSearch Dashboards YAML value | Data plugin config value | Opt-in or Opt-out of search telemetry :--- | :--- | :--- `true` | `false` | Opt-in `true` | `true` | Opt-in `none` | `true` | Opt-in - `true` | `true` | Opt-in `none` | `false` | Opt-out `false` | `true` | Opt-out `false` | `false` | Opt-out - #### Sample opensearch_dashboards.yml +#### Sample opensearch_dashboards.yml This OpenSearch Dashboards YAML file excerpt shows the telemetry setting set to `false` to opt-out: ```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: false +# 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: false +``` + +#### Sample data configuration file with telemetry enabled + +This excerpt shows the `/src/plugins/data/config.ts` file with telemetry set to enabled: +```json +. . . +usageTelemetry: schema.object({ + enabled: schema.boolean({ defaultValue: false }), ``` \ No newline at end of file From faedd9fbace1c09af620dcfc58633606a22badb2 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 15:01:44 -0700 Subject: [PATCH 06/12] to clarify data plugin and config file location to enable telemetry Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index f8e46382..9d065c16 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -31,11 +31,7 @@ Alternatively, you can modify the Data plugin config file to opt out of search t You can opt-in or opt-out of using search telemetry in your cluster by changing the configuration values in both the OpenSearch Dashboards YAML and Data plugin configuration files. -The following table shows the combination of values for the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` and the Data plugin configuration file src/plugins/data/config.ts setting `search.usageTelemetry.enabled` values that will result in search telemetry opt-in or opt-out. - -In the data configuration file (), - - +The following table shows the combination of values for the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` and the Data plugin configuration file OpenSearch-Dashboards/src/plugins/data/config.ts setting `usageTelemetry` values that will result in search telemetry opt-in or opt-out. OpenSearch Dashboards YAML value | Data plugin config value | Opt-in or Opt-out of search telemetry :--- | :--- | :--- @@ -56,11 +52,11 @@ OpenSearch Dashboards YAML value | Data plugin config value | Opt-in or Opt-out data.search.usageTelemetry.enabled: false ``` -#### Sample data configuration file with telemetry enabled +#### Sample data configuration file with telemetry disabled -This excerpt shows the `/src/plugins/data/config.ts` file with telemetry set to enabled: +By default, the data plugin configuration file sets telemetry to `false`. This excerpt shows the OpenSearch-Dashboards/src/plugins/data/config.ts file with telemetry enabled: ```json . . . usageTelemetry: schema.object({ - enabled: schema.boolean({ defaultValue: false }), + enabled: schema.boolean({ defaultValue: true }), ``` \ No newline at end of file From d7c96a4be1a8977f238e453969c5a07f46abcb31 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 15:34:41 -0700 Subject: [PATCH 07/12] make it clear only need to update YAML file to enable search telemetry Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index 9d065c16..26143617 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -16,22 +16,23 @@ By default it is disabled, so you need to do some configuration changes to enabl OpenSearch clusters perform better with search telemetry turned off. {: .tip } -To learn more about using telemetry data with OpenSearch Dashboards, see [Trace Analytics OpenSearch Dashboards plugin](docs/2.0/observability-plugin/trace/ta-dashboards/). - ## Enable search telemetry -Search usage telemetry is disabled by default. To enable it, you need to set the `data.search.usageTelemetry.enabled` setting to `true` in the `opensearch_dashboard.yml` file. +Search usage telemetry is disabled by default. To enable it, you need to change the OpenSearch Dashboards YAML file `opensearch_dashboards.yml` setting `data.search.usageTelemetry.enabled` to `true`. -You can find the OpenSearch Dashboards YAML file in the opensearch-project GitHub directory: `OpenSearch-Dashboards/config/opensearch_dashboards.yml` +You can find the OpenSearch Dashboards YAML file in the opensearch-project GitHub directory: `OpenSearch-Dashboards/config/opensearch_dashboards.yml`. + +When you enable telemetry in the OpenSearch Dashboards YAML file, this overrides the default `false` telemetry setting in the [Data plugin configuration file](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/config.ts). {: .note } -Alternatively, you can modify the Data plugin config file to opt out of search telemetry. + -#### Sample opensearch_dashboards.yml +#### Sample opensearch_dashboards.yml with telemetry enabled - This OpenSearch Dashboards YAML file excerpt shows the telemetry setting set to `false` to opt-out: + This OpenSearch Dashboards YAML file excerpt shows the telemetry setting set to `true` to opt-in to 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: false -``` - -#### Sample data configuration file with telemetry disabled - -By default, the data plugin configuration file sets telemetry to `false`. This excerpt shows the OpenSearch-Dashboards/src/plugins/data/config.ts file with telemetry enabled: -```json -. . . -usageTelemetry: schema.object({ - enabled: schema.boolean({ defaultValue: true }), + data.search.usageTelemetry.enabled: true ``` \ No newline at end of file From f4cc1f3ea12129cf61e5c47ccff0bf8ad5ae8be0 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 15:58:30 -0700 Subject: [PATCH 08/12] for modified table to opt-in or out from search telemetry Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index 26143617..ab0e72ec 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -24,25 +24,15 @@ You can find the OpenSearch Dashboards YAML file in the opensearch-project GitHu When you enable telemetry in the OpenSearch Dashboards YAML file, this overrides the default `false` telemetry setting in the [Data plugin configuration file](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/config.ts). {: .note } - - +OpenSearch Dashboards YAML value | Opt-in or Opt-out of search telemetry +:--- | :--- + `true` | Opt-in + `false` | Opt-out + `none` | Opt-out #### Sample opensearch_dashboards.yml with telemetry enabled From 8f26f9a280103299209b4fe8a805f2888479be4e Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 16:12:49 -0700 Subject: [PATCH 09/12] last clarity rewrite Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index ab0e72ec..ead9b249 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -11,8 +11,6 @@ You can use search telemetry to analyze performance for success or failed search Because there are thousands of concurrent search request from OpenSearch Dashboards, the large traffic causes significant load in an OpenSearch cluster. -By default it is disabled, so you need to do some configuration changes to enable it. - OpenSearch clusters perform better with search telemetry turned off. {: .tip } @@ -26,7 +24,7 @@ When you enable telemetry in the OpenSearch Dashboards YAML file, this overrides {: .note } ### To opt-in or opt-out of search telemetry data -The following table shows the values to opt-in or opt-out of search telemetry data in the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled`. +The following table shows the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` values you can choose to opt-in or opt-out of search telemetry. OpenSearch Dashboards YAML value | Opt-in or Opt-out of search telemetry :--- | :--- From 3c474d08778266dfaa0658b20c0cd65f4b51d70e Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 16:55:07 -0700 Subject: [PATCH 10/12] for reviewer comment updates Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index ead9b249..4cd608c1 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -9,22 +9,22 @@ nav_order: 30 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. -Because there are thousands of concurrent search request from OpenSearch Dashboards, the large traffic causes significant load in an OpenSearch cluster. +Because there are thousands of concurrent search requests from OpenSearch Dashboards, the large traffic can cause significant load in an OpenSearch cluster. OpenSearch clusters perform better with search telemetry turned off. {: .tip } ## Enable search telemetry -Search usage telemetry is disabled by default. To enable it, you need to change the OpenSearch Dashboards YAML file `opensearch_dashboards.yml` setting `data.search.usageTelemetry.enabled` to `true`. +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. -You can find the OpenSearch Dashboards YAML file in the opensearch-project GitHub directory: `OpenSearch-Dashboards/config/opensearch_dashboards.yml`. +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 on GitHub. -When you enable telemetry in the OpenSearch Dashboards YAML file, this overrides the default `false` telemetry setting in the [Data plugin configuration file](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/config.ts). +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). {: .note } ### To opt-in or opt-out of search telemetry data -The following table shows the OpenSearch Dashboards YAML file setting `data.search.usageTelemetry.enabled` values you can choose 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 opt-in or opt-out of search telemetry. OpenSearch Dashboards YAML value | Opt-in or Opt-out of search telemetry :--- | :--- From be7a9d4fcf230e0bed31210f1958eca59a5de9c3 Mon Sep 17 00:00:00 2001 From: alicejw Date: Fri, 20 May 2022 17:27:47 -0700 Subject: [PATCH 11/12] small fixes Signed-off-by: alicejw --- _dashboards/search-telemetry.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index 4cd608c1..9f720231 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -18,10 +18,11 @@ OpenSearch clusters perform better with search telemetry turned off. 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. -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 on GitHub. +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). {: .note } + ### To opt-in or opt-out of search telemetry data 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. From 7af874eecc2d9ff45aa0344c94592e11d5bb6f22 Mon Sep 17 00:00:00 2001 From: alicejw Date: Mon, 23 May 2022 11:44:30 -0700 Subject: [PATCH 12/12] 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