From 3ced121be0caeb672a4b12c9db595fdde401d80f Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Fri, 7 Jul 2023 07:41:46 -0700 Subject: [PATCH] [APM] UX text review (#161400) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Summary @gchaps and I met to review text on some APM UI pages. Outcomes: 1. Service **m**ap or Service **M**ap — there is inconsistency in the APM UI with how we refer to Service maps. In some cases, we use title case (Service Map). In others, we use sentence case (Service map). As per the [EUI writing guidelines](https://eui.elastic.co/#/guidelines/writing/guidelines#capitalization), we should use title case for product features. 2. Storage **e**xplorer or Storage **E**xplorer — same story here. We use title case sometimes and sentence case others. We should use title case as this is a product feature. 3. Various text enhancements and changes. --- docs/CHANGELOG.asciidoc | 154 +++++++++--------- docs/apm/apm-app-users.asciidoc | 6 +- docs/apm/machine-learning.asciidoc | 2 +- docs/apm/service-maps.asciidoc | 6 +- docs/apm/storage-explorer.asciidoc | 8 +- docs/apm/traces.asciidoc | 2 +- docs/apm/troubleshooting.asciidoc | 2 +- .../storage_explorer/storage_explorer.cy.ts | 2 +- .../app/correlations/chart_title_tool_tip.tsx | 2 +- .../app/correlations/empty_state_prompt.tsx | 4 +- .../service_inventory/service_list/index.tsx | 2 +- .../app/service_map/disabled_prompt.tsx | 2 +- .../app/service_map/timeout_prompt.tsx | 2 +- .../storage_explorer/services_table/index.tsx | 2 +- .../index_stats_per_service.tsx | 2 +- .../routing/home/storage_explorer.tsx | 4 +- .../analyze_data_button.tsx | 2 +- .../templates/service_group_template.tsx | 2 +- .../transaction_breakdown_chart/index.tsx | 2 +- .../components/shared/kuery_bar/index.tsx | 4 +- .../components/shared/slo_callout/index.tsx | 2 +- .../transaction_action_menu/sections.test.ts | 6 +- .../transaction_action_menu/sections.ts | 2 +- .../common/header/action_menu_content.tsx | 2 +- .../common/header/action_menu_content.tsx | 2 +- .../app/rum_dashboard/action_menu/index.tsx | 2 +- .../tests/error_rate/service_maps.spec.ts | 2 +- .../tests/latency/service_maps.spec.ts | 2 +- .../tests/service_maps/service_maps.spec.ts | 4 +- .../service_maps_kuery_filter.spec.ts | 2 +- .../storage_explorer/storage_explorer.spec.ts | 4 +- .../storage_explorer_privileges.spec.ts | 2 +- .../storage_explorer_summary_stats.spec.ts | 4 +- .../storage_explorer_timeseries_chart.spec.ts | 4 +- .../tests/throughput/service_maps.spec.ts | 2 +- .../failed_transaction_correlations.ts | 2 +- .../apm/correlations/latency_correlations.ts | 2 +- 37 files changed, 129 insertions(+), 129 deletions(-) diff --git a/docs/CHANGELOG.asciidoc b/docs/CHANGELOG.asciidoc index 5d915c8feb6a6..52674816fbcaa 100644 --- a/docs/CHANGELOG.asciidoc +++ b/docs/CHANGELOG.asciidoc @@ -317,7 +317,7 @@ The project monitor API for Synthetics in Elastic Observability has been removed *Impact* + In 8.8.0 and later, an error appears when you use the project monitor API. ==== - + [discrete] [[breaking-147985]] .Changes the privileges for alerts and cases @@ -327,7 +327,7 @@ In 8.8.0 and later, an error appears when you use the project monitor API. The privileges for attaching alerts to cases has changed. For more information, refer to {kibana-pull}147985[#147985]. *Impact* + -To attach alerts to cases, you must have `Read` access to an {observability} or Security feature that has alerts and `All` access to the **Cases** feature. For detailed information, check link:https://www.elastic.co/guide/en/kibana/current/kibana-privileges.html[{kib} privileges] and link:https://www.elastic.co/guide/en/kibana/current/setup-cases.html[Configure access to cases]. +To attach alerts to cases, you must have `Read` access to an {observability} or Security feature that has alerts and `All` access to the **Cases** feature. For detailed information, check link:https://www.elastic.co/guide/en/kibana/current/kibana-privileges.html[{kib} privileges] and link:https://www.elastic.co/guide/en/kibana/current/setup-cases.html[Configure access to cases]. ==== // end::notable-breaking-changes[] @@ -342,7 +342,7 @@ To review the breaking changes in previous versions, refer to the following: The following functionality is deprecated in 8.8.0, and will be removed in 9.0.0. Deprecated functionality does not have an immediate impact on your application, but we strongly recommend you make the necessary updates after you upgrade to 8.8.0. - + [discrete] [[deprecation-154275]] .Deprecates ephemeral Task Manager settings @@ -360,7 +360,7 @@ For more information, refer to {kibana-pull}154275[#154275]. *Impact* + To improve task execution resiliency, remove the deprecated settings from the `kibana.yml` file. For detailed information, check link:https://www.elastic.co/guide/en/kibana/current/task-manager-settings-kb.html[Task Manager settings in {kib}]. ==== - + [discrete] [[deprecation-154010]] .Deprecates monitor schedules @@ -372,7 +372,7 @@ Synthetics and Uptime monitor schedules and zip URL fields are deprecated. For m *Impact* + When you create monitors in Uptime Monitor Management and the Synthetics app, unsupported schedules are automatically transfered to the nearest supported schedule. To use zip URLs, use project monitors. ==== - + [discrete] [[deprecation-152236]] .Deprecates Agent reassign API PUT endpoint @@ -384,7 +384,7 @@ The PUT endpoint for the agent reassign API is deprecated. For more information, *Impact* + Use the POST endpoint for the agent reassign API. ==== - + [discrete] [[deprecation-151564]] .Deprecates `total` in `/agent_status` Fleet API @@ -399,7 +399,7 @@ The `/agent_status` Fleet API now returns the following statuses: * `all` — All active and inactive * `active` — All active ==== - + [discrete] [[deprecation-149506]] .Deprecates Elastic Synthetics integration @@ -409,9 +409,9 @@ The `/agent_status` Fleet API now returns the following statuses: The Elastic Synthetics integration is deprecated. For more information, refer to {kibana-pull}149506[#149506]. *Impact* + -To monitor endpoints, pages, and user journeys, go to **{observability}** -> **Synthetics (beta)**. +To monitor endpoints, pages, and user journeys, go to **{observability}** -> **Synthetics (beta)**. ==== - + [float] [[features-8.8.0]] === Features @@ -833,7 +833,7 @@ Before you upgrade to 8.7.0, review the breaking changes, then mitigate the impa `lens:useFieldExistenceSampling` has been removed from *Advanced Settings*. The setting allowed you to enable document sampling to determine the fields that are displayed in *Lens*. For more information, refer to {kibana-pull}149482[#149482]. *Impact* + -In 8.1.0 and later, {kib} uses the field caps API, by default, to determine the fields that are displayed in *Lens*. +In 8.1.0 and later, {kib} uses the field caps API, by default, to determine the fields that are displayed in *Lens*. ==== [discrete] @@ -847,7 +847,7 @@ In 8.1.0 and later, {kib} uses the field caps API, by default, to determine the *Impact* + In 7.14.0 and later, the new aggregation-based pie chart visualization is available by default. For more information, check link:https://www.elastic.co/guide/en/kibana/current/add-aggregation-based-visualization-panels.html[Aggregation-based]. ==== - + [discrete] [[breaking-147616]] .Removes the current_upgrades endpoint @@ -859,7 +859,7 @@ The `api/fleet/current_upgrades` endpoint has been removed. For more information *Impact* + When you upgrade to 8.7.0, use the `/action_status` endpoint. ==== - + [discrete] [[breaking-147199]] .Removes the preconfiguration API route @@ -1776,9 +1776,9 @@ Before you upgrade to 8.5.0, review the breaking changes, then mitigate the impa To make bulk action responses consistent, returns `actionId` instead of agent ids with `success: True` or `success: False` results. For more information, refer to {kibana-pull}141757[#141757]. *Impact* + -When you use `FleetBulkResponse`, you now receive only `actionId` responses. +When you use `FleetBulkResponse`, you now receive only `actionId` responses. ==== - + [discrete] [[breaking-139431]] .Removes filter validation for ad-hoc data views @@ -1790,7 +1790,7 @@ Filters associated with unknown data views, such as deleted data views, are no l *Impact* + Filters associated with unknown data views now display a warning message instead of being automatically disabled. ==== - + [discrete] [[breaking-138677]] .Removes the `package_policies` field from the agent policy saved object @@ -1806,7 +1806,7 @@ The agent policy saved object no longer includes the `package_policies` field. To review the breaking changes in previous versions, refer to the following: {kibana-ref-all}/8.4/release-notes-8.4.0.html#breaking-changes-8.4.0[8.4.0] | {kibana-ref-all}/8.3/release-notes-8.3.0.html#breaking-changes-8.3.0[8.3.0] | {kibana-ref-all}/8.2/release-notes-8.2.0.html#breaking-changes-8.2.0[8.2.0] | {kibana-ref-all}/8.1/release-notes-8.1.0.html#breaking-changes-8.1.0[8.1.0] | {kibana-ref-all}/8.0/release-notes-8.0.0.html#breaking-changes-8.0.0[8.0.0] | {kibana-ref-all}/8.0/release-notes-8.0.0-rc2.html#breaking-changes-8.0.0-rc2[8.0.0-rc2] | {kibana-ref-all}/8.0/release-notes-8.0.0-rc1.html#breaking-changes-8.0.0-rc1[8.0.0-rc1] | {kibana-ref-all}/8.0/release-notes-8.0.0-beta1.html#breaking-changes-8.0.0-beta1[8.0.0-beta1] | {kibana-ref-all}/8.0/release-notes-8.0.0-alpha2.html#breaking-changes-8.0.0-alpha2[8.0.0-alpha2] | {kibana-ref-all}/8.0/release-notes-8.0.0-alpha1.html#breaking-changes-8.0.0-alpha1[8.0.0-alpha1] - + [float] [[features-8.5.0]] === Features @@ -2271,21 +2271,21 @@ Before you upgrade to 8.4.0, review the breaking changes, then mitigate the impa [%collapsible] ==== *Details* + -When you configure `setxpack.fleet.agents.fleet_server.hosts` and `xpack.fleet.agents.elasticsearch.hosts` in kibana.yml, you are unable to update the fields on the Fleet UI. +When you configure `setxpack.fleet.agents.fleet_server.hosts` and `xpack.fleet.agents.elasticsearch.hosts` in kibana.yml, you are unable to update the fields on the Fleet UI. For more information, refer to {kibana-pull}135669[#135669]. *Impact* + To configure `setxpack.fleet.agents.fleet_server.hosts` and `xpack.fleet.agents.elasticsearch.hosts` on the Fleet UI, avoid configuring the settings in kibana.yml. ==== - + [discrete] [[breaking-134336]] .Removes the legacy charts library [%collapsible] ==== *Details* + -The legacy implementation of the *Timelion* visualization charts library has been removed. All *Timelion* visualizations now use the elastic-charts library, which was introduced in 7.15.0. +The legacy implementation of the *Timelion* visualization charts library has been removed. All *Timelion* visualizations now use the elastic-charts library, which was introduced in 7.15.0. For more information, refer to {kibana-pull}134336[#134336]. @@ -2309,14 +2309,14 @@ you make the necessary updates after you upgrade to 8.4.0. [%collapsible] ==== *Details* + -The ability to authenticate interactive users with ApiKey via a web browser has been deprecated, and will be removed in a future version. +The ability to authenticate interactive users with ApiKey via a web browser has been deprecated, and will be removed in a future version. For more information, refer to {kibana-pull}136422[#136422]. *Impact* + To authenticate interactive users via a web browser, use <>. Use API keys only for programmatic access to {kib} and {es}. ==== - + [float] [[features-8.4.0]] === Features @@ -2387,7 +2387,7 @@ For more information about the features introduced in 8.4.0, refer to < {rac-ui}*, multi-select the failed rules, click on **Manage rules > Disable** and then click on **Manage rules > Enable**. Disabling and re-enabling the rule will generate a new API key using the credentials of the user performing these actions and reset the rule -state. For more details about API key authorization, refer to +state. For more details about API key authorization, refer to <>. Example error message:: @@ -3708,7 +3708,7 @@ Observability:: * Ensure rum_allow_origins setting only saves valid YAML strings {kibana-pull}128704[#128704] * Standardize NOW as startedAt from executor options {kibana-pull}128020[#128020] * Fixes synthetics recorder file upload {kibana-pull}127614[#127614] -* Service maps popover detail metrics are aggregates over all transaction types {kibana-pull}125580[#125580] +* Service Maps popover detail metrics are aggregates over all transaction types {kibana-pull}125580[#125580] Platform:: * Fixes an issue where duplicate data appears in the inspector datatable in *Lens* for heatmap visualizations, and stale data persists in the inspector datatable when you remove layers {kibana-pull}126786[#126786] @@ -4223,9 +4223,9 @@ The `console.ssl` setting has been removed. For more information, refer to {kiba Before you upgrade to 8.0.0, remove `console.ssl` from kibana.yml. ==== -To review the breaking changes in previous versions, refer to the following: +To review the breaking changes in previous versions, refer to the following: -<> | <> | <> | <> | +<> | <> | <> | <> | <> [float] @@ -4288,7 +4288,7 @@ For information about the features introduced in 8.0.0, refer to <> | <> | <> | <> @@ -4351,9 +4351,9 @@ In production, you are no longer able to use the `elastic` superuser to authenti When you configure `elasticsearch.username: elastic`, {kib} fails. ==== -To review the breaking changes in previous versions, refer to the following: +To review the breaking changes in previous versions, refer to the following: -<> | <> | <> | +<> | <> | <> | <> [float] @@ -4456,7 +4456,7 @@ The endpoint is now split into two separate endpoints: } -- ==== - + [discrete] [[breaking-119945]] .Removes APM jobs from Machine Learning @@ -4487,7 +4487,7 @@ To complete the migration, re enable plugins or delete documents from the index [%collapsible] ==== *Details* + -On the Logs and Metrics UIs, references to the following API and saved object deprecated fields have been removed: +On the Logs and Metrics UIs, references to the following API and saved object deprecated fields have been removed: * `timestamp` * `tiebreaker` @@ -4501,9 +4501,9 @@ For more information, refer to {kibana-pull}116821[#116821] and {kibana-pull}115 When you upgrade to 8.0.0, you are unable to use references to the deprecated fields. ==== -To review the breaking changes in previous versions, refer to the following: +To review the breaking changes in previous versions, refer to the following: -<> | <> | +<> | <> | <> [float] @@ -4569,7 +4569,7 @@ For more information, refer to {fleet-guide}/fleet-api-docs.html[Fleet APIs]. ==== -To review the deprecations in previous versions, refer to the <>. +To review the deprecations in previous versions, refer to the <>. [float] @@ -4613,7 +4613,7 @@ Machine Learning:: * Adds support for `force` stop deployment {kibana-pull}118563[#118563] * Refactors data view loading to remove unnecessary searches {kibana-pull}116455[#116455] Observability:: -* Service maps: Adds sparklines to the detail popover {kibana-pull}120021[#120021] +* Service Maps: Adds sparklines to the detail popover {kibana-pull}120021[#120021] * Offer users upgrade to multi-metric job {kibana-pull}119980[#119980] * Display relevant anomalies from multi-metric job {kibana-pull}119709[#119709] * Adds service icon for the originating service in traces table {kibana-pull}119421[#119421] @@ -4713,14 +4713,14 @@ Review the {kib} 8.0.0-beta1 changes, then use the <> | <> [float] [[alerting-breaking-changes-8.0.0-beta1]] -==== Alerting - +==== Alerting + [discrete] [[breaking-114558]] .Removes `xpack.task_manager.index` @@ -4815,7 +4815,7 @@ Before you upgrade, make the following changes in kibana.yml: The *Dimming opacity* setting in *Advanced Settings* has been removed. For more information, refer to {kibana-pull}111704[#111704]. *Impact* + -When you upgrade to 8.0.0, you are no longer able to configure the dimming opactiy for visualizations. +When you upgrade to 8.0.0, you are no longer able to configure the dimming opactiy for visualizations. ==== [discrete] @@ -4827,7 +4827,7 @@ When you upgrade to 8.0.0, you are no longer able to configure the dimming opact In *TSVB*, custom Less stylesheets have been removed. For more information, refer to {kibana-pull}110985[#110985]. *Impact* + -Existing less stylesheets are automatically converted to CSS stylesheets. +Existing less stylesheets are automatically converted to CSS stylesheets. ==== [discrete] @@ -4879,7 +4879,7 @@ Configure the settings in https://www.elastic.co/guide/en/ecs/current/ecs-refere [float] [[machine-learning-breaking-changes-8.0.0-beta1]] ==== Machine learning - + [discrete] [[breaking-115444]] .Grants access to machine learning features when base privileges are used @@ -4910,7 +4910,7 @@ Install the on-prem version of the <>, [float] [[operations-breaking-changes-8.0.0-beta1]] -==== Operations +==== Operations [discrete] [[breaking-111535]] @@ -4926,8 +4926,8 @@ Replace the `CONFIG_PATH` environment variable with `KBN_PATH_CONF`, and replace [float] [[platform-breaking-changes-8.0.0-beta1]] -==== Platform - +==== Platform + [discrete] [[breaking-114379]] .Removes supports for csp.rules configuration @@ -5034,7 +5034,7 @@ The legacy `optimize.*` settings have been removed. If your configuration uses t For more information, refer to {kibana-pull}113296[#113296]. *Impact* + -To run the `@kbn/optimizer` separately in development, pass `--no-optimizer` to `yarn start`. For more details, refer to {kibana-pull}73154[#73154]. +To run the `@kbn/optimizer` separately in development, pass `--no-optimizer` to `yarn start`. For more details, refer to {kibana-pull}73154[#73154]. ==== [discrete] @@ -5079,7 +5079,7 @@ The `kibana.index`, `xpack.reporting.index`, and `xpack.task_manager.index` sett *Impact* + Use spaces, cross-cluster replication, or cross-cluster search. To migrate to <>, export your <> from a tenant into the default space. For more details, refer to link:https://github.com/elastic/kibana/issues/82020[#82020]. ==== - + [discrete] [[breaking-112305]] .Removes legacy logging @@ -5089,20 +5089,20 @@ Use spaces, cross-cluster replication, or cross-cluster search. To migrate to << The logging configuration and log output format has changed. For more information, refer to {kibana-pull}112305[#112305]. *Impact* + -Use the new <>. +Use the new <>. ==== [float] [[reporting-breaking-changes-8.0.0-beta1]] ==== Reporting - + [discrete] [[breaking-114216]] .Removes reporting settings [%collapsible] ==== *Details* + -The following settings have been removed: +The following settings have been removed: * `xpack.reporting.capture.concurrency` @@ -5120,7 +5120,7 @@ Before you upgrade to 8.0.0, remove the settings from kibana.yml. [float] [[rest-api-breaking-changes-8.0.0-beta1]] -==== REST API +==== REST API [discrete] [[breaking-114730]] @@ -5156,8 +5156,8 @@ Audit logs will be written to the default location in the new ECS format. To cha Deprecated functionality does not have an immediate impact on your application, but we strongly recommend you make the necessary updates after you complete the upgrade. -To review the 8.0.0 depcrecations, refer to the <>. - +To review the 8.0.0 depcrecations, refer to the <>. + [float] [[features-8.0.0-beta1]] === Features @@ -5236,7 +5236,7 @@ To review the breaking changes in the previous version, refer to <> to index your static vector data into {es}. +. To recreate the choropleth layer, use <> to index your static vector data into {es}. -. Create a choropleth layer from the indexed vector data. +. Create a choropleth layer from the indexed vector data. ==== - + [discrete] [[breaking-109798]] .Removes `kibana.defaultAppId` @@ -5278,7 +5278,7 @@ The deprecated `kibana.defaultAppId` setting in kibana.yml, which is also availa *Impact* + When you upgrade, remove `kibana.defaultAppId` from your kibana.yml file. To configure the default route for users when they enter a space, use the <> in *Advanced Settings*. ==== - + [discrete] [[breaking-109350]] .Removes `courier:batchSearches` @@ -5290,7 +5290,7 @@ The deprecated `courier:batchSearches` setting in *Advanced Settings* has been r *Impact* + When you upgrade, the `courier:batchSearches` setting will no longer be available. ==== - + [discrete] [[breaking-108111]] .Removes `xpack.task_manager.index` @@ -5302,7 +5302,7 @@ The deprecated `xpack.task_manager.index` setting in kibana.yml has been removed *Impact* + When you upgrade, remove `xpack.task_manager.index` from your kibana.yml file. ==== - + [discrete] [[breaking-108103]] .Removes dashboard-only mode @@ -5314,7 +5314,7 @@ The legacy dashboard-only mode has been removed. For more information, refer to *Impact* + To grant users access to only dashboards, create a new role, then assign only the *Dashboard* feature privilege. For more information, refer to <>. ==== - + [discrete] [[breaking-105979]] .Removes `xpack.maps.showMapVisualizationTypes` @@ -5333,8 +5333,8 @@ When you upgrade, remove `xpack.maps.showMapVisualizationTypes` from your kibana Deprecated functionality does not have an immediate impact on your application, but we strongly recommend you make the necessary updates after you complete the upgrade. -To review the 8.0.0 depcrecations, refer to the <>. - +To review the 8.0.0 depcrecations, refer to the <>. + [float] [[features-8.0.0-alpha2]] === Features @@ -5342,7 +5342,7 @@ The 8.0.0-alpha2 release adds the following new and notable feature. Security:: * Adds the interactive setup mode {kibana-pull}106881[#106881] - + [float] [[enhancement-v8.0.0-alpha2]] === Enhancements @@ -5362,7 +5362,7 @@ Review the {kib} 8.0.0-alpha1 changes, then use the <>. ++++ [[apm-app-storage-explorer-user]] -==== Storage explorer user +==== Storage Explorer user -View the **Storage explorer** in the APM app. +View the **Storage Explorer** in the APM app. . Create a new role, named something like `storage-explorer_user`, and assign the following privileges: @@ -255,7 +255,7 @@ include::./tab-widgets/storage-explorer-user/widget.asciidoc[] -- . Assign the `storage-explorer_user` created previously, and the roles and privileges necessary to create -a <> or <> APM reader to any users that need to view **Storage explorer** in the APM app. +a <> or <> APM reader to any users that need to view **Storage Explorer** in the APM app. //// *********************************** *********************************** diff --git a/docs/apm/machine-learning.asciidoc b/docs/apm/machine-learning.asciidoc index 6c51290414c13..8f82cb2a00f10 100644 --- a/docs/apm/machine-learning.asciidoc +++ b/docs/apm/machine-learning.asciidoc @@ -26,7 +26,7 @@ image::apm/images/service-quick-health.png[Example view of anomaly scores on res [role="screenshot"] image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in the APM app] -* Service maps will display a color-coded anomaly indicator based on the detected anomaly score. +* Service Maps will display a color-coded anomaly indicator based on the detected anomaly score. + [role="screenshot"] image::apm/images/apm-service-map-anomaly.png[Example view of anomaly scores on service maps in the APM app] diff --git a/docs/apm/service-maps.asciidoc b/docs/apm/service-maps.asciidoc index 5a5927a997f64..a0c9dda2188cb 100644 --- a/docs/apm/service-maps.asciidoc +++ b/docs/apm/service-maps.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[service-maps]] -=== Service map +=== Service Map A service map is a real-time visual representation of the instrumented services in your application's architecture. It shows you how these services are connected, along with high-level metrics like average transaction duration, @@ -40,7 +40,7 @@ We currently surface two types of service maps: [[service-maps-how]] === How do service maps work? -Service maps rely on distributed traces to draw connections between services. +Service Maps rely on distributed traces to draw connections between services. As {apm-guide-ref}/apm-distributed-tracing.html[distributed tracing] is enabled out-of-the-box for supported technologies, so are service maps. However, if a service isn't instrumented, or a `traceparent` header isn't being propagated to it, @@ -105,7 +105,7 @@ Type and subtype are based on `span.type`, and `span.subtype`. [[service-maps-supported]] === Supported APM agents -Service maps are supported for the following APM agent versions: +Service Maps are supported for the following APM agent versions: [horizontal] Go agent:: ≥ v1.7.0 diff --git a/docs/apm/storage-explorer.asciidoc b/docs/apm/storage-explorer.asciidoc index c82c43ead2b5f..98547de494f1f 100644 --- a/docs/apm/storage-explorer.asciidoc +++ b/docs/apm/storage-explorer.asciidoc @@ -1,5 +1,5 @@ [[storage-explorer]] -=== Storage explorer +=== Storage Explorer beta::[] @@ -10,7 +10,7 @@ Or, expand the time filter to visualize data trends over time so that you can be and prepare for future storage needs. [role="screenshot"] -image::apm/images/storage-explorer-overview.png[APM Storage explorer] +image::apm/images/storage-explorer-overview.png[APM Storage Explorer] [float] ==== Index lifecycle phases @@ -50,7 +50,7 @@ the total number of documents. * Number of **transactions**, **spans**, **errors**, and **metrics** — doc count and size on disk. [role="screenshot"] -image::apm/images/storage-explorer-expanded.png[APM Storage explorer service breakdown] +image::apm/images/storage-explorer-expanded.png[APM Storage Explorer service breakdown] As you explore your service statistics, you might want to take action to reduce the number of documents and therefore storage size of a particular service. @@ -84,7 +84,7 @@ work with your developers to change how exceptions are handled in your code. [float] ==== Privileges -Storage explorer requires expanded privileges to view. +Storage Explorer requires expanded privileges to view. See <> for more information. [float] diff --git a/docs/apm/traces.asciidoc b/docs/apm/traces.asciidoc index a3bd707b60629..1269781e7798e 100644 --- a/docs/apm/traces.asciidoc +++ b/docs/apm/traces.asciidoc @@ -28,7 +28,7 @@ preview::[] **Trace explorer** is an experimental top-level search tool that allows you to query your traces using <> or {ref}/eql.html[Event Query Language (EQL)]. -Curate your own custom queries, or use the <> to find and select edges to automatically generate queries based on your selection: +Curate your own custom queries, or use the <> to find and select edges to automatically generate queries based on your selection: [role="screenshot"] image::apm/images/trace-explorer.png[Trace explorer] diff --git a/docs/apm/troubleshooting.asciidoc b/docs/apm/troubleshooting.asciidoc index 339645fe50e5c..93464d23518b6 100644 --- a/docs/apm/troubleshooting.asciidoc +++ b/docs/apm/troubleshooting.asciidoc @@ -176,7 +176,7 @@ These are dynamic by default, which means they will be indexed and become search [float] [[service-map-rum-connections]] -=== Service maps: no connection between client and server +=== Service Maps: no connection between client and server If the service map is not showing an expected connection between the client and server, it's likely because you haven't configured diff --git a/x-pack/plugins/apm/ftr_e2e/cypress/e2e/power_user/storage_explorer/storage_explorer.cy.ts b/x-pack/plugins/apm/ftr_e2e/cypress/e2e/power_user/storage_explorer/storage_explorer.cy.ts index 1ade523356987..4894147002a78 100644 --- a/x-pack/plugins/apm/ftr_e2e/cypress/e2e/power_user/storage_explorer/storage_explorer.cy.ts +++ b/x-pack/plugins/apm/ftr_e2e/cypress/e2e/power_user/storage_explorer/storage_explorer.cy.ts @@ -72,7 +72,7 @@ describe('Storage Explorer', () => { }); it('has no detectable a11y violations on load', () => { - cy.contains('h1', 'Storage explorer'); + cy.contains('h1', 'Storage Explorer'); // set skipFailures to true to not fail the test when there are accessibility failures checkA11y({ skipFailures: true }); }); diff --git a/x-pack/plugins/apm/public/components/app/correlations/chart_title_tool_tip.tsx b/x-pack/plugins/apm/public/components/app/correlations/chart_title_tool_tip.tsx index ed2bd49858310..730aed89a5c70 100644 --- a/x-pack/plugins/apm/public/components/app/correlations/chart_title_tool_tip.tsx +++ b/x-pack/plugins/apm/public/components/app/correlations/chart_title_tool_tip.tsx @@ -16,7 +16,7 @@ export function ChartTitleToolTip() { 'xpack.apm.correlations.latencyCorrelations.titleHelp', { defaultMessage: - 'The chart uses logarithmic scales on both axes to avoid outliers distorting it', + 'This chart uses logarithmic scales on both axes to avoid distortion from outliers.', } )} position="right" diff --git a/x-pack/plugins/apm/public/components/app/correlations/empty_state_prompt.tsx b/x-pack/plugins/apm/public/components/app/correlations/empty_state_prompt.tsx index 93020ac1eacef..226f0c34bbc47 100644 --- a/x-pack/plugins/apm/public/components/app/correlations/empty_state_prompt.tsx +++ b/x-pack/plugins/apm/public/components/app/correlations/empty_state_prompt.tsx @@ -31,12 +31,12 @@ export function CorrelationsEmptyStatePrompt() {


diff --git a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx index cb9cb6b42191f..081a24ceb4427 100644 --- a/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx +++ b/x-pack/plugins/apm/public/components/app/service_inventory/service_list/index.tsx @@ -377,7 +377,7 @@ export function ServiceList({ 'xpack.apm.servicesTable.tooltip.metricsExplanation', { defaultMessage: - 'Service metrics are aggregated on transaction type "request", "page-load", or the top available transaction type.', + 'Service metrics are aggregated on their transaction type, which can be request or page-load. If neither exists, metrics are aggregated on the top available transaction type.', } )} > diff --git a/x-pack/plugins/apm/public/components/app/service_map/disabled_prompt.tsx b/x-pack/plugins/apm/public/components/app/service_map/disabled_prompt.tsx index 77f8a0ea505c5..433d084182d54 100644 --- a/x-pack/plugins/apm/public/components/app/service_map/disabled_prompt.tsx +++ b/x-pack/plugins/apm/public/components/app/service_map/disabled_prompt.tsx @@ -17,7 +17,7 @@ export function DisabledPrompt() { title={

{i18n.translate('xpack.apm.serviceMap.disabledTitle', { - defaultMessage: 'Service map is disabled', + defaultMessage: 'Service Map is disabled', })}

} diff --git a/x-pack/plugins/apm/public/components/app/service_map/timeout_prompt.tsx b/x-pack/plugins/apm/public/components/app/service_map/timeout_prompt.tsx index cec31e599bb21..2f5b850c456bf 100644 --- a/x-pack/plugins/apm/public/components/app/service_map/timeout_prompt.tsx +++ b/x-pack/plugins/apm/public/components/app/service_map/timeout_prompt.tsx @@ -22,7 +22,7 @@ export function TimeoutPrompt({ title={

{i18n.translate('xpack.apm.serviceMap.timeoutPromptTitle', { - defaultMessage: 'Service map timeout', + defaultMessage: 'Service Map timeout', })}

} diff --git a/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index.tsx b/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index.tsx index b40102e0429bf..cbe7d908c8acc 100644 --- a/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index.tsx +++ b/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index.tsx @@ -330,7 +330,7 @@ export function ServicesTable() { tableCaption={i18n.translate( 'xpack.apm.storageExplorer.table.caption', { - defaultMessage: 'Storage explorer', + defaultMessage: 'Storage Explorer', } )} items={items ?? []} diff --git a/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index_stats_per_service.tsx b/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index_stats_per_service.tsx index 6eb721281f708..9306a575653cb 100644 --- a/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index_stats_per_service.tsx +++ b/x-pack/plugins/apm/public/components/app/storage_explorer/services_table/index_stats_per_service.tsx @@ -130,7 +130,7 @@ export function IndexStatsPerService({ indicesStats, status }: Props) { tableCaption={i18n.translate( 'xpack.apm.storageExplorer.indicesStats.table.caption', { - defaultMessage: 'Storage explorer indices breakdown', + defaultMessage: 'Storage Explorer indices breakdown', } )} items={indicesStats} diff --git a/x-pack/plugins/apm/public/components/routing/home/storage_explorer.tsx b/x-pack/plugins/apm/public/components/routing/home/storage_explorer.tsx index 6c4af2e87c710..5dd6fe819343a 100644 --- a/x-pack/plugins/apm/public/components/routing/home/storage_explorer.tsx +++ b/x-pack/plugins/apm/public/components/routing/home/storage_explorer.tsx @@ -23,7 +23,7 @@ export const storageExplorer = { element: ( @@ -31,7 +31,7 @@ export const storageExplorer = { pageHeader={{ alignItems: 'center', pageTitle: i18n.translate('xpack.apm.views.storageExplorer.title', { - defaultMessage: 'Storage explorer', + defaultMessage: 'Storage Explorer', }), rightSideItems: [

diff --git a/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.test.ts b/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.test.ts index 8e9b19350aa80..c9c9173935b12 100644 --- a/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.test.ts +++ b/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.test.ts @@ -79,7 +79,7 @@ describe('Transaction action menu', () => { }, { key: 'serviceMap', - title: 'Service map', + title: 'Service Map', subtitle: 'View service map filtered by this trace.', actions: [ { @@ -160,7 +160,7 @@ describe('Transaction action menu', () => { }, { key: 'serviceMap', - title: 'Service map', + title: 'Service Map', subtitle: 'View service map filtered by this trace.', actions: [ { @@ -240,7 +240,7 @@ describe('Transaction action menu', () => { }, { key: 'serviceMap', - title: 'Service map', + title: 'Service Map', subtitle: 'View service map filtered by this trace.', actions: [ { diff --git a/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.ts b/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.ts index e96e1e5b227b5..96126434da529 100644 --- a/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.ts +++ b/x-pack/plugins/apm/public/components/shared/transaction_action_menu/sections.ts @@ -359,7 +359,7 @@ export const getSections = ({ title: i18n.translate( 'xpack.apm.transactionActionMenu.serviceMap.title', { - defaultMessage: 'Service map', + defaultMessage: 'Service Map', } ), subtitle: i18n.translate( diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/common/header/action_menu_content.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/common/header/action_menu_content.tsx index f6702a05f75dd..d74492794d08f 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/common/header/action_menu_content.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/common/header/action_menu_content.tsx @@ -26,7 +26,7 @@ const ANALYZE_DATA = i18n.translate('xpack.synthetics.analyzeDataButtonLabel', { const ANALYZE_MESSAGE = i18n.translate('xpack.synthetics.analyzeDataButtonLabel.message', { defaultMessage: - 'Explore Data allows you to select and filter result data in any dimension and look for the cause or impact of performance problems.', + 'Go to Explore Data, where you can select and filter result data in any dimension and look for the cause or impact of performance problems.', }); export function ActionMenuContent(): React.ReactElement { diff --git a/x-pack/plugins/uptime/public/legacy_uptime/components/common/header/action_menu_content.tsx b/x-pack/plugins/uptime/public/legacy_uptime/components/common/header/action_menu_content.tsx index 66c977fb9cb36..38047aff244b4 100644 --- a/x-pack/plugins/uptime/public/legacy_uptime/components/common/header/action_menu_content.tsx +++ b/x-pack/plugins/uptime/public/legacy_uptime/components/common/header/action_menu_content.tsx @@ -32,7 +32,7 @@ const ANALYZE_DATA = i18n.translate('xpack.uptime.analyzeDataButtonLabel', { const ANALYZE_MESSAGE = i18n.translate('xpack.uptime.analyzeDataButtonLabel.message', { defaultMessage: - 'Explore Data allows you to select and filter result data in any dimension and look for the cause or impact of performance problems.', + 'Go to Explore Data, where you can select and filter result data in any dimension and look for the cause or impact of performance problems.', }); export function ActionMenuContent(): React.ReactElement { diff --git a/x-pack/plugins/ux/public/components/app/rum_dashboard/action_menu/index.tsx b/x-pack/plugins/ux/public/components/app/rum_dashboard/action_menu/index.tsx index 6637a909c235a..7535420b3058a 100644 --- a/x-pack/plugins/ux/public/components/app/rum_dashboard/action_menu/index.tsx +++ b/x-pack/plugins/ux/public/components/app/rum_dashboard/action_menu/index.tsx @@ -27,7 +27,7 @@ const ANALYZE_MESSAGE = i18n.translate( 'xpack.ux.analyzeDataButtonLabel.message', { defaultMessage: - 'Explore Data allows you to select and filter result data in any dimension and look for the cause or impact of performance problems.', + 'Go to Explore Data, where you can select and filter result data in any dimension and look for the cause or impact of performance problems.', } ); diff --git a/x-pack/test/apm_api_integration/tests/error_rate/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/error_rate/service_maps.spec.ts index 5564ac998c0d6..6df94ac122161 100644 --- a/x-pack/test/apm_api_integration/tests/error_rate/service_maps.spec.ts +++ b/x-pack/test/apm_api_integration/tests/error_rate/service_maps.spec.ts @@ -72,7 +72,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { let errorRateMetricValues: Awaited>; let errorTransactionValues: Awaited>; - registry.when('Service maps APIs', { config: 'trial', archives: [] }, () => { + registry.when('Service Maps APIs', { config: 'trial', archives: [] }, () => { describe('when data is loaded ', () => { const GO_PROD_LIST_RATE = 75; const GO_PROD_LIST_ERROR_RATE = 25; diff --git a/x-pack/test/apm_api_integration/tests/latency/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/latency/service_maps.spec.ts index 368a3794db684..5f0f40c12b57a 100644 --- a/x-pack/test/apm_api_integration/tests/latency/service_maps.spec.ts +++ b/x-pack/test/apm_api_integration/tests/latency/service_maps.spec.ts @@ -71,7 +71,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { let latencyMetricValues: Awaited>; let latencyTransactionValues: Awaited>; - registry.when('Service maps APIs', { config: 'trial', archives: [] }, () => { + registry.when('Service Maps APIs', { config: 'trial', archives: [] }, () => { describe('when data is loaded ', () => { const GO_PROD_RATE = 80; const GO_DEV_RATE = 20; diff --git a/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts index c755f93d3b450..7a0bd8490b240 100644 --- a/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts +++ b/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts @@ -24,7 +24,7 @@ export default function serviceMapsApiTests({ getService }: FtrProviderContext) const archiveName = 'apm_8.0.0'; const metadata = archives_metadata[archiveName]; - registry.when('Service map with a basic license', { config: 'basic', archives: [] }, () => { + registry.when('Service Map with a basic license', { config: 'basic', archives: [] }, () => { it('is only be available to users with Platinum license (or higher)', async () => { try { await apmApiClient.readUser({ @@ -49,7 +49,7 @@ export default function serviceMapsApiTests({ getService }: FtrProviderContext) }); }); - registry.when('Service map without data', { config: 'trial', archives: [] }, () => { + registry.when('Service Map without data', { config: 'trial', archives: [] }, () => { describe('/internal/apm/service-map', () => { it('returns an empty list', async () => { const response = await apmApiClient.readUser({ diff --git a/x-pack/test/apm_api_integration/tests/service_maps/service_maps_kuery_filter.spec.ts b/x-pack/test/apm_api_integration/tests/service_maps/service_maps_kuery_filter.spec.ts index 7a454ad5c9687..42de24f80df18 100644 --- a/x-pack/test/apm_api_integration/tests/service_maps/service_maps_kuery_filter.spec.ts +++ b/x-pack/test/apm_api_integration/tests/service_maps/service_maps_kuery_filter.spec.ts @@ -40,7 +40,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { }); } - registry.when('Service map', { config: 'trial', archives: [] }, () => { + registry.when('Service Map', { config: 'trial', archives: [] }, () => { describe('optional kuery param', () => { before(async () => { const events = timerange(start, end) diff --git a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer.spec.ts b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer.spec.ts index d52b1e902c575..6c5f063c869de 100644 --- a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer.spec.ts +++ b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer.spec.ts @@ -44,7 +44,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { } registry.when( - 'Storage explorer when data is not loaded', + 'Storage Explorer when data is not loaded', { config: 'basic', archives: [] }, () => { it('handles empty state', async () => { @@ -56,7 +56,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { } ); - registry.when('Storage explorer', { config: 'basic', archives: [] }, () => { + registry.when('Storage Explorer', { config: 'basic', archives: [] }, () => { describe('when data is loaded', () => { before(async () => { const serviceGo = apm diff --git a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_privileges.spec.ts b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_privileges.spec.ts index 087bacdc898b3..af0dd8450f112 100644 --- a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_privileges.spec.ts +++ b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_privileges.spec.ts @@ -18,7 +18,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { }); } - registry.when('Storage explorer privileges', { config: 'basic', archives: [] }, () => { + registry.when('Storage Explorer privileges', { config: 'basic', archives: [] }, () => { it('returns true when the user has the required indices privileges', async () => { const { status, body } = await callApi(apmApiClient.monitorClusterAndIndicesUser); expect(status).to.be(200); diff --git a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_summary_stats.spec.ts b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_summary_stats.spec.ts index 3f80a8df4c77b..791869dae69f5 100644 --- a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_summary_stats.spec.ts +++ b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_summary_stats.spec.ts @@ -44,7 +44,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { } registry.when( - 'Storage explorer summary stats when data is not loaded', + 'Storage Explorer summary stats when data is not loaded', { config: 'basic', archives: [] }, () => { it('handles empty state', async () => { @@ -61,7 +61,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { } ); - registry.when('Storage explorer summary stats', { config: 'basic', archives: [] }, () => { + registry.when('Storage Explorer summary stats', { config: 'basic', archives: [] }, () => { describe('when data is loaded', () => { before(async () => { const serviceGo = apm diff --git a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_timeseries_chart.spec.ts b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_timeseries_chart.spec.ts index 547d2b5bd0157..ea28246d7011f 100644 --- a/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_timeseries_chart.spec.ts +++ b/x-pack/test/apm_api_integration/tests/storage_explorer/storage_explorer_timeseries_chart.spec.ts @@ -38,7 +38,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { } registry.when( - 'Storage explorer timeseries chart when data is not loaded', + 'Storage Explorer timeseries chart when data is not loaded', { config: 'basic', archives: [] }, () => { it('handles empty state', async () => { @@ -50,7 +50,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { } ); - registry.when('Storage explorer timeseries chart', { config: 'basic', archives: [] }, () => { + registry.when('Storage Explorer timeseries chart', { config: 'basic', archives: [] }, () => { describe('when data is loaded', () => { let body: StorageTimeSeries; let status: number; diff --git a/x-pack/test/apm_api_integration/tests/throughput/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/throughput/service_maps.spec.ts index a0721b6ebfcb5..d321217a33c03 100644 --- a/x-pack/test/apm_api_integration/tests/throughput/service_maps.spec.ts +++ b/x-pack/test/apm_api_integration/tests/throughput/service_maps.spec.ts @@ -81,7 +81,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { let throughputMetricValues: Awaited>; let throughputTransactionValues: Awaited>; - registry.when('Service maps APIs', { config: 'trial', archives: [] }, () => { + registry.when('Service Maps APIs', { config: 'trial', archives: [] }, () => { describe('when data is loaded ', () => { const GO_PROD_RATE = 80; const GO_DEV_RATE = 20; diff --git a/x-pack/test/functional/apps/apm/correlations/failed_transaction_correlations.ts b/x-pack/test/functional/apps/apm/correlations/failed_transaction_correlations.ts index 61b19327428e7..541405265ee3b 100644 --- a/x-pack/test/functional/apps/apm/correlations/failed_transaction_correlations.ts +++ b/x-pack/test/functional/apps/apm/correlations/failed_transaction_correlations.ts @@ -146,7 +146,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { // Assert that results for the given service didn't find any correlations const apmCorrelationsTable = await testSubjects.getVisibleText('apmCorrelationsTable'); expect(apmCorrelationsTable).to.be( - 'No significant correlations\nCorrelations will only be identified if they have significant impact.\nTry selecting another time range or remove any added filter.' + 'No significant correlations\nCorrelations are only identified if they have significant impact.\nTry selecting another time range or removing any added filters.' ); }); }); diff --git a/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts b/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts index 88f4e2be7d7c3..5deb2a9060f41 100644 --- a/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts +++ b/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts @@ -157,7 +157,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { // Assert that results for the given service didn't find any correlations const apmCorrelationsTable = await testSubjects.getVisibleText('apmCorrelationsTable'); expect(apmCorrelationsTable).to.be( - 'No significant correlations\nCorrelations will only be identified if they have significant impact.\nTry selecting another time range or remove any added filter.' + 'No significant correlations\nCorrelations are only identified if they have significant impact.\nTry selecting another time range or removing any added filters.' ); }); });