diff --git a/docs/migration/migrate_8_0.asciidoc b/docs/migration/migrate_8_0.asciidoc index bc98ad5f9269..14586f687522 100644 --- a/docs/migration/migrate_8_0.asciidoc +++ b/docs/migration/migrate_8_0.asciidoc @@ -119,6 +119,6 @@ POST URL snippets if you depend on these for automated PDF reports. The `xpack.` prefix has been removed for all telemetry configurations. *Impact:* -For any configurations beginning with `xpack.telemetry.`, remove the `xpack.` prefix. For example, use <> instead. +For any configurations beginning with `xpack.telemetry.`, remove the `xpack.` prefix. For example, use <> instead. // end::notable-breaking-changes[] diff --git a/docs/settings/monitoring-settings.asciidoc b/docs/settings/monitoring-settings.asciidoc index 1199ef2d550b..6645f49029a5 100644 --- a/docs/settings/monitoring-settings.asciidoc +++ b/docs/settings/monitoring-settings.asciidoc @@ -69,14 +69,6 @@ Specifies the time in milliseconds to wait for {es} to respond to internal health checks. By default, it matches the `elasticsearch.pingTimeout` setting, which has a default value of `30000`. -[[telemetry.enabled]] -`telemetry.enabled`:: -Set to `true` (default) 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. You can also opt out through the -*Advanced Settings* in {kib}. - [float] [[monitoring-collection-settings]] ==== Monitoring collection settings diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc new file mode 100644 index 000000000000..24bb35371879 --- /dev/null +++ b/docs/settings/telemetry-settings.asciidoc @@ -0,0 +1,38 @@ +[[telemetry-settings-kbn]] +=== Telemetry settings in Kibana +++++ +Telemetry settings +++++ + +By default, the Usage Collection (also known as Telemetry) is enabled. This +help us to learn about the {kib} features our users are more interested in, so we +can focus our efforts on making them even better. + +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 there is a firewall blocking those connections from the server. Additionally, you can decide to completely disable this feature either in the config file or the {kib} UI (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.enabled`:: *Default: true*. +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. + +`telemetry.sendUsageFrom`:: *Default: 'browser'*. +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 the users' browsers +when they are navigating through {kib}. + +`telemetry.optIn`:: *Default: true*. +Set to `true` to auto opt-in the cluster into reporting statistics. You can also opt out through the +*Advanced Settings* in {kib}. + +`telemetry.allowChangingOptInStatus`:: *Default: true*. +Set to `true` to allow overwriting the `telemetry.optIn` flag via the {kib} UI. +N.B.: When `false`, `telemetry.optIn` must be `true`. If you want to disable the telemetry and do not give any of the users the chance to change that parameter, use `telemetry.enabled`. diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index a72c15190840..e3cc048db1a1 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -465,3 +465,4 @@ include::{docdir}/settings/reporting-settings.asciidoc[] include::secure-settings.asciidoc[] include::{docdir}/settings/security-settings.asciidoc[] include::{docdir}/settings/spaces-settings.asciidoc[] +include::{docdir}/settings/telemetry-settings.asciidoc[]