iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

make it clear only need to update YAML file to enable search telemetry 

Signed-off-by: alicejw <alicejw@amazon.com>
This commit is contained in:
alicejw 2022-05-20 15:34:41 -07:00
parent faedd9fbac
commit d7c96a4be1
1 changed files with 11 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
_dashboards/search-telemetry.md
View File

@ -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.
<!-- they don't need this table after all. the .yml file changed to 'true' will override the detault setting in the data plugin config file. but saving in-case SMEs decide they can change the data plugin config file at a later date.
### To opt-in or opt-out of search telemetry data
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 OpenSearch-Dashboards/src/plugins/data/config.ts setting `usageTelemetry` 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
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
:--- | :--- | :---
@ -41,22 +42,14 @@ OpenSearch Dashboards YAML value | Data plugin config value | Opt-in or Opt-out
`none` | `false` | Opt-out
`false` | `true` | Opt-out
`false` | `false` | Opt-out
-->
#### 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
```