From 7773c30e364ec4fc445bf6147c5b6099a462c215 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Thu, 25 May 2023 16:46:08 +0200 Subject: [PATCH 1/2] [DOCS] Telemetry settings: improve phrasing (#158396) (cherry picked from commit 995b0a46e9da573d14bf0e5af27b4b028bd5293d) # Conflicts: # docs/settings/telemetry-settings.asciidoc # docs/setup/settings.asciidoc --- docs/settings/telemetry-settings.asciidoc | 14 ++++++-------- docs/setup/settings.asciidoc | 19 ++++++++++--------- 2 files changed, 16 insertions(+), 17 deletions(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index 058c34c5b02a3..ae0e582a977a6 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -4,15 +4,13 @@ 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 @@ -30,11 +28,11 @@ See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to lea when they are navigating through {kib}. Defaults to `'server'`. [[telemetry-optIn]] `telemetry.optIn`:: - Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through - *Advanced Settings* in {kib}. Defaults to `true`. + Set to `false` to stop sending any telemetry data to Elastic. Reporting your +cluster statistics helps us improve your user experience. *Default: `true`.* `telemetry.allowChangingOptInStatus`:: - Set to `true` to allow overwriting the <> setting via the {kib} UI. Defaults to `true`. + + Set to `false` to disallow overwriting the <> setting via the <> in {kib}. *Default: `true`.* + + [NOTE] ============ diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 0c3da7d32ca77..86d6228c7a49a 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -532,17 +532,18 @@ 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`, -{kib} looks at the value of <> to determine whether to send -telemetry data or not. <> and <> -cannot be `false` at the same time. *Default: `true`*. +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`:: -When `true`, telemetry data is sent to Elastic. -When `false`, collection of telemetry data is disabled. -To enable telemetry and prevent users from disabling it, -set <> to `false` and <> to `true`. +Set to `false` to stop sending any telemetry data to Elastic. +Reporting your cluster statistics helps +us improve your user experience. +When `false`, the telemetry data is never sent to Elastic. + ++ +This setting can be changed at any time in <>. +To prevent users from changing it, +set <> to `false`. *Default: `true`* `telemetry.enabled`:: From ef5f2b9aa872e328e2de0f0c104057ebe309758d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Thu, 25 May 2023 17:44:41 +0200 Subject: [PATCH 2/2] Update docs/setup/settings.asciidoc --- docs/setup/settings.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 86d6228c7a49a..f4cdfbc0b8e4b 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -533,7 +533,8 @@ server status API and status page. *Default: `false`* [[telemetry-allowChangingOptInStatus]] `telemetry.allowChangingOptInStatus`:: 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`*. +{kib} only looks at the value of <> to determine whether to send telemetry data or not. <> and <> +cannot be `false` at the same time. *Default: `true`*. [[settings-telemetry-optIn]] `telemetry.optIn`:: Set to `false` to stop sending any telemetry data to Elastic.