2020-04-02 16:27:57 +02:00
[[telemetry-settings-kbn]]
2020-06-08 23:46:26 +02:00
=== Telemetry settings in {kib}
2020-04-02 16:27:57 +02:00
++++
<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.
2020-05-04 17:22:40 +02:00
You can control whether this data is sent from the {kib} servers, or if it should be sent
2020-04-02 16:27:57 +02:00
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
2020-05-04 17:22:40 +02:00
[cols="2*<"]
|===
2020-09-23 17:01:05 +02:00
|[[telemetry-enabled]] `telemetry.enabled`
2020-05-04 17:22:40 +02:00
| Set to `true` to send cluster statistics to Elastic. Reporting your
cluster statistics helps us improve your user experience. Your data is never
shared with anyone. Set to `false` to disable statistics reporting from any
browser connected to the {kib} instance. Defaults to `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
2020-06-09 16:56:54 +02:00
when they are navigating through {kib}. Defaults to `'server'`.
2020-05-04 17:22:40 +02:00
2020-09-23 17:01:05 +02:00
|[[telemetry-optIn]] `telemetry.optIn`
2020-05-04 17:22:40 +02:00
| Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through
*Advanced Settings* in {kib}. Defaults to `true`.
| `telemetry.allowChangingOptInStatus`
2020-09-23 17:01:05 +02:00
| Set to `true` to allow overwriting the <<telemetry-optIn, `telemetry.optIn`>> setting via the {kib} UI. Defaults to `true`. +
2020-05-04 17:22:40 +02:00
|===
[NOTE]
============
2020-09-23 17:01:05 +02:00
When `false`, <<telemetry-optIn, `telemetry.optIn`>> must be `true`. To disable telemetry and not allow users to change that parameter, use <<telemetry-enabled, `telemetry.enabled`>>.
2020-05-04 17:22:40 +02:00
============