From 5d25987b69a89334fdc2d973e928db633c6fa3ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Thu, 25 May 2023 17:44:08 +0200 Subject: [PATCH] [8.7] [DOCS] Telemetry settings: improve phrasing (#158396) (#158466) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Backport This will backport the following commits from `main` to `8.7`: - [[DOCS] Telemetry settings: improve phrasing (#158396)](https://github.com/elastic/kibana/pull/158396) ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) \n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Alejandro Fernández Haro "}},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/158396","number":158396,"mergeCommit":{"message":"[DOCS] Telemetry settings: improve phrasing (#158396)","sha":"995b0a46e9da573d14bf0e5af27b4b028bd5293d"}}]}] BACKPORT--> --- docs/settings/telemetry-settings.asciidoc | 28 +++++++++++------------ docs/setup/settings.asciidoc | 5 ++-- 2 files changed, 15 insertions(+), 18 deletions(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index 46d002177680..ae984cc6fd12 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -4,32 +4,30 @@ Telemetry settings ++++ -By default, Usage Collection (also known as Telemetry) is enabled. This -helps us learn about the {kib} features that our users are most interested in, so we -can focus our efforts on making them even better. +Usage Collection (also known as Telemetry) is enabled by default. This allows us to learn what our users are most interested in, so we can improve our products and services. + +Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] to learn more. You can control whether this data is sent from the {kib} servers, or if it should be sent from the user's browser, in case a firewall is blocking the connections from the server. Additionally, you can decide to completely disable this feature either in the config file or in {kib} via *Management > Kibana > Advanced Settings > Usage Data*. -See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to learn more. - [float] [[telemetry-general-settings]] ==== General telemetry settings -`telemetry.sendUsageFrom`:: - Set to `'server'` to report the cluster statistics from the {kib} server. - If the server fails to connect to our endpoint at https://telemetry.elastic.co/, it assumes - it is behind a firewall and falls back to `'browser'` to send it from users' browsers - when they are navigating through {kib}. Defaults to `'server'`. - [[telemetry-optIn]] `telemetry.optIn`:: - Set to `true` to send cluster statistics to Elastic. Reporting your - cluster statistics helps us improve your user experience. Set to `false` to stop sending any telemetry data to Elastic. + + Set to `false` to stop sending any telemetry data to Elastic. Reporting your +cluster statistics helps us improve your user experience. *Default: `true`.* + + This setting can be changed at any time in <>. To prevent users from changing it, -set <> to `false`. Defaults to `true`. +set <> to `false`. `telemetry.allowChangingOptInStatus`:: - Set to `true` to allow overwriting the <> setting via the <> in {kib}. Defaults to `true`. + Set to `false` to disallow overwriting the <> setting via the <> in {kib}. *Default: `true`.* + +`telemetry.sendUsageFrom`:: + Set to `'server'` to report the cluster statistics from the {kib} server. + If the server fails to connect to our endpoint at https://telemetry.elastic.co/, it assumes + it is behind a firewall and falls back to `'browser'` to send it from users' browsers + when they are navigating through {kib}. *Default: `'server'`.* diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 99f336696cc9..57810e95c8dc 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -559,14 +559,13 @@ setting this to `true` enables unauthenticated users to access the {kib} server status API and status page. *Default: `false`* [[telemetry-allowChangingOptInStatus]] `telemetry.allowChangingOptInStatus`:: -When `true`, users are able to change the telemetry setting at a later time in -<>. When `false`, users cannot change the opt-in status through *Advanced Settings*, and +When `false`, users cannot change the opt-in status through <>, and {kib} only looks at the value of <> to determine whether to send telemetry data or not. *Default: `true`*. [[settings-telemetry-optIn]] `telemetry.optIn`:: +Set to `false` to stop sending any telemetry data to Elastic. Reporting your cluster statistics helps us improve your user experience. -Set to `true` to allow telemetry data to be sent to Elastic. When `false`, the telemetry data is never sent to Elastic. + + This setting can be changed at any time in <>.