github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Reformats the telemetry settings tables into defintion lists (#120855) (#121012)

Browse source
This commit is contained in:
gchaps 2021-12-09 13:54:09 -08:00 • committed by GitHub
parent f80f7c6206
commit 083eabf5ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/settings/telemetry-settings.asciidoc
View file

@ -17,29 +17,26 @@ See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to lea
[[telemetry-general-settings]]
==== General telemetry settings
[cols="2*<"]
|===
|[[telemetry-enabled]] `telemetry.enabled`
| Set to `true` to send cluster statistics to Elastic. Reporting your
[[telemetry-enabled]] `telemetry.enabled`::
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.
`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}. Defaults to `'server'`.
|[[telemetry-optIn]] `telemetry.optIn`
| Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through
[[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`.
| `telemetry.allowChangingOptInStatus`
| Set to `true` to allow overwriting the <<telemetry-optIn, `telemetry.optIn`>> setting via the {kib} UI. Defaults to `true`. +
|===
`telemetry.allowChangingOptInStatus`::
Set to `true` to allow overwriting the <<telemetry-optIn, `telemetry.optIn`>> setting via the {kib} UI. Defaults to `true`. +
+
[NOTE]
============
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`>>.