Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.3] [DOCS] Telemetry settings: improve phrasing (#158396) #158472

Merged
merged 2 commits into from
May 25, 2023
Merged

[8.3] [DOCS] Telemetry settings: improve phrasing (#158396) #158472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7773c30
[DOCS] Telemetry settings: improve phrasing (#158396)
afharo May 25, 2023
ef5f2b9
Update docs/setup/settings.asciidoc
afharo May 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/settings/telemetry-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@
<titleabbrev>Telemetry settings</titleabbrev>
++++

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
Expand All @@ -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 <<telemetry-optIn, `telemetry.optIn`>> setting via the {kib} UI. Defaults to `true`. +
Set to `false` to disallow overwriting the <<telemetry-optIn, `telemetry.optIn`>> setting via the <<advanced-options, Advanced Settings>> in {kib}. *Default: `true`.* +
+
[NOTE]
============
Expand Down
18 changes: 10 additions & 8 deletions docs/setup/settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,17 +532,19 @@ 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
<<advanced-options, Advanced Settings>>. When `false`,
{kib} looks at the value of <<settings-telemetry-optIn, `telemetry.optIn`>> to determine whether to send
telemetry data or not. <<telemetry-allowChangingOptInStatus, `telemetry.allowChangingOptInStatus`>> and <<settings-telemetry-optIn, `telemetry.optIn`>>
When `false`, users cannot change the opt-in status through <<advanced-options, Advanced Settings>>, and
{kib} only looks at the value of <<settings-telemetry-optIn, `telemetry.optIn`>> to determine whether to send telemetry data or not. <<telemetry-allowChangingOptInStatus, `telemetry.allowChangingOptInStatus`>> and <<settings-telemetry-optIn, `telemetry.optIn`>>
cannot be `false` at the same time. *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 <<telemetry-allowChangingOptInStatus, `telemetry.allowChangingOptInStatus`>> to `false` and <<settings-telemetry-optIn, `telemetry.optIn`>> 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 <<advanced-options, Advanced Settings>>.
To prevent users from changing it,
set <<telemetry-allowChangingOptInStatus, `telemetry.allowChangingOptInStatus`>> to `false`.
*Default: `true`*

`telemetry.enabled`::
Expand Down