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.
This commit is contained in:
Felix Barnsteiner 2023-07-07 09:52:47 +02:00 committed by GitHub
parent e9e5c3cdcd
commit 5c0f034e75
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 3 deletions

View file

@ -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 <<service-time-comparison, comparison feature>> 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.
@ -598,4 +598,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.
Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] for more details.

View file

@ -76,7 +76,8 @@ export const uiSettings: Record<string, UiSettings> = {
}),
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(),
},