Skip to content

Commit

Permalink
Move telemetry settings into its own document
Browse files Browse the repository at this point in the history
  • Loading branch information
afharo committed Mar 24, 2020
1 parent 9388687 commit daa7f29
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/migration/migrate_8_0.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<telemetry.enabled, `telemetry.enabled`>> instead.
For any configurations beginning with `xpack.telemetry.`, remove the `xpack.` prefix. For example, use <<telemetry-general-settings, `telemetry.enabled`>> instead.

// end::notable-breaking-changes[]
8 changes: 0 additions & 8 deletions docs/settings/monitoring-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
38 changes: 38 additions & 0 deletions docs/settings/telemetry-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[[telemetry-settings-kbn]]
=== Telemetry settings in Kibana
++++
<titleabbrev>Telemetry settings</titleabbrev>
++++

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`.
1 change: 1 addition & 0 deletions docs/setup/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

0 comments on commit daa7f29

Please sign in to comment.