From 499634880b2b7e21e7f19eac71a8e208da67357e Mon Sep 17 00:00:00 2001 From: Court Ewing Date: Tue, 19 Nov 2019 20:15:53 -0500 Subject: [PATCH 01/14] Remove support for deprecated xpack.telemetry configurations In 7.5, we moved telemetry to OSS and dropped the xpack prefix for the telemetry plugin configuration options. We deprecated the usage of the xpack prefix so any existing usage would trigger a warning at startup. In 8.0, we remove support for the deprecated xpack prefix configs for telemetry. --- docs/migration/migrate_8_0.asciidoc | 9 +++++++++ docs/settings/monitoring-settings.asciidoc | 8 ++++++++ src/core/server/config/deprecation/core_deprecations.ts | 7 ------- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/migration/migrate_8_0.asciidoc b/docs/migration/migrate_8_0.asciidoc index ce4c97391f1b5..bc98ad5f9269f 100644 --- a/docs/migration/migrate_8_0.asciidoc +++ b/docs/migration/migrate_8_0.asciidoc @@ -112,4 +112,13 @@ access level. been deprecated with warnings that have been logged throughout 7.x. Please use Kibana UI to re-generate the POST URL snippets if you depend on these for automated PDF reports. +[float] +=== Configurations starting with `xpack.telemetry.` are no longer valid + +*Details:* +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. + // end::notable-breaking-changes[] diff --git a/docs/settings/monitoring-settings.asciidoc b/docs/settings/monitoring-settings.asciidoc index 6645f49029a51..1199ef2d550b5 100644 --- a/docs/settings/monitoring-settings.asciidoc +++ b/docs/settings/monitoring-settings.asciidoc @@ -69,6 +69,14 @@ 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/src/core/server/config/deprecation/core_deprecations.ts b/src/core/server/config/deprecation/core_deprecations.ts index d91e55115d0b1..f0b21adf62ff7 100644 --- a/src/core/server/config/deprecation/core_deprecations.ts +++ b/src/core/server/config/deprecation/core_deprecations.ts @@ -128,13 +128,6 @@ export const coreDeprecationProvider: ConfigDeprecationProvider = ({ renameFromRoot('optimize.lazyHost', 'optimize.watchHost'), renameFromRoot('optimize.lazyPrebuild', 'optimize.watchPrebuild'), renameFromRoot('optimize.lazyProxyTimeout', 'optimize.watchProxyTimeout'), - renameFromRoot('xpack.xpack_main.telemetry.config', 'telemetry.config'), - renameFromRoot('xpack.xpack_main.telemetry.url', 'telemetry.url'), - renameFromRoot('xpack.xpack_main.telemetry.enabled', 'telemetry.enabled'), - renameFromRoot('xpack.telemetry.enabled', 'telemetry.enabled'), - renameFromRoot('xpack.telemetry.config', 'telemetry.config'), - renameFromRoot('xpack.telemetry.banner', 'telemetry.banner'), - renameFromRoot('xpack.telemetry.url', 'telemetry.url'), // Monitoring renames // TODO: Remove these from here once the monitoring plugin is migrated to NP renameFromRoot('xpack.monitoring.enabled', 'monitoring.enabled'), From daa7f29f20fc4d238741221742aea236e097b2e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Ferna=CC=81ndez=20Haro?= Date: Tue, 24 Mar 2020 18:36:19 +0000 Subject: [PATCH 02/14] Move telemetry settings into its own document --- docs/migration/migrate_8_0.asciidoc | 2 +- docs/settings/monitoring-settings.asciidoc | 8 ----- docs/settings/telemetry-settings.asciidoc | 38 ++++++++++++++++++++++ docs/setup/settings.asciidoc | 1 + 4 files changed, 40 insertions(+), 9 deletions(-) create mode 100644 docs/settings/telemetry-settings.asciidoc diff --git a/docs/migration/migrate_8_0.asciidoc b/docs/migration/migrate_8_0.asciidoc index bc98ad5f9269f..14586f6875226 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 1199ef2d550b5..6645f49029a51 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 0000000000000..24bb35371879b --- /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 a72c15190840a..e3cc048db1a13 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[] From 56541ef4e2d93c19430518c2f424134fe1f08b1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Ferna=CC=81ndez=20Haro?= Date: Tue, 24 Mar 2020 18:40:04 +0000 Subject: [PATCH 03/14] Use external reference instead of anchor --- docs/migration/migrate_8_0.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/migration/migrate_8_0.asciidoc b/docs/migration/migrate_8_0.asciidoc index 14586f6875226..6443bb82ec6fb 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 {kibana-ref}/telemetry-settings-kbn.html#telemetry-general-settings[`telemetry.enabled`] instead. // end::notable-breaking-changes[] From af271cf55a3445be584d4a7a9b533e159dee9067 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:57:34 +0100 Subject: [PATCH 04/14] Update docs/migration/migrate_8_0.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/migration/migrate_8_0.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/migration/migrate_8_0.asciidoc b/docs/migration/migrate_8_0.asciidoc index e04eaf845f208..3ead789600a28 100644 --- a/docs/migration/migrate_8_0.asciidoc +++ b/docs/migration/migrate_8_0.asciidoc @@ -142,7 +142,7 @@ been deprecated with warnings that have been logged throughout 7.x. Please use K POST URL snippets if you depend on these for automated PDF reports. [float] -=== Configurations starting with `xpack.telemetry.` are no longer valid +=== Configurations starting with `xpack.telemetry` are no longer valid *Details:* The `xpack.` prefix has been removed for all telemetry configurations. From 5c9a2d46b1fab66b5a716bf6738ec7a1853767fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:57:53 +0100 Subject: [PATCH 05/14] Update docs/migration/migrate_8_0.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/migration/migrate_8_0.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/migration/migrate_8_0.asciidoc b/docs/migration/migrate_8_0.asciidoc index 3ead789600a28..f3e30eb7e7d77 100644 --- a/docs/migration/migrate_8_0.asciidoc +++ b/docs/migration/migrate_8_0.asciidoc @@ -148,6 +148,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 {kibana-ref}/telemetry-settings-kbn.html#telemetry-general-settings[`telemetry.enabled`] instead. +For any configurations beginning with `xpack.telemetry`, remove the `xpack` prefix. Use {kibana-ref}/telemetry-settings-kbn.html#telemetry-general-settings[`telemetry.enabled`] instead. // end::notable-breaking-changes[] From db1cff588973f877ad537a6a3b0d132a355a7fe8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:58:04 +0100 Subject: [PATCH 06/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index 24bb35371879b..c2cf1529d9a46 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -4,7 +4,7 @@ Telemetry settings ++++ -By default, the Usage Collection (also known as Telemetry) is enabled. This +By default, 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. From bb929c63fa957e9051df1cc1355661c14c59a4d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:58:23 +0100 Subject: [PATCH 07/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index c2cf1529d9a46..b88fdc02a0664 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -5,7 +5,7 @@ ++++ By default, 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 +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. You can control whether this data is sent from the {kib} servers or, if it should be sent From 5c7cbc1485457b81d08d26f846ea04321acedacd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:58:35 +0100 Subject: [PATCH 08/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index b88fdc02a0664..920ca78a27b67 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -8,7 +8,7 @@ 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. -You can control whether this data is sent from the {kib} servers or, if it should be sent +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. From 11d03268ded70aaef5c71d8963fa90b34d2b72ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:59:02 +0100 Subject: [PATCH 09/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index 920ca78a27b67..b87bf045854c4 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -9,7 +9,7 @@ helps us learn about the {kib} features that our users are most interested in, s 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). +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. From 297e3d7a16b7b42e7b0da6fbad8a68f6066f6a70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:59:11 +0100 Subject: [PATCH 10/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index b87bf045854c4..a0748698f2b63 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -26,7 +26,7 @@ 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 +it is behind a firewall and falls back to `'browser'` to send it from users' browsers when they are navigating through {kib}. `telemetry.optIn`:: *Default: true*. From bebe7833e57aef7cd2e10b4dbb1b12b8c86d25a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:59:30 +0100 Subject: [PATCH 11/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index a0748698f2b63..ad4203aaa3aed 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -30,7 +30,7 @@ it is behind a firewall and falls back to `'browser'` to send it from users' bro 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 +Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through *Advanced Settings* in {kib}. `telemetry.allowChangingOptInStatus`:: *Default: true*. From ef20e9a310fe11416dacb8da0e4ff4559ef91d3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 18:59:57 +0100 Subject: [PATCH 12/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index ad4203aaa3aed..a8a0fb392a2e8 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -35,4 +35,4 @@ Set to `true` to automatically opt into reporting cluster statistics. You can al `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`. +Note: When `false`, `telemetry.optIn` must be `true`. To disable telemetry and not allow users to change that parameter, use `telemetry.enabled`. From bd7161aebd61be775fdbe43a0bc6b7755b392e93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Fern=C3=A1ndez=20Haro?= Date: Wed, 1 Apr 2020 19:00:17 +0100 Subject: [PATCH 13/14] Update docs/settings/telemetry-settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/settings/telemetry-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc index a8a0fb392a2e8..ad5f53ad879f8 100644 --- a/docs/settings/telemetry-settings.asciidoc +++ b/docs/settings/telemetry-settings.asciidoc @@ -34,5 +34,5 @@ Set to `true` to automatically opt into reporting cluster statistics. You can al *Advanced Settings* in {kib}. `telemetry.allowChangingOptInStatus`:: *Default: true*. -Set to `true` to allow overwriting the `telemetry.optIn` flag via the {kib} UI. +Set to `true` to allow overwriting the `telemetry.optIn` setting via the {kib} UI. Note: When `false`, `telemetry.optIn` must be `true`. To disable telemetry and not allow users to change that parameter, use `telemetry.enabled`. From 4c47e206dcea1ee2e751ad7f79a4010276624cae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Ferna=CC=81ndez=20Haro?= Date: Thu, 2 Apr 2020 13:04:26 +0100 Subject: [PATCH 14/14] Remove depecrated xpack.telemetry.* config from xpack_main/index.js --- x-pack/legacy/plugins/xpack_main/index.js | 5 ----- 1 file changed, 5 deletions(-) diff --git a/x-pack/legacy/plugins/xpack_main/index.js b/x-pack/legacy/plugins/xpack_main/index.js index 4cf32b971b57e..6ce457ffbec05 100644 --- a/x-pack/legacy/plugins/xpack_main/index.js +++ b/x-pack/legacy/plugins/xpack_main/index.js @@ -23,11 +23,6 @@ export const xpackMain = kibana => { config(Joi) { return Joi.object({ enabled: Joi.boolean().default(true), - telemetry: Joi.object({ - config: Joi.string().default(), - enabled: Joi.boolean().default(), - url: Joi.string().default(), - }).default(), // deprecated }).default(); },