Skip to content

Commit

Permalink
[8.4] [DOCS] Telemetry settings: improve phrasing (#158396) (#158471)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.4`:
- [[DOCS] Telemetry settings: improve phrasing
(#158396)](#158396)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Alejandro Fernández
Haro","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-05-25T14:46:08Z","message":"[DOCS]
Telemetry settings: improve phrasing
(#158396)","sha":"995b0a46e9da573d14bf0e5af27b4b028bd5293d","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Team:Core","v8.0.0","release_note:skip","docs","v8.1.0","v7.17.0","v8.2.0","v8.3.0","v8.4.0","v8.5.0","v8.6.0","v8.7.0","v8.8.0","v8.9.0"],"number":158396,"url":"https://github.com/elastic/kibana/pull/158396","mergeCommit":{"message":"[DOCS]
Telemetry settings: improve phrasing
(#158396)","sha":"995b0a46e9da573d14bf0e5af27b4b028bd5293d"}},"sourceBranch":"main","suggestedTargetBranches":["8.0","8.1","7.17","8.2","8.3","8.4","8.5","8.6","8.7"],"targetPullRequestStates":[{"branch":"8.0","label":"v8.0.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.1","label":"v8.1.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.17","label":"v7.17.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.2","label":"v8.2.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.3","label":"v8.3.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.4","label":"v8.4.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.5","label":"v8.5.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.6","label":"v8.6.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/158462","number":158462,"state":"MERGED","mergeCommit":{"sha":"fe1289cc9c918bea2b690383d7bff4666ad947a3","message":"[8.8]
[DOCS] Telemetry settings: improve phrasing (#158396) (#158462)\n\n#
Backport\n\nThis will backport the following commits from `main` to
`8.8`:\n- [[DOCS] Telemetry settings: improve
phrasing\n(#158396)](https://github.com/elastic/kibana/pull/158396)\n\n<!---
Backport version: 8.9.7 -->\n\n### Questions ?\nPlease refer to the
[Backport
tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT
[{\"author\":{\"name\":\"Alejandro
Fernández\nHaro\",\"email\":\"[email protected]\"},\"sourceCommit\":{\"committedDate\":\"2023-05-25T14:46:08Z\",\"message\":\"[DOCS]\nTelemetry
settings: improve
phrasing\n(#158396)\",\"sha\":\"995b0a46e9da573d14bf0e5af27b4b028bd5293d\",\"branchLabelMapping\":{\"^v8.9.0$\":\"main\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"Team:Docs\",\"Team:Core\",\"v8.0.0\",\"release_note:skip\",\"docs\",\"v8.1.0\",\"v7.17.0\",\"v8.2.0\",\"v8.3.0\",\"v8.4.0\",\"v8.5.0\",\"v8.6.0\",\"v8.7.0\",\"v8.8.0\",\"v8.9.0\"],\"number\":158396,\"url\":\"https://github.com/elastic/kibana/pull/158396\",\"mergeCommit\":{\"message\":\"[DOCS]\nTelemetry
settings: improve
phrasing\n(#158396)\",\"sha\":\"995b0a46e9da573d14bf0e5af27b4b028bd5293d\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"8.0\",\"8.1\",\"7.17\",\"8.2\",\"8.3\",\"8.4\",\"8.5\",\"8.6\",\"8.7\",\"8.8\"],\"targetPullRequestStates\":[{\"branch\":\"8.0\",\"label\":\"v8.0.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.1\",\"label\":\"v8.1.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"7.17\",\"label\":\"v7.17.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.2\",\"label\":\"v8.2.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.3\",\"label\":\"v8.3.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.4\",\"label\":\"v8.4.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.5\",\"label\":\"v8.5.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.6\",\"label\":\"v8.6.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.7\",\"label\":\"v8.7.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"8.8\",\"label\":\"v8.8.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"main\",\"label\":\"v8.9.0\",\"labelRegex\":\"^v8.9.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/158396\",\"number\":158396,\"mergeCommit\":{\"message\":\"[DOCS]\nTelemetry
settings: improve
phrasing\n(#158396)\",\"sha\":\"995b0a46e9da573d14bf0e5af27b4b028bd5293d\"}}]}]\nBACKPORT-->\n\nCo-authored-by:
Alejandro Fernández Haro
<[email protected]>"}},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/158396","number":158396,"mergeCommit":{"message":"[DOCS]
Telemetry settings: improve phrasing
(#158396)","sha":"995b0a46e9da573d14bf0e5af27b4b028bd5293d"}}]}]
BACKPORT-->
  • Loading branch information
afharo authored May 25, 2023
1 parent 976806e commit 1f08cec
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 18 deletions.
28 changes: 13 additions & 15 deletions docs/settings/telemetry-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,30 @@
<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.
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 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

`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 send cluster statistics to Elastic. Reporting your
cluster statistics helps us improve your user experience. Set to `false` to stop sending any telemetry data to Elastic. +
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`. Defaults to `true`.
set <<telemetry-allowChangingOptInStatus, `telemetry.allowChangingOptInStatus`>> to `false`.

`telemetry.allowChangingOptInStatus`::
Set to `true` to allow overwriting the <<telemetry-optIn, `telemetry.optIn`>> setting via the <<advanced-options, Advanced Settings>> in {kib}. Defaults to `true`.
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'`.*
5 changes: 2 additions & 3 deletions docs/setup/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -537,14 +537,13 @@ setting this to `true` enables unauthenticated users to access the {kib}
server status API and status page. *Default: `false`*

[[telemetry-allowChangingOptInStatus]] `telemetry.allowChangingOptInStatus`::
When `true`, users are able to change the telemetry setting at a later time in
<<advanced-options, Advanced Settings>>. When `false`, users cannot change the opt-in status through *Advanced Settings*, and
When `false`, users cannot change the opt-in status through <<advanced-options, Advanced Settings>>, and
{kib} only looks at the value of <<settings-telemetry-optIn, `telemetry.optIn`>> to determine whether to send telemetry data or not. *Default: `true`*.

[[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.
Set to `true` to allow telemetry data to be sent to Elastic.
When `false`, the telemetry data is never sent to Elastic. +
+
This setting can be changed at any time in <<advanced-options, Advanced Settings>>.
Expand Down

0 comments on commit 1f08cec

Please sign in to comment.