kibana/docs/settings/telemetry-settings.asciidoc
florent-leborgne ae701c969e
[Docs] Add missing telemetry setting (#206403)
This PR is a re-do of @charlesbp87's
https://github.com/elastic/kibana/pull/202458 so that the change can be
propagated to all required versions.

@charlesbp87 thanks for raising this. Let me know if we should propagate
the change to more versions.

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
2025-01-15 16:52:16 +01:00

36 lines
No EOL
1.9 KiB
Text

[[telemetry-settings-kbn]]
=== Telemetry settings in {kib}
++++
<titleabbrev>Telemetry settings</titleabbrev>
++++
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 disable this feature either in *Stack Management > {kib} > Advanced Settings > Global Settings > Usage collection* or the config file with the following settings.
[float]
[[telemetry-general-settings]]
==== General telemetry 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. *Default: `true`.* +
+
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`.
`telemetry.allowChangingOptInStatus`::
Set to `false` to disallow overwriting the <<telemetry-optIn, `telemetry.optIn`>> setting via the <<advanced-options, Advanced Settings>> 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'`.*
`xpack.apm.telemetryCollectionEnabled`::
Collects information about APM data and API performance. Set this to `false` to specifically disable APM's collector. *Default: `'true'`.*