From 90b302d15d8a19cdbad872eb740cc00666bb7ab4 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Fri, 8 Nov 2024 16:50:10 -0600 Subject: [PATCH 1/2] use attributes --- .../collect-application-data/index.asciidoc | 2 +- .../monitor-infra/analyze-hosts.asciidoc | 2 +- .../observability-ai-assistant.asciidoc | 4 +- docs/en/observability/slo-overview.asciidoc | 4 +- .../observability/synthetics-analyze.asciidoc | 40 +++++++++---------- .../en/observability/threshold-alert.asciidoc | 2 +- .../triage-slo-burn-rate-breaches.asciidoc | 6 +-- .../triage-threshold-breaches.asciidoc | 6 +-- .../view-observability-alerts.asciidoc | 10 ++--- .../aiops-generate-anomaly-alerts.asciidoc | 2 +- docs/en/serverless/alerting/alerting.asciidoc | 2 +- .../create-anomaly-alert-rule.asciidoc | 2 +- ...reate-custom-threshold-alert-rule.asciidoc | 4 +- ...te-elasticsearch-query-alert-rule.asciidoc | 2 +- ...-error-count-threshold-alert-rule.asciidoc | 4 +- ...saction-rate-threshold-alert-rule.asciidoc | 4 +- ...te-inventory-threshold-alert-rule.asciidoc | 2 +- ...eate-latency-threshold-alert-rule.asciidoc | 2 +- .../alerting/create-manage-rules.asciidoc | 4 +- .../create-slo-burn-rate-alert-rule.asciidoc | 4 +- .../triage-slo-burn-rate-breaches.asciidoc | 6 +-- .../triage-threshold-breaches.asciidoc | 6 +-- .../serverless/alerting/view-alerts.asciidoc | 8 ++-- .../apm/apm-send-traces-to-elastic.asciidoc | 2 +- .../apm/apm-ui-trace-sample-timeline.asciidoc | 2 +- .../cases/create-manage-cases.asciidoc | 4 +- .../infra-monitoring/analyze-hosts.asciidoc | 2 +- .../correlate-application-logs.asciidoc | 8 ++-- .../logging/ecs-application-logs.asciidoc | 2 +- .../plaintext-application-logs.asciidoc | 2 +- .../logging/troubleshoot-logs.asciidoc | 2 +- .../logging/view-and-monitor-logs.asciidoc | 18 ++++----- docs/en/serverless/monitor-datasets.asciidoc | 6 +-- docs/en/serverless/slos/slos.asciidoc | 4 +- .../synthetics/synthetics-analyze.asciidoc | 38 +++++++++--------- 35 files changed, 109 insertions(+), 109 deletions(-) diff --git a/docs/en/observability/apm/collect-application-data/index.asciidoc b/docs/en/observability/apm/collect-application-data/index.asciidoc index 1d8f3b19d1..92b3f1ca25 100644 --- a/docs/en/observability/apm/collect-application-data/index.asciidoc +++ b/docs/en/observability/apm/collect-application-data/index.asciidoc @@ -42,7 +42,7 @@ _Refer to_ <> [[apm-collect-data-availability]] === Availability -:not-available: image:images/icons/cross.svg[Not available] +:not-available: {icon-cross} //// TO DO: diff --git a/docs/en/observability/monitor-infra/analyze-hosts.asciidoc b/docs/en/observability/monitor-infra/analyze-hosts.asciidoc index d8d9a10c0f..5b36d699bb 100644 --- a/docs/en/observability/monitor-infra/analyze-hosts.asciidoc +++ b/docs/en/observability/monitor-infra/analyze-hosts.asciidoc @@ -271,7 +271,7 @@ Content: === What does _this host has been detected by APM_ mean? // What the user sees/experiences (error message, UI, behavior, etc) -In the Hosts view, you might see a question mark icon (image:images/icons/questionInCircle.svg[Question mark icon]) +In the Hosts view, you might see a question mark icon ({icon-questionInCircle}) before a host name with a tooltip note stating that the host has been detected by APM. // Why it happens When a host is detected by APM, but is not collecting full metrics diff --git a/docs/en/observability/observability-ai-assistant.asciidoc b/docs/en/observability/observability-ai-assistant.asciidoc index 71cda91d09..4c361bc5df 100644 --- a/docs/en/observability/observability-ai-assistant.asciidoc +++ b/docs/en/observability/observability-ai-assistant.asciidoc @@ -207,7 +207,7 @@ Your feedback helps us improve the AI Assistant! [[obs-ai-chat]] === Chat with the assistant -Select the *AI Assistant* icon (image:images/icons/ai-assistant.svg[AI Assistant icon]) at the upper-right corner of any {observability} application to start the chat: +Select the *AI Assistant* icon ({icon-ai-assistant}) at the upper-right corner of any {observability} application to start the chat: This opens the AI Assistant flyout, where you can ask the assistant questions about your instance: @@ -339,7 +339,7 @@ You can access the AI Assistant Settings page: The AI Assistant Settings page contains the following tabs: * *Settings*: Configures the main AI Assistant settings, which are explained directly within the interface. -* *Knowledge base*: Manages <>. +* *Knowledge base*: Manages <>. * *Search Connectors*: Provides a link to {kib} *Search* -> *Content* -> *Connectors* UI for connectors configuration. [discrete] [[obs-ai-known-issues]] diff --git a/docs/en/observability/slo-overview.asciidoc b/docs/en/observability/slo-overview.asciidoc index a9a9832e9f..fa5fd65c04 100644 --- a/docs/en/observability/slo-overview.asciidoc +++ b/docs/en/observability/slo-overview.asciidoc @@ -56,7 +56,7 @@ You can apply searches and filters to quickly find the SLOs you're interested in [role="screenshot"] image::images/slo-filtering-options.png[Options for filtering SLOs in the overview] -* **Apply structured filters:** Next to the search field, click the **Add filter** image:images/icons/addFilter.svg[Add filter icon] icon to add a custom filter. Notice that you can use `OR` and `AND` to combine filters. The structured filter can be disabled, inverted, or pinned across all apps. +* **Apply structured filters:** Next to the search field, click the **Add filter** {icon-plusInCircleFilled} icon to add a custom filter. Notice that you can use `OR` and `AND` to combine filters. The structured filter can be disabled, inverted, or pinned across all apps. * **Enter a semi-structured search:** In the search field, start typing a field name to get suggestions for field names and operators that you can use to build a structured query. The semi-structured search will filter SLOs for matches, and only return matching SLOs. * Use the **Status** and **Tags** menus to include or exclude SLOs from the view based on the status or defined tags. @@ -67,7 +67,7 @@ image::images/slo-group-by.png[SLOs sorted by SLO status and grouped by tags] * **Sort by**: SLI value, SLO status, Error budget consumed, or Error budget remaining. * **Group by**: None, Tags, Status, or SLI type. -* Click icons to switch between a card view (image:images/icons/apps.svg[Card view icon]), list view (image:images/icons/list.svg[List view icon]), or compact view (image:images/icons/tableDensityCompact.svg[Compact view icon]). +* Click icons to switch between a card view ({icon-apps}), list view ({icon-list}), or compact view ({icon-tableDensityCompact}). [discrete] [[slo-dashboard-panels]] diff --git a/docs/en/observability/synthetics-analyze.asciidoc b/docs/en/observability/synthetics-analyze.asciidoc index ab686e1b4a..b05c438c14 100644 --- a/docs/en/observability/synthetics-analyze.asciidoc +++ b/docs/en/observability/synthetics-analyze.asciidoc @@ -53,7 +53,7 @@ page you'll see: multiple locations, you'll also see a down arrow icon that you can use to quickly move between locations that use the same configuration. * The latest *status* and when the monitor was *last run*. -* The *image:images/icons/beaker.svg[Beaker icon] Run test manually* button that allows you to run the test on +* The *{icon-beaker} Run test manually* button that allows you to run the test on demand before the next scheduled run. + [NOTE] @@ -62,7 +62,7 @@ This is only available for monitors running on Elastic's global managed testing It is not available for monitors running on {private-location}s. ==== -* The *image:images/icons/pencil.svg[Pencil icon] Edit monitor* button that allows you to edit the monitor's +* The *{icon-pencil} Edit monitor* button that allows you to edit the monitor's configuration. [role="screenshot"] @@ -89,7 +89,7 @@ image::images/synthetics-analyze-individual-monitor-details.png[Details in the O The *History* tab has information on every time the monitor has run. It includes some high-level stats and a complete list of all test runs. -Use the calendar icon (image:images/icons/calendar.svg[Calendar icon]) and search bar +Use the calendar icon ({icon-calendar}) and search bar to filter for runs that occurred in a specific time period. // What you might do with this info @@ -104,7 +104,7 @@ image::images/synthetics-analyze-individual-monitor-history.png[The History tab If the monitor is configured to <>, you'll see retests listed in the *Test runs* table. Runs that are retests include a -rerun icon (image:images/icons/refresh.svg[Refresh icon]) next to the result badge. +rerun icon ({icon-refresh}) next to the result badge. [role="screenshot"] image::synthetics-retest.png[A failed run and a retest in the table of test runs in the {synthetics-app}] @@ -119,7 +119,7 @@ failed runs will only result in an error if both the initial run and the rerun f This can reduce noise related to transient problems. The Errors tab includes a high-level overview of all alerts and a complete list of all failures. -Use the calendar icon (image:images/icons/calendar.svg[Calendar icon]) and search bar +Use the calendar icon ({icon-calendar}) and search bar to filter for runs that occurred in a specific time period. // What you might do with this info @@ -157,11 +157,11 @@ image::images/synthetics-analyze-journeys-over-time.png[Individual journey page From here, you can either drill down into: -* The latest run of the full journey by clicking *image:images/icons/inspect.svg[Inspect icon] View test run* +* The latest run of the full journey by clicking *{icon-inspect} View test run* or a past run in the list of *Last 10 test runs*. This will take you to the view described below in <>. -* An individual step in this run by clicking the performance breakdown icon - (image:images/icons/apmTrace.svg[Performance breakdown icon]) next to one of the steps. +* An individual step in this run by clicking the performance breakdown icon + ({icon-apmTrace}) next to one of the steps. This will take you to the view described below in <>. [discrete] @@ -176,8 +176,8 @@ At the top of the page, see the _Code executed_ and any _Console_ output for eac If the step failed, this will also include a _Stacktrace_ tab that you can use to diagnose the cause of errors. -Navigate through each step using *image:images/icons/arrowLeft.svg[Previous icon] Previous* and -*Next image:images/icons/arrowRight.svg[Next icon]*. +Navigate through each step using *{icon-arrowLeft} Previous* and +*Next {icon-arrowRight}*. // Screenshot of the viz [role="screenshot"] @@ -185,7 +185,7 @@ image::images/synthetics-analyze-one-run-code-executed.png[Step carousel on a pa // What info it includes Scroll down to dig into the steps in this journey run. -Click the image:images/icons/arrowRight.svg[Arrow right icon] icon next to the step number to show details. +Click the {icon-arrowRight} icon next to the step number to show details. The details include metrics for the step in the current run and the step in the last successful run. Read more about step-level metrics below in <> and <>. @@ -199,14 +199,14 @@ when trying to diagnose the reason it failed. image:images/synthetics-analyze-one-run-compare-steps.png[Step list on a page detailing one run of a browser monitor in the {synthetics-app}] Drill down to see even more details for an individual step by clicking the performance breakdown icon -(image:images/icons/apmTrace.svg[Performance breakdown icon]) next to one of the steps. +({icon-apmTrace}) next to one of the steps. This will take you to the view described below in <>. [discrete] [[synthetics-analyze-one-step]] == Details for one step -After clicking the performance breakdown icon (image:images/icons/apmTrace.svg[Performance breakdown icon]) +After clicking the performance breakdown icon ({icon-apmTrace}) you'll see more detail for an individual step. [discrete] @@ -251,9 +251,9 @@ the resource loading process for the step including: * *Send*: The time spent sending the request data to the server. Next to each network timing metric, there's an icon that indicates whether the value is -higher (image:images/icons/sortUp.svg[Value is higher icon]), -lower (image:images/icons/sortDown.svg[Value is lower icon]), -or the same (image:images/icons/minus.svg[Value is the same]) +higher ({icon-sortUp}), +lower ({icon-sortDown}), +or the same ({icon-minus}) compared to the median of all runs in the last 24 hours. Hover over the icon to see more details in a tooltip. @@ -295,9 +295,9 @@ that help categorize good and bad sites by quantifying the real-world user exper ==== Next to each metric, there's an icon that indicates whether the value is -higher (image:images/icons/sortUp.svg[Value is higher icon]), -lower (image:images/icons/sortDown.svg[Value is lower icon]), -or the same (image:images/icons/minus.svg[Value is the same]) +higher ({icon-sortUp}), +lower ({icon-sortDown}), +or the same ({icon-minus}) compared to all runs over the last 24 hours. Hover over the icon to see more details in a tooltip. @@ -353,7 +353,7 @@ On the waterfall chart, select a resource name, or any part of each row, to display the resource details overlay. For additional analysis, whether to check the content of a CSS file or to view a specific image, -click the image:images/icons/popout.svg[External link icon] icon located beside each resource, +click the {icon-popout} icon located beside each resource, to view its content in a new tab. You can also navigate between steps and checks at the top of the page to diff --git a/docs/en/observability/threshold-alert.asciidoc b/docs/en/observability/threshold-alert.asciidoc index 11beeae8b2..c8a3b193c2 100644 --- a/docs/en/observability/threshold-alert.asciidoc +++ b/docs/en/observability/threshold-alert.asciidoc @@ -141,7 +141,7 @@ Keep in mind that no notifications are sent in this case because there is still If a host (for example, `host-1`) is decommissioned, you probably no longer want to see "no data" alerts about it. To mark an alert as untracked: -Go to the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon to expand the "More actions" menu, and click *Mark as untracked*. +Go to the Alerts table, click the {icon-boxesHorizontal} icon to expand the "More actions" menu, and click *Mark as untracked*. **** [discrete] diff --git a/docs/en/observability/triage-slo-burn-rate-breaches.asciidoc b/docs/en/observability/triage-slo-burn-rate-breaches.asciidoc index 2fd77eb6e8..ebd96c56fc 100644 --- a/docs/en/observability/triage-slo-burn-rate-breaches.asciidoc +++ b/docs/en/observability/triage-slo-burn-rate-breaches.asciidoc @@ -10,7 +10,7 @@ When this happens, you are at risk of exhausting your error budget and violating To triage issues quickly, go to the alert details page: . Go to **{observability}** → **Alerts** (or open the SLO and click **Alerts**). -. From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon next to the alert and select **View alert details**. +. From the Alerts table, click the {icon-boxesHorizontal} icon next to the alert and select **View alert details**. The alert details page shows information about the alert, including when the alert was triggered, the duration of the alert, the source SLO, and the rule that triggered the alert. @@ -43,7 +43,7 @@ NOTE: The contents of the alert details page may vary depending on the type of S After investigating the alert, you may want to: * Click **Snooze the rule** to snooze notifications for a specific time period or indefinitely. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Mark as untracked**. +* Click the {icon-boxesVertical} icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. +* Click the {icon-boxesVertical} icon and select **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules. diff --git a/docs/en/observability/triage-threshold-breaches.asciidoc b/docs/en/observability/triage-threshold-breaches.asciidoc index 83a56c6dc9..fec78ecc88 100644 --- a/docs/en/observability/triage-threshold-breaches.asciidoc +++ b/docs/en/observability/triage-threshold-breaches.asciidoc @@ -10,7 +10,7 @@ For example, you might have a custom threshold rule that triggers an alert when To triage issues quickly, go to the alert details page: . Go to **{observability}** → **Alerts**. -. From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon next to the alert and select **View alert details**. +. From the Alerts table, click the {icon-boxesHorizontal} icon next to the alert and select **View alert details**. The alert details page shows information about the alert, including when the alert was triggered, the duration of the alert, and the last status update. @@ -54,7 +54,7 @@ state, and how the issue is trending. After investigating the alert, you may want to: * Click **Snooze the rule** to snooze notifications for a specific time period or indefinitely. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Mark as untracked**. +* Click the {icon-boxesVertical} icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. +* Click the {icon-boxesVertical} icon and select **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules. diff --git a/docs/en/observability/view-observability-alerts.asciidoc b/docs/en/observability/view-observability-alerts.asciidoc index 9411c94fad..55035e4fde 100644 --- a/docs/en/observability/view-observability-alerts.asciidoc +++ b/docs/en/observability/view-observability-alerts.asciidoc @@ -33,7 +33,7 @@ By default, this filter is set to *Show all* alerts, but you can filter to show An alert is "Active" when the condition defined in the rule currently matches. An alert has "Recovered" when that condition, which previously matched, is currently no longer matching. An alert is "Untracked" when its corresponding rule is disabled or you mark the alert as untracked. -To mark the alert as untracked, go to the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon to expand the "More actions" menu, and click *Mark as untracked*. +To mark the alert as untracked, go to the Alerts table, click the {icon-boxesHorizontal} icon to expand the "More actions" menu, and click *Mark as untracked*. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules. @@ -57,17 +57,17 @@ image::view-alert-details.png[View alert details flyout on the Alerts page] To further inspect the alert: * From the alert detail flyout, click *Alert details*. -* From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon and select *View alert details*. +* From the Alerts table, click the {icon-boxesHorizontal} icon and select *View alert details*. To further inspect the rule: * From the alert detail flyout, click *View rule details*. -* From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon and select *View rule details*. +* From the Alerts table, click the {icon-boxesHorizontal} icon and select *View rule details*. To view the alert in the app that triggered it: * From the alert detail flyout, click *View in app*. -* From the Alerts table, click the image:images/icons/eye.svg[View in app] icon. +* From the Alerts table, click the {icon-eye} icon. [discrete] [[customize-observability-alerts-table]] @@ -91,7 +91,7 @@ You can also use the toolbar buttons in the upper-right to customize the display [[cases-observability-alerts]] == Add alerts to cases -From the Alerts table, you can add one or more alerts to a case. Click the image:images/icons/boxesHorizontal.svg[More actions] icon +From the Alerts table, you can add one or more alerts to a case. Click the {icon-boxesHorizontal} icon to add the alert to a new or existing case. NOTE: Each case can have a maximum of 1,000 alerts. diff --git a/docs/en/serverless/alerting/aiops-generate-anomaly-alerts.asciidoc b/docs/en/serverless/alerting/aiops-generate-anomaly-alerts.asciidoc index 82b755e2ef..afcf2558c5 100644 --- a/docs/en/serverless/alerting/aiops-generate-anomaly-alerts.asciidoc +++ b/docs/en/serverless/alerting/aiops-generate-anomaly-alerts.asciidoc @@ -118,7 +118,7 @@ image::images/alert-anomaly-action-frequency-recovered.png[Choose between anomal [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] diff --git a/docs/en/serverless/alerting/alerting.asciidoc b/docs/en/serverless/alerting/alerting.asciidoc index 3aec064467..8153d3980d 100644 --- a/docs/en/serverless/alerting/alerting.asciidoc +++ b/docs/en/serverless/alerting/alerting.asciidoc @@ -27,7 +27,7 @@ On the **Alerts** page, the Alerts table provides a snapshot of alerts occurring [role="screenshot"] image::images/observability-alerts-overview.png[Summary of Alerts on the {obs-serverless} overview page] -You can filter this table by alert status or time period, customize the visible columns, and search for specific alerts (for example, alerts related to a specific service or environment) using KQL. Select **View alert detail** from the **More actions** menu image:images/icons/boxesHorizontal.svg[action menu], or click the Reason link for any alert to <> in detail, and you can then either **View in app** or **View rule details**. +You can filter this table by alert status or time period, customize the visible columns, and search for specific alerts (for example, alerts related to a specific service or environment) using KQL. Select **View alert detail** from the **More actions** menu {icon-boxesHorizontal}, or click the Reason link for any alert to <> in detail, and you can then either **View in app** or **View rule details**. [discrete] [[observability-alerting-next-steps]] diff --git a/docs/en/serverless/alerting/create-anomaly-alert-rule.asciidoc b/docs/en/serverless/alerting/create-anomaly-alert-rule.asciidoc index 2008ae5cf2..bb06a0ae1a 100644 --- a/docs/en/serverless/alerting/create-anomaly-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-anomaly-alert-rule.asciidoc @@ -79,7 +79,7 @@ image::images/alert-apm-action-frequency-recovered.png[Choose between threshold [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] diff --git a/docs/en/serverless/alerting/create-custom-threshold-alert-rule.asciidoc b/docs/en/serverless/alerting/create-custom-threshold-alert-rule.asciidoc index 94ca37d995..9ce4a43b2d 100644 --- a/docs/en/serverless/alerting/create-custom-threshold-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-custom-threshold-alert-rule.asciidoc @@ -145,7 +145,7 @@ Keep in mind that no notifications are sent in this case because there is still ==== If a host (for example, `host-1`) is decommissioned, you probably no longer want to see "no data" alerts about it. To mark an alert as untracked: -Go to the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] icon to expand the "More actions" menu, and click _Mark as untracked_. +Go to the Alerts table, click the {icon-boxesHorizontal} icon to expand the "More actions" menu, and click _Mark as untracked_. ==== [discrete] @@ -192,7 +192,7 @@ image::images/logs-threshold-conditional-alert.png[Configure a conditional alert [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] diff --git a/docs/en/serverless/alerting/create-elasticsearch-query-alert-rule.asciidoc b/docs/en/serverless/alerting/create-elasticsearch-query-alert-rule.asciidoc index fe4011b2c8..8a0b45be1e 100644 --- a/docs/en/serverless/alerting/create-elasticsearch-query-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-elasticsearch-query-alert-rule.asciidoc @@ -168,7 +168,7 @@ You can further refine the conditions under which actions run by specifying that [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] diff --git a/docs/en/serverless/alerting/create-error-count-threshold-alert-rule.asciidoc b/docs/en/serverless/alerting/create-error-count-threshold-alert-rule.asciidoc index 5ca3da2198..8a3efcf801 100644 --- a/docs/en/serverless/alerting/create-error-count-threshold-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-error-count-threshold-alert-rule.asciidoc @@ -81,7 +81,7 @@ image::images/alert-apm-action-frequency-recovered.png[Choose between threshold [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] @@ -158,6 +158,6 @@ Based on the criteria above, define the following rule details: Next, select the **Email** connector and click **Create a connector**. Fill out the required details: sender, host, port, etc., and select **Save**. -A default message is provided as a starting point for your alert. You can use the Mustache template syntax (`{{variable}}`) to pass additional alert values at the time a condition is detected to an action. A list of available variables can be accessed by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable]. +A default message is provided as a starting point for your alert. You can use the Mustache template syntax (`{{variable}}`) to pass additional alert values at the time a condition is detected to an action. A list of available variables can be accessed by clicking the Add variable icon {icon-indexOpen}. Select **Save**. The alert has been created and is now active! diff --git a/docs/en/serverless/alerting/create-failed-transaction-rate-threshold-alert-rule.asciidoc b/docs/en/serverless/alerting/create-failed-transaction-rate-threshold-alert-rule.asciidoc index 187f6fbb12..bfe6612f3a 100644 --- a/docs/en/serverless/alerting/create-failed-transaction-rate-threshold-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-failed-transaction-rate-threshold-alert-rule.asciidoc @@ -81,7 +81,7 @@ image::images/alert-apm-action-frequency-recovered.png[Choose between threshold [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] @@ -153,6 +153,6 @@ Based on the criteria above, define the following rule details: Next, select the **Email** connector and click **Create a connector**. Fill out the required details: sender, host, port, etc., and select **Save**. -A default message is provided as a starting point for your alert. You can use the Mustache template syntax (`{{variable}}`) to pass additional alert values at the time a condition is detected to an action. A list of available variables can be accessed by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable]. +A default message is provided as a starting point for your alert. You can use the Mustache template syntax (`{{variable}}`) to pass additional alert values at the time a condition is detected to an action. A list of available variables can be accessed by clicking the Add variable icon {icon-indexOpen}. Select **Save**. The alert has been created and is now active! diff --git a/docs/en/serverless/alerting/create-inventory-threshold-alert-rule.asciidoc b/docs/en/serverless/alerting/create-inventory-threshold-alert-rule.asciidoc index 9db7772283..edff5e14a2 100644 --- a/docs/en/serverless/alerting/create-inventory-threshold-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-inventory-threshold-alert-rule.asciidoc @@ -103,7 +103,7 @@ image::images/conditional-alerts.png[Configure a conditional alert] [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] diff --git a/docs/en/serverless/alerting/create-latency-threshold-alert-rule.asciidoc b/docs/en/serverless/alerting/create-latency-threshold-alert-rule.asciidoc index 49eb9292cf..63f787ecb9 100644 --- a/docs/en/serverless/alerting/create-latency-threshold-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-latency-threshold-alert-rule.asciidoc @@ -84,7 +84,7 @@ image::images/alert-apm-action-frequency-recovered.png[Choose between threshold [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] diff --git a/docs/en/serverless/alerting/create-manage-rules.asciidoc b/docs/en/serverless/alerting/create-manage-rules.asciidoc index 2c9bfbefde..b4a8bd1497 100644 --- a/docs/en/serverless/alerting/create-manage-rules.asciidoc +++ b/docs/en/serverless/alerting/create-manage-rules.asciidoc @@ -68,7 +68,7 @@ Learn more about Observability rules and how to create them: You start by defining the rule and how often it should be evaluated. You can extend these rules by adding an appropriate action (for example, send an email or create an issue) to be triggered when the rule conditions are met. These actions are defined within each rule and implemented by the appropriate connector for that action e.g. Slack, Jira. You can create any rules from scratch using the **Manage Rules** page, or you can create specific rule types from their respective UIs and benefit from some of the details being pre-filled (for example, Name and Tags). * For APM alert types, you can select **Alerts and rules** and create rules directly from the **Services**, **Traces**, and **Dependencies** UIs. -* For SLO alert types, from the **SLOs** page open the **More actions** menu image:images/icons/boxesHorizontal.svg[action menu] for an SLO and select **Create new alert rule**. Alternatively, when you create a new SLO, the **Create new SLO burn rate alert rule** checkbox is enabled by default and will prompt you to <> upon saving the SLO. +* For SLO alert types, from the **SLOs** page open the **More actions** menu {icon-boxesHorizontal} for an SLO and select **Create new alert rule**. Alternatively, when you create a new SLO, the **Create new SLO burn rate alert rule** checkbox is enabled by default and will prompt you to <> upon saving the SLO. //// /* @@ -76,7 +76,7 @@ Clarify available Logs rule */ //// -After a rule is created, you can open the **More actions** menu image:images/icons/boxesHorizontal.svg[More actions] and select **Edit rule** to check or change the definition, and/or add or modify actions. +After a rule is created, you can open the **More actions** menu {icon-boxesHorizontal} and select **Edit rule** to check or change the definition, and/or add or modify actions. [role="screenshot"] image::images/alerts-edit-rule.png[Edit rule (failed transaction rate)] diff --git a/docs/en/serverless/alerting/create-slo-burn-rate-alert-rule.asciidoc b/docs/en/serverless/alerting/create-slo-burn-rate-alert-rule.asciidoc index 648c77e743..6d150f4277 100644 --- a/docs/en/serverless/alerting/create-slo-burn-rate-alert-rule.asciidoc +++ b/docs/en/serverless/alerting/create-slo-burn-rate-alert-rule.asciidoc @@ -27,7 +27,7 @@ image::images/slo-alerts-create-rule.png[Create rule for failed transaction rate [TIP] ==== These steps show how to use the **Alerts** UI. You can also create an SLO burn rate rule directly from **Observability** → **SLOs**. -Click the more options icon (image:images/icons/boxesVertical.svg[More options]) to the right of the SLO you want to add a burn rate rule for, and select **image:images/icons/bell.svg[Bell] Create new alert rule** from the menu. +Click the more options icon ({icon-boxesVertical}) to the right of the SLO you want to add a burn rate rule for, and select **{icon-bell} Create new alert rule** from the menu. When you use the UI to create an SLO, a default SLO burn rate alert rule is created automatically. The burn rate rule will use the default configuration and no connector. @@ -89,7 +89,7 @@ image::images/slo-action-frequency.png[Choose between severity or recovered] [%collapsible] ===== Use the default notification message or customize it. -You can add more context to the message by clicking the Add variable icon image:images/icons/indexOpen.svg[Add variable] and selecting from a list of available variables. +You can add more context to the message by clicking the Add variable icon {icon-indexOpen} and selecting from a list of available variables. [role="screenshot"] image::images/action-variables-popup.png[Action variables list] diff --git a/docs/en/serverless/alerting/triage-slo-burn-rate-breaches.asciidoc b/docs/en/serverless/alerting/triage-slo-burn-rate-breaches.asciidoc index 1ae5f51f82..78ab925565 100644 --- a/docs/en/serverless/alerting/triage-slo-burn-rate-breaches.asciidoc +++ b/docs/en/serverless/alerting/triage-slo-burn-rate-breaches.asciidoc @@ -16,7 +16,7 @@ When this happens, you are at risk of exhausting your error budget and violating To triage issues quickly, go to the alert details page: . In your Observability project, go to **Alerts** (or open the SLO and click **Alerts**.) -. From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] +. From the Alerts table, click the {icon-boxesHorizontal} icon next to the alert and select **View alert details**. The alert details page shows information about the alert, including when the alert was triggered, @@ -53,7 +53,7 @@ The contents of the alert details page may vary depending on the type of SLI tha After investigating the alert, you may want to: * Click **Snooze the rule** to snooze notifications for a specific time period or indefinitely. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Mark as untracked**. +* Click the {icon-boxesVertical} icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. +* Click the {icon-boxesVertical} icon and select **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules. diff --git a/docs/en/serverless/alerting/triage-threshold-breaches.asciidoc b/docs/en/serverless/alerting/triage-threshold-breaches.asciidoc index 2777c9e45e..c39003c303 100644 --- a/docs/en/serverless/alerting/triage-threshold-breaches.asciidoc +++ b/docs/en/serverless/alerting/triage-threshold-breaches.asciidoc @@ -14,7 +14,7 @@ For example, you might have a custom threshold rule that triggers an alert when To triage issues quickly, go to the alert details page: . In your Observability project, go to **Alerts**. -. From the Alerts table, click the image:images/icons/boxesHorizontal.svg[More actions] +. From the Alerts table, click the {icon-boxesHorizontal} icon next to the alert and select **View alert details**. The alert details page shows information about the alert, including when the alert was triggered, @@ -58,7 +58,7 @@ state, and how the issue is trending. After investigating the alert, you may want to: * Click **Snooze the rule** to snooze notifications for a specific time period or indefinitely. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. -* Click the image:images/icons/boxesVertical.svg[Actions] icon and select **Mark as untracked**. +* Click the {icon-boxesVertical} icon and select **Add to case** to add the alert to a new or existing case. To learn more, refer to <>. +* Click the {icon-boxesVertical} icon and select **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules. diff --git a/docs/en/serverless/alerting/view-alerts.asciidoc b/docs/en/serverless/alerting/view-alerts.asciidoc index abefb3d921..b796f404c7 100644 --- a/docs/en/serverless/alerting/view-alerts.asciidoc +++ b/docs/en/serverless/alerting/view-alerts.asciidoc @@ -64,7 +64,7 @@ The alert is switching repeatedly between active and recovered states. The conditions for the rule are no longer met and recovery actions should be generated. `untracked`:: -The corresponding rule is disabled or you've marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the image:images/icons/boxesHorizontal.svg[More actions] icon to expand the _More actions_ menu, and click **Mark as untracked**. +The corresponding rule is disabled or you've marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the {icon-boxesHorizontal} icon to expand the _More actions_ menu, and click **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules. @@ -83,12 +83,12 @@ If the rule has actions that run when the alert status changes, those actions ar To further inspect the rule: * From the alert detail flyout, click **View rule details**. -* From the **Alerts** table, click the image:images/icons/boxesHorizontal.svg[More actions] icon and select **View rule details**. +* From the **Alerts** table, click the {icon-boxesHorizontal} icon and select **View rule details**. To view the alert in the app that triggered it: * From the alert detail flyout, click **View in app**. -* From the **Alerts** table, click the image:images/icons/eye.svg[View in app] icon. +* From the **Alerts** table, click the {icon-eye} icon. [discrete] [[observability-view-alerts-customize-the-alerts-table]] @@ -113,7 +113,7 @@ You can also use the toolbar buttons in the upper-right to customize the display == Add alerts to cases From the **Alerts** table, you can add one or more alerts to a case. -Click the image:images/icons/boxesHorizontal.svg[More actions] icon to add the alert to a new or existing case. +Click the {icon-boxesHorizontal} icon to add the alert to a new or existing case. You can add an unlimited amount of alerts from any rule type. [NOTE] diff --git a/docs/en/serverless/apm/apm-send-traces-to-elastic.asciidoc b/docs/en/serverless/apm/apm-send-traces-to-elastic.asciidoc index ac33f576db..47c24747ab 100644 --- a/docs/en/serverless/apm/apm-send-traces-to-elastic.asciidoc +++ b/docs/en/serverless/apm/apm-send-traces-to-elastic.asciidoc @@ -14,7 +14,7 @@ include::../partials/roles.asciidoc[] [NOTE] ==== -image:images/icons/documentation.svg[documentation icon] Want to get started quickly? See <>. +{icon-documentation} Want to get started quickly? See <>. ==== Send APM data to Elastic with: diff --git a/docs/en/serverless/apm/apm-ui-trace-sample-timeline.asciidoc b/docs/en/serverless/apm/apm-ui-trace-sample-timeline.asciidoc index 8af33c6f32..eb85997ba8 100644 --- a/docs/en/serverless/apm/apm-ui-trace-sample-timeline.asciidoc +++ b/docs/en/serverless/apm/apm-ui-trace-sample-timeline.asciidoc @@ -67,7 +67,7 @@ image::images/spans/apm-distributed-tracing.png[Example view of the distributed Don't forget; by definition, a distributed trace includes more than one transaction. When viewing distributed traces in the timeline waterfall, -you'll see this icon: image:images/icons/merge.svg[Merge], +you'll see this icon: {icon-merge}, which indicates the next transaction in the trace. For easier problem isolation, transactions can be collapsed in the waterfall by clicking the icon to the left of the transactions. diff --git a/docs/en/serverless/cases/create-manage-cases.asciidoc b/docs/en/serverless/cases/create-manage-cases.asciidoc index f0084fb7d5..547539fc0d 100644 --- a/docs/en/serverless/cases/create-manage-cases.asciidoc +++ b/docs/en/serverless/cases/create-manage-cases.asciidoc @@ -42,7 +42,7 @@ If there are no connectors listed, you can <>** +**{icon-documentation} Learn more in <>** [discrete] [[observability-correlate-application-logs-ecs-formatted-logs]] @@ -70,7 +70,7 @@ Add ECS logging plugins to your logging libraries to format your logs into ECS-c To use ECS logging, you need to modify your application and its log configuration. -**image:images/icons/documentation.svg[documentation icon] Learn more in <>** +**{icon-documentation} Learn more in <>** [discrete] [[observability-correlate-application-logs-apm-agent-log-reformatting]] @@ -85,7 +85,7 @@ This feature is supported for the following {apm-agent}s: * {apm-py-ref}/logs.html#log-reformatting[Python] * {apm-java-ref}/logs.html#log-reformatting[Java] -**image:images/icons/documentation.svg[documentation icon] Learn more in <>** +**{icon-documentation} Learn more in <>** [discrete] [[observability-correlate-application-logs-apm-agent-log-sending]] @@ -95,7 +95,7 @@ Automatically capture and send logs directly to the managed intake service using Log sending is supported in the Java {apm-agent}. -**image:images/icons/documentation.svg[documentation icon] Learn more in <>** +**{icon-documentation} Learn more in <>** [discrete] [[observability-correlate-application-logs-log-correlation]] diff --git a/docs/en/serverless/logging/ecs-application-logs.asciidoc b/docs/en/serverless/logging/ecs-application-logs.asciidoc index 4f68847b87..ce035760ca 100644 --- a/docs/en/serverless/logging/ecs-application-logs.asciidoc +++ b/docs/en/serverless/logging/ecs-application-logs.asciidoc @@ -98,7 +98,7 @@ output.elasticsearch: api_key: "id:api_key" ---- -. Set the `hosts` to your project's {es} endpoint. Locate your project's endpoint by clicking the help icon (image:images/icons/help.svg[Help icon]) and selecting **Endpoints**. Add the **{es} endpoint** to your configuration. +. Set the `hosts` to your project's {es} endpoint. Locate your project's endpoint by clicking the help icon ({icon-help}) and selecting **Endpoints**. Add the **{es} endpoint** to your configuration. . From **Developer tools**, run the following command to create an API key that grants `manage` permissions for the `cluster` and the `filebeat-*` indices using: + [source,shell] diff --git a/docs/en/serverless/logging/plaintext-application-logs.asciidoc b/docs/en/serverless/logging/plaintext-application-logs.asciidoc index 8d1d444f6d..7e8554f91f 100644 --- a/docs/en/serverless/logging/plaintext-application-logs.asciidoc +++ b/docs/en/serverless/logging/plaintext-application-logs.asciidoc @@ -60,7 +60,7 @@ output.elasticsearch: api_key: "id:api_key" ---- -. Set the `hosts` to your project's {es} endpoint. Locate your project's endpoint by clicking the help icon (image:images/icons/help.svg[Help icon]) and selecting **Endpoints**. Add the **{es} endpoint** to your configuration. +. Set the `hosts` to your project's {es} endpoint. Locate your project's endpoint by clicking the help icon ({icon-help}) and selecting **Endpoints**. Add the **{es} endpoint** to your configuration. . From **Developer tools**, run the following command to create an API key that grants `manage` permissions for the `cluster` and the `filebeat-*` indices using: + [source,shell] diff --git a/docs/en/serverless/logging/troubleshoot-logs.asciidoc b/docs/en/serverless/logging/troubleshoot-logs.asciidoc index 2d025616f1..b1af6d3e57 100644 --- a/docs/en/serverless/logging/troubleshoot-logs.asciidoc +++ b/docs/en/serverless/logging/troubleshoot-logs.asciidoc @@ -63,7 +63,7 @@ Failed to connect to {host} port {port} after 0 ms: Connection refused [[observability-troubleshoot-logs-solution-1]] === Solution -The host needs access to your project. Port `443` must be open and the project's {es} endpoint must be reachable. You can locate your project's endpoint by clicking the help icon (image:images/icons/help.svg[Help icon]) and selecting **Endpoints**. Run the following command, replacing the URL with your endpoint, and you should get an authentication error with more details on resolving your issue: +The host needs access to your project. Port `443` must be open and the project's {es} endpoint must be reachable. You can locate your project's endpoint by clicking the help icon ({icon-help}) and selecting **Endpoints**. Run the following command, replacing the URL with your endpoint, and you should get an authentication error with more details on resolving your issue: [source,shell] ---- diff --git a/docs/en/serverless/logging/view-and-monitor-logs.asciidoc b/docs/en/serverless/logging/view-and-monitor-logs.asciidoc index 251f531370..54fc29167f 100644 --- a/docs/en/serverless/logging/view-and-monitor-logs.asciidoc +++ b/docs/en/serverless/logging/view-and-monitor-logs.asciidoc @@ -52,35 +52,35 @@ Refer to the {kibana-ref}/discover.html[Discover] documentation for more informa The actions column provides access to additional information about your logs. -**Expand:** (image:images/icons/expand.svg[expand icon]) Open the log details to get an in-depth look at an individual log file. +**Expand:** ({icon-expand}) Open the log details to get an in-depth look at an individual log file. -**Degraded document indicator:** (image:images/icons/pagesSelect.svg[degraded document indicator icon]) Shows if any of the document's fields were ignored when it was indexed. +**Degraded document indicator:** ({icon-pagesSelect}) Shows if any of the document's fields were ignored when it was indexed. Ignored fields could indicate malformed fields or other issues with your document. Use this information to investigate and determine why fields are being ignored. -**Stacktrace indicator:** (image:images/icons/apmTrace.svg[stacktrace indicator icon]) Shows if the document contains stack traces. +**Stacktrace indicator:** ({icon-apmTrace}) Shows if the document contains stack traces. This indicator makes it easier to navigate through your documents and know if they contain additional information in the form of stack traces. [discrete] [[observability-discover-and-explore-logs-view-log-details]] == View log details -Click the expand icon (image:images/icons/expand.svg[expand icon]) in the **Actions** column to get an in-depth look at an individual log file. +Click the expand icon ({icon-expand}) in the **Actions** column to get an in-depth look at an individual log file. These details provide immediate feedback and context for what's happening and where it's happening for each log. From here, you can quickly debug errors and investigate the services where errors have occurred. The following actions help you filter and focus on specific fields in the log details: -* **Filter for value (image:images/icons/plusInCircle.svg[filter for value icon]):** Show logs that contain the specific field value. -* **Filter out value (image:images/icons/minusInCircle.svg[filter out value icon]):** Show logs that do _not_ contain the specific field value. -* **Filter for field present (image:images/icons/filter.svg[filter for present icon]):** Show logs that contain the specific field. -* **Toggle column in table (image:images/icons/listAdd.svg[toggle column in table icon]):** Add or remove a column for the field to the main Logs Explorer table. +* **Filter for value ({icon-plusInCircle}):** Show logs that contain the specific field value. +* **Filter out value ({icon-minusInCircle}):** Show logs that do _not_ contain the specific field value. +* **Filter for field present ({icon-filter}):** Show logs that contain the specific field. +* **Toggle column in table ({icon-listAdd}):** Add or remove a column for the field to the main Logs Explorer table. [discrete] [[observability-discover-and-explore-logs-view-log-quality-issues]] == View log quality issues -From the log details of a document with ignored fields, as shown by the degraded document indicator ((image:images/icons/pagesSelect.svg[degraded document indicator icon])), expand the **Quality issues** section to see the name and value of the fields that were ignored. +From the log details of a document with ignored fields, as shown by the degraded document indicator (({icon-pagesSelect})), expand the **Quality issues** section to see the name and value of the fields that were ignored. Select **Data set details** to open the **Data Set Quality** page. Here you can monitor your data sets and investigate any issues. The **Data Set Details** page is also accessible from **Project settings** → **Management** → **Data Set Quality**. diff --git a/docs/en/serverless/monitor-datasets.asciidoc b/docs/en/serverless/monitor-datasets.asciidoc index a6a17b7297..2724979fe2 100644 --- a/docs/en/serverless/monitor-datasets.asciidoc +++ b/docs/en/serverless/monitor-datasets.asciidoc @@ -46,7 +46,7 @@ Open a logs data set in Logs Explorer or other data set types in Discover to fin To open the details page for a data set with poor or degraded quality and view ignored fields: -. From the data set table, click image:images/icons/expand.svg[expand icon] next to a data set with poor or degraded quality. +. From the data set table, click {icon-expand} next to a data set with poor or degraded quality. . From the details, scroll down to **Quality issues**. The **Quality issues** section shows fields that have been ignored, the number of documents that contain ignored fields, and the timestamp of last occurrence of the field being ignored. @@ -61,11 +61,11 @@ To use Logs Explorer or Discover to find ignored fields in individual logs: . Click the percentage in the **Degraded Docs** column to open the data set in Logs Explorer or Discover. The **Documents** table in Logs Explorer or Discover is automatically filtered to show documents that were not parsed correctly. -Under the **actions** column, you'll find the degraded document icon (image:images/icons/indexClose.svg[degraded document icon]). +Under the **actions** column, you'll find the degraded document icon ({icon-indexClose}). Now that you know which documents contain ignored fields, examine them more closely to find the origin of the issue: -. Under the **actions** column, click image:images/icons/expand.svg[expand icon] to open the document details. +. Under the **actions** column, click {icon-expand} to open the document details. . Select the **JSON** tab. . Scroll towards the end of the JSON to find the `ignored_field_values`. diff --git a/docs/en/serverless/slos/slos.asciidoc b/docs/en/serverless/slos/slos.asciidoc index 98004edd0c..dd524f135c 100644 --- a/docs/en/serverless/slos/slos.asciidoc +++ b/docs/en/serverless/slos/slos.asciidoc @@ -62,7 +62,7 @@ You can apply searches and filters to quickly find the SLOs you're interested in [role="screenshot"] image::images/slo-filtering-options.png[Options for filtering SLOs in the overview] -* **Apply structured filters:** Next to the search field, click the **Add filter** image:images/icons/plusInCircleFilled.svg[Add filter icon] icon to add a custom filter. Notice that you can use `OR` and `AND` to combine filters. The structured filter can be disabled, inverted, or pinned across all apps. +* **Apply structured filters:** Next to the search field, click the **Add filter** {icon-plusInCircleFilled} icon to add a custom filter. Notice that you can use `OR` and `AND` to combine filters. The structured filter can be disabled, inverted, or pinned across all apps. * **Enter a semi-structured search:** In the search field, start typing a field name to get suggestions for field names and operators that you can use to build a structured query. The semi-structured search will filter SLOs for matches, and only return matching SLOs. * Use the **Status** and **Tags** menus to include or exclude SLOs from the view based on the status or defined tags. @@ -73,7 +73,7 @@ image::images/slo-group-by.png[SLOs sorted by SLO status and grouped by tags] * **Sort by**: SLI value, SLO status, Error budget consumed, or Error budget remaining. * **Group by**: None, Tags, Status, or SLI type. -* Click icons to switch between a card view (image:images/icons/apps.svg[Card view icon]), list view (image:images/icons/list.svg[List view icon]), or compact view (image:images/icons/tableDensityCompact.svg[Compact view icon]]). +* Click icons to switch between a card view ({icon-apps}), list view ({icon-list}), or compact view ({icon-tableDensityCompact}). [discrete] [[observability-slos-slo-dashboard-panels]] diff --git a/docs/en/serverless/synthetics/synthetics-analyze.asciidoc b/docs/en/serverless/synthetics/synthetics-analyze.asciidoc index 3e64b23f77..a6db945ecd 100644 --- a/docs/en/serverless/synthetics/synthetics-analyze.asciidoc +++ b/docs/en/serverless/synthetics/synthetics-analyze.asciidoc @@ -55,7 +55,7 @@ page you'll see: multiple locations, you'll also see a down arrow icon that you can use to quickly move between locations that use the same configuration. * The latest **status** and when the monitor was **last run**. -* The **image:images/icons/beaker.svg[Experiment] Run test manually** button that allows you to run the test on +* The **{icon-beaker} Run test manually** button that allows you to run the test on demand before the next scheduled run. + [NOTE] @@ -63,7 +63,7 @@ demand before the next scheduled run. This is only available for monitors running on Elastic's global managed testing infrastructure. It is not available for monitors running on {private-location}s. ==== -* The **image:images/icons/pencil.svg[Edit] Edit monitor** button that allows you to edit the monitor's +* The **{icon-pencil} Edit monitor** button that allows you to edit the monitor's configuration. [role="screenshot"] @@ -90,7 +90,7 @@ image::images/synthetics-analyze-individual-monitor-details.png[Details in the O The **History** tab has information on every time the monitor has run. It includes some high-level stats and a complete list of all test runs. -Use the calendar icon (image:images/icons/calendar.svg[Calendar]) and search bar +Use the calendar icon ({icon-calendar}) and search bar to filter for runs that occurred in a specific time period. // What you might do with this info @@ -106,7 +106,7 @@ image::images/synthetics-analyze-individual-monitor-history.png[The History tab If the monitor is configured to <>, you'll see retests listed in the **Test runs** table. Runs that are retests include a -rerun icon (image:images/icons/refresh.svg[Refresh icon]) next to the result badge. +rerun icon ({icon-refresh}) next to the result badge. [role="screenshot"] image::images/synthetics-retest.png[A failed run and a retest in the table of test runs in the Synthetics UI] @@ -121,7 +121,7 @@ failed runs will only result in an error if both the initial run and the rerun f This can reduce noise related to transient problems. The Errors tab includes a high-level overview of all alerts and a complete list of all failures. -Use the calendar icon (image:images/icons/calendar.svg[Calendar]) and search bar +Use the calendar icon ({icon-calendar}) and search bar to filter for runs that occurred in a specific time period. // What you might do with this info @@ -161,11 +161,11 @@ image::images/synthetics-analyze-journeys-over-time.png[Individual journey page From here, you can either drill down into: -* The latest run of the full journey by clicking **image:images/icons/inspect.svg[Inspect] View test run** +* The latest run of the full journey by clicking **{icon-inspect} View test run** or a past run in the list of **Last 10 test runs**. This will take you to the view described below in <>. * An individual step in this run by clicking the performance breakdown icon -(image:images/icons/apmTrace.svg[APM trace]) next to one of the steps. +({icon-apmTrace}) next to one of the steps. This will take you to the view described below in <>. [discrete] @@ -181,8 +181,8 @@ At the top of the page, see the _Code executed_ and any _Console_ output for eac If the step failed, this will also include a _Stacktrace_ tab that you can use to diagnose the cause of errors. -Navigate through each step using **image:images/icons/arrowLeft.svg[Previous] Previous** and -**Next image:images/icons/arrowRight.svg[Next]**. +Navigate through each step using **{icon-arrowLeft} Previous** and +**Next {icon-arrowRight}**. // Screenshot of the viz @@ -192,7 +192,7 @@ image::images/synthetics-analyze-one-run-code-executed.png[Step carousel on a pa // What info it includes Scroll down to dig into the steps in this journey run. -Click the image:images/icons/arrowRight.svg[Next] icon next to the step number to show details. +Click the {icon-arrowRight} icon next to the step number to show details. The details include metrics for the step in the current run and the step in the last successful run. Read more about step-level metrics below in <> and <>. @@ -208,14 +208,14 @@ when trying to diagnose the reason it failed. image::images/synthetics-analyze-one-run-compare-steps.png[Step list on a page detailing one run of a browser monitor in the Synthetics UI] Drill down to see even more details for an individual step by clicking the performance breakdown icon -(image:images/icons/apmTrace.svg[APM trace]) next to one of the steps. +({icon-apmTrace}) next to one of the steps. This will take you to the view described below in <>. [discrete] [[synthetics-analyze-one-step]] === Details for one step -After clicking the performance breakdown icon (image:images/icons/apmTrace.svg[APM trace]) +After clicking the performance breakdown icon ({icon-apmTrace}) you'll see more detail for an individual step. [discrete] @@ -263,9 +263,9 @@ which can be impacted by the size of the response. * **Send**: The time spent sending the request data to the server. Next to each network timing metric, there's an icon that indicates whether the value is -higher (image:images/icons/sortUp.svg[Arrow up]), -lower (image:images/icons/sortDown.svg[Arrow down]), -or the same (image:images/icons/minus.svg[Minus]) +higher ({icon-sortUp}), +lower ({icon-sortDown}), +or the same ({icon-minus}) compared to the median of all runs in the last 24 hours. Hover over the icon to see more details in a tooltip. @@ -310,9 +310,9 @@ that help categorize good and bad sites by quantifying the real-world user exper ==== Next to each metric, there's an icon that indicates whether the value is -higher (image:images/icons/sortUp.svg[Arrow up]), -lower (image:images/icons/sortDown.svg[Arrow down]), -or the same (image:images/icons/minus.svg[Minus]) +higher ({icon-sortUp}), +lower ({icon-sortDown}), +or the same ({icon-minus}) compared to all runs over the last 24 hours. Hover over the icon to see more details in a tooltip. @@ -374,7 +374,7 @@ On the waterfall chart, select a resource name, or any part of each row, to display the resource details overlay. For additional analysis, whether to check the content of a CSS file or to view a specific image, -click the image:images/icons/popout.svg[Popout] icon located beside each resource, +click the {icon-popout} icon located beside each resource, to view its content in a new tab. You can also navigate between steps and checks at the top of the page to From c39027b9489625c3a0fe87190d24d72984ba8997 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Fri, 8 Nov 2024 16:51:15 -0600 Subject: [PATCH 2/2] delete local icons --- docs/en/observability/images/icons/addFilter.svg | 1 - docs/en/observability/images/icons/ai-assistant-bw.svg | 1 - docs/en/observability/images/icons/ai-assistant.svg | 1 - docs/en/observability/images/icons/apmTrace.svg | 1 - docs/en/observability/images/icons/apps.svg | 1 - docs/en/observability/images/icons/arrowLeft.svg | 1 - docs/en/observability/images/icons/arrowRight.svg | 1 - docs/en/observability/images/icons/beaker.svg | 1 - docs/en/observability/images/icons/boxesHorizontal.svg | 1 - docs/en/observability/images/icons/boxesVertical.svg | 1 - docs/en/observability/images/icons/calendar.svg | 1 - docs/en/observability/images/icons/check.svg | 1 - docs/en/observability/images/icons/cross.svg | 1 - docs/en/observability/images/icons/eye.svg | 1 - docs/en/observability/images/icons/inspect.svg | 1 - docs/en/observability/images/icons/list.svg | 1 - docs/en/observability/images/icons/minus.svg | 1 - docs/en/observability/images/icons/pencil.svg | 1 - docs/en/observability/images/icons/popout.svg | 1 - docs/en/observability/images/icons/questionInCircle.svg | 1 - docs/en/observability/images/icons/refresh.svg | 1 - docs/en/observability/images/icons/sortDown.svg | 1 - docs/en/observability/images/icons/sortUp.svg | 1 - docs/en/observability/images/icons/tableDensityCompact.svg | 1 - 24 files changed, 24 deletions(-) delete mode 100644 docs/en/observability/images/icons/addFilter.svg delete mode 100644 docs/en/observability/images/icons/ai-assistant-bw.svg delete mode 100644 docs/en/observability/images/icons/ai-assistant.svg delete mode 100644 docs/en/observability/images/icons/apmTrace.svg delete mode 100644 docs/en/observability/images/icons/apps.svg delete mode 100644 docs/en/observability/images/icons/arrowLeft.svg delete mode 100644 docs/en/observability/images/icons/arrowRight.svg delete mode 100644 docs/en/observability/images/icons/beaker.svg delete mode 100644 docs/en/observability/images/icons/boxesHorizontal.svg delete mode 100644 docs/en/observability/images/icons/boxesVertical.svg delete mode 100644 docs/en/observability/images/icons/calendar.svg delete mode 100644 docs/en/observability/images/icons/check.svg delete mode 100644 docs/en/observability/images/icons/cross.svg delete mode 100644 docs/en/observability/images/icons/eye.svg delete mode 100644 docs/en/observability/images/icons/inspect.svg delete mode 100644 docs/en/observability/images/icons/list.svg delete mode 100644 docs/en/observability/images/icons/minus.svg delete mode 100644 docs/en/observability/images/icons/pencil.svg delete mode 100644 docs/en/observability/images/icons/popout.svg delete mode 100644 docs/en/observability/images/icons/questionInCircle.svg delete mode 100644 docs/en/observability/images/icons/refresh.svg delete mode 100644 docs/en/observability/images/icons/sortDown.svg delete mode 100644 docs/en/observability/images/icons/sortUp.svg delete mode 100644 docs/en/observability/images/icons/tableDensityCompact.svg diff --git a/docs/en/observability/images/icons/addFilter.svg b/docs/en/observability/images/icons/addFilter.svg deleted file mode 100644 index 5da375f4ec..0000000000 --- a/docs/en/observability/images/icons/addFilter.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/en/observability/images/icons/ai-assistant-bw.svg b/docs/en/observability/images/icons/ai-assistant-bw.svg deleted file mode 100644 index 06896113e4..0000000000 --- a/docs/en/observability/images/icons/ai-assistant-bw.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/ai-assistant.svg b/docs/en/observability/images/icons/ai-assistant.svg deleted file mode 100644 index ac51eccb68..0000000000 --- a/docs/en/observability/images/icons/ai-assistant.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/apmTrace.svg b/docs/en/observability/images/icons/apmTrace.svg deleted file mode 100644 index 800b8e51a4..0000000000 --- a/docs/en/observability/images/icons/apmTrace.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/apps.svg b/docs/en/observability/images/icons/apps.svg deleted file mode 100644 index ad6f7baf1f..0000000000 --- a/docs/en/observability/images/icons/apps.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/arrowLeft.svg b/docs/en/observability/images/icons/arrowLeft.svg deleted file mode 100644 index d5956d01bb..0000000000 --- a/docs/en/observability/images/icons/arrowLeft.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/arrowRight.svg b/docs/en/observability/images/icons/arrowRight.svg deleted file mode 100644 index b2d76bddc2..0000000000 --- a/docs/en/observability/images/icons/arrowRight.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/beaker.svg b/docs/en/observability/images/icons/beaker.svg deleted file mode 100644 index 05eb97809c..0000000000 --- a/docs/en/observability/images/icons/beaker.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/boxesHorizontal.svg b/docs/en/observability/images/icons/boxesHorizontal.svg deleted file mode 100644 index d845a6b9db..0000000000 --- a/docs/en/observability/images/icons/boxesHorizontal.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/boxesVertical.svg b/docs/en/observability/images/icons/boxesVertical.svg deleted file mode 100644 index aed10b0d8e..0000000000 --- a/docs/en/observability/images/icons/boxesVertical.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/calendar.svg b/docs/en/observability/images/icons/calendar.svg deleted file mode 100644 index ed311de10c..0000000000 --- a/docs/en/observability/images/icons/calendar.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/check.svg b/docs/en/observability/images/icons/check.svg deleted file mode 100644 index 1145dd301d..0000000000 --- a/docs/en/observability/images/icons/check.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/cross.svg b/docs/en/observability/images/icons/cross.svg deleted file mode 100644 index 82df3e03d3..0000000000 --- a/docs/en/observability/images/icons/cross.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/eye.svg b/docs/en/observability/images/icons/eye.svg deleted file mode 100644 index 0e576f21d5..0000000000 --- a/docs/en/observability/images/icons/eye.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/inspect.svg b/docs/en/observability/images/icons/inspect.svg deleted file mode 100644 index 43374b4aa4..0000000000 --- a/docs/en/observability/images/icons/inspect.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/list.svg b/docs/en/observability/images/icons/list.svg deleted file mode 100644 index 52e8e7acd1..0000000000 --- a/docs/en/observability/images/icons/list.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/minus.svg b/docs/en/observability/images/icons/minus.svg deleted file mode 100644 index 763922a916..0000000000 --- a/docs/en/observability/images/icons/minus.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/pencil.svg b/docs/en/observability/images/icons/pencil.svg deleted file mode 100644 index cb16b5d2f0..0000000000 --- a/docs/en/observability/images/icons/pencil.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/popout.svg b/docs/en/observability/images/icons/popout.svg deleted file mode 100644 index 875bf6662d..0000000000 --- a/docs/en/observability/images/icons/popout.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/questionInCircle.svg b/docs/en/observability/images/icons/questionInCircle.svg deleted file mode 100644 index b715f289ad..0000000000 --- a/docs/en/observability/images/icons/questionInCircle.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/refresh.svg b/docs/en/observability/images/icons/refresh.svg deleted file mode 100644 index 58662be4af..0000000000 --- a/docs/en/observability/images/icons/refresh.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/sortDown.svg b/docs/en/observability/images/icons/sortDown.svg deleted file mode 100644 index 7efa30e917..0000000000 --- a/docs/en/observability/images/icons/sortDown.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/sortUp.svg b/docs/en/observability/images/icons/sortUp.svg deleted file mode 100644 index c5d0f004ad..0000000000 --- a/docs/en/observability/images/icons/sortUp.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/en/observability/images/icons/tableDensityCompact.svg b/docs/en/observability/images/icons/tableDensityCompact.svg deleted file mode 100644 index 9eabb5fe83..0000000000 --- a/docs/en/observability/images/icons/tableDensityCompact.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file