Skip to content

Commit

Permalink
Clarify documentation for the `observability:enableComparisonByDefaul…
Browse files Browse the repository at this point in the history
…t` setting (elastic#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 5c0f034)
  • Loading branch information
felixbarny committed Jul 7, 2023
1 parent 0f9d862 commit e8c8199
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/management/advanced-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] for more details.
3 changes: 2 additions & 1 deletion x-pack/plugins/observability/server/ui_settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
},
Expand Down

0 comments on commit e8c8199

Please sign in to comment.