From e8c8199f0ad5df441ce25be8066b6e9582c35f18 Mon Sep 17 00:00:00 2001 From: Felix Barnsteiner Date: Fri, 7 Jul 2023 09:52:47 +0200 Subject: [PATCH] Clarify documentation for the `observability:enableComparisonByDefault` setting (#161372) The previous description > Enables the comparison feature in the APM app. makes it sound like the entire feature would be disabled when setting the option to false. (cherry picked from commit 5c0f034e7517898f25f664ebc9d7c31f5b3d33ad) --- docs/management/advanced-options.asciidoc | 4 ++-- x-pack/plugins/observability/server/ui_settings.ts | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index b500557889614..3b3f260f0de97 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -408,7 +408,7 @@ preview:[] Sorts services without anomaly detection rules on the APM Service inv preview:[] Display Amazon Lambda metrics in the service metrics tab. [[observability-apm-enable-comparison]]`observability:enableComparisonByDefault`:: -Enables the comparison feature in the APM app. +Determines whether the <> is enabled or disabled by default in the APM app. [[observability-apm-enable-infra-view]]`observability:enableInfrastructureView`:: Enables the Infrastructure view in the APM app. @@ -597,4 +597,4 @@ The URL of a custom PNG image that appears on {kib} browser tabs. [[provide-usage-data]]`telemetry:enabled`:: Enabling data usage collection (also known as Telemetry) 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] for more details. \ No newline at end of file +Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] for more details. diff --git a/x-pack/plugins/observability/server/ui_settings.ts b/x-pack/plugins/observability/server/ui_settings.ts index ab663df47488b..6a42dcc860c53 100644 --- a/x-pack/plugins/observability/server/ui_settings.ts +++ b/x-pack/plugins/observability/server/ui_settings.ts @@ -76,7 +76,8 @@ export const uiSettings: Record = { }), value: true, description: i18n.translate('xpack.observability.enableComparisonByDefaultDescription', { - defaultMessage: 'Enable the comparison feature in APM app', + defaultMessage: + 'Determines whether the comparison feature is enabled or disabled by default in the APM app.', }), schema: schema.boolean(), },