From 03f0337ebfb529372e32689034e49a20380c109a Mon Sep 17 00:00:00 2001 From: dedemorton Date: Fri, 23 Feb 2024 11:42:55 -0800 Subject: [PATCH 1/5] Make alerting navigation more consistent with serverless docs --- docs/en/observability/create-alerts.asciidoc | 29 ++++++++++--------- docs/en/observability/index.asciidoc | 1 + .../infrastructure-threshold-alert.asciidoc | 3 ++ docs/en/observability/logs-checklist.asciidoc | 2 +- .../logs-threshold-alert.asciidoc | 8 +++-- .../metrics-threshold-alert.asciidoc | 3 ++ .../monitor-status-alert.asciidoc | 9 ++++-- .../slo-burn-rate-alert.asciidoc | 3 +- .../en/observability/threshold-alert.asciidoc | 5 +++- .../uptime-duration-anomaly-alert.asciidoc | 7 +++-- .../observability/uptime-tls-alert.asciidoc | 7 +++-- 11 files changed, 51 insertions(+), 26 deletions(-) diff --git a/docs/en/observability/create-alerts.asciidoc b/docs/en/observability/create-alerts.asciidoc index 44c7043f13..17917ce4a2 100644 --- a/docs/en/observability/create-alerts.asciidoc +++ b/docs/en/observability/create-alerts.asciidoc @@ -15,8 +15,13 @@ Alerts and rules related to service level objectives (SLOs), and {observability} You can also manage {observability} app rules alongside rules for other apps from the {kibana-ref}/create-and-manage-rules.html[{kib} Management UI]. [discrete] +== Next steps + +* <> +* <> + [[create-alerts-rules]] -== Create rules +== Create and manage rules The first step when setting up alerts is to create a rule. To create and manage rules related to {observability} apps, @@ -56,14 +61,14 @@ tie into other third-party systems. Connectors allow actions to talk to these se Learn how to create specific types of rules: +* {kibana-ref}/apm-alerts.html[APM rules] * <> -* <> +* <> * <> * <> * <> * <> * <> -* {kibana-ref}/apm-alerts.html[APM rules] * <> [discrete] @@ -157,20 +162,18 @@ xpack.observability.unsafe.alertingExperience.enabled: 'false' ---- -include::threshold-alert.asciidoc[leveloffset=+1] - -include::logs-threshold-alert.asciidoc[leveloffset=+1] +include::threshold-alert.asciidoc[leveloffset=+2] -include::infrastructure-threshold-alert.asciidoc[leveloffset=+1] +include::logs-threshold-alert.asciidoc[leveloffset=+2] -include::metrics-threshold-alert.asciidoc[leveloffset=+1] +include::infrastructure-threshold-alert.asciidoc[leveloffset=+2] -include::monitor-status-alert.asciidoc[leveloffset=+1] +include::metrics-threshold-alert.asciidoc[leveloffset=+2] -include::uptime-tls-alert.asciidoc[leveloffset=+1] +include::monitor-status-alert.asciidoc[leveloffset=+2] -include::uptime-duration-anomaly-alert.asciidoc[leveloffset=+1] +include::uptime-tls-alert.asciidoc[leveloffset=+2] -include::slo-burn-rate-alert.asciidoc[leveloffset=+1] +include::uptime-duration-anomaly-alert.asciidoc[leveloffset=+2] -include::view-observability-alerts.asciidoc[leveloffset=+1] +include::slo-burn-rate-alert.asciidoc[leveloffset=+2] diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index ee11ec5473..60e1082ab7 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -172,6 +172,7 @@ include::profiling-self-managed-troubleshooting.asciidoc[leveloffset=+3] // Alerting include::create-alerts.asciidoc[leveloffset=+1] +include::view-observability-alerts.asciidoc[leveloffset=+2] //SLOs include::slo-overview.asciidoc[leveloffset=+1] diff --git a/docs/en/observability/infrastructure-threshold-alert.asciidoc b/docs/en/observability/infrastructure-threshold-alert.asciidoc index 83643643a9..c5105b6a73 100644 --- a/docs/en/observability/infrastructure-threshold-alert.asciidoc +++ b/docs/en/observability/infrastructure-threshold-alert.asciidoc @@ -1,5 +1,8 @@ [[infrastructure-threshold-alert]] = Create an infrastructure threshold rule +++++ +Infrastructure threshold +++++ Based on the resources listed on the *Inventory* page within the {infrastructure-app}, you can create a threshold rule to notify you when a metric has reached or exceeded a value for a specific diff --git a/docs/en/observability/logs-checklist.asciidoc b/docs/en/observability/logs-checklist.asciidoc index d16b7cf462..9f00a3153c 100644 --- a/docs/en/observability/logs-checklist.asciidoc +++ b/docs/en/observability/logs-checklist.asciidoc @@ -108,7 +108,7 @@ Refer to <>. [discrete] [[logs-alerts-checklist]] -== Create a logs threshold alert +== Create a log threshold alert You can create a rule to send an alert when the log aggregation exceeds a threshold. diff --git a/docs/en/observability/logs-threshold-alert.asciidoc b/docs/en/observability/logs-threshold-alert.asciidoc index da638a304b..e5b11118a2 100644 --- a/docs/en/observability/logs-threshold-alert.asciidoc +++ b/docs/en/observability/logs-threshold-alert.asciidoc @@ -1,5 +1,9 @@ [[logs-threshold-alert]] -= Create a logs threshold rule += Create a log threshold rule +++++ +Log threshold +++++ + . To access this page, go to **{observability}** -> **Logs**. . Click **Alerts and rules** -> **Create rule**. @@ -128,7 +132,7 @@ You can add more context to the message by clicking the icon above the message t and selecting from a list of available variables. [role="screenshot"] -image::images/logs-threshold-alert-default-message.png[Default notification message for logs threshold rules with open "Add variable" popup listing available action variables,width=600] +image::images/logs-threshold-alert-default-message.png[Default notification message for log threshold rules with open "Add variable" popup listing available action variables,width=600] [discrete] [[performance-considerations]] diff --git a/docs/en/observability/metrics-threshold-alert.asciidoc b/docs/en/observability/metrics-threshold-alert.asciidoc index b53ebf0cf1..fd99487fc3 100644 --- a/docs/en/observability/metrics-threshold-alert.asciidoc +++ b/docs/en/observability/metrics-threshold-alert.asciidoc @@ -1,5 +1,8 @@ [[metrics-threshold-alert]] = Create a metrics threshold rule +++++ +Metrics threshold +++++ Based on the metrics that are listed on the **Metrics Explorer** page within the {infrastructure-app}, you can create a threshold rule to notify you when a metric has reached or exceeded a value for a specific diff --git a/docs/en/observability/monitor-status-alert.asciidoc b/docs/en/observability/monitor-status-alert.asciidoc index ce00a65460..0515c7b681 100644 --- a/docs/en/observability/monitor-status-alert.asciidoc +++ b/docs/en/observability/monitor-status-alert.asciidoc @@ -1,8 +1,11 @@ [[monitor-status-alert]] = Create a monitor status rule +++++ +Monitor status +++++ Within the {uptime-app}, create a **Monitor Status** rule to receive notifications -based on errors and outages. +based on errors and outages. . To access this page, go to **{observability}** -> **Uptime**. . At the top of the page, click **Alerts and rules** -> **Create rule**. @@ -19,7 +22,7 @@ If you already have a query in the overview page search bar, it's populated here You can specify the following thresholds for your rule. -|=== +|=== | *Status check* | Receive alerts when a monitor goes down a specified number of times within a time range (seconds, minutes, hours, or days). @@ -27,7 +30,7 @@ times within a time range (seconds, minutes, hours, or days). | *Availability* | Receive alerts when a monitor goes below a specified availability threshold within a time range (days, weeks, months, or years). -|=== +|=== Let's create a rule for any monitor that shows `Down` more than three times in 10 minutes. diff --git a/docs/en/observability/slo-burn-rate-alert.asciidoc b/docs/en/observability/slo-burn-rate-alert.asciidoc index ca650a73d5..e90ac00638 100644 --- a/docs/en/observability/slo-burn-rate-alert.asciidoc +++ b/docs/en/observability/slo-burn-rate-alert.asciidoc @@ -1,8 +1,7 @@ [[slo-burn-rate-alert]] = Create a service-level objective (SLO) burn rate rule - ++++ -Create an SLO burn rate rule +SLO burn rate ++++ include::slo-overview.asciidoc[tag=slo-license] diff --git a/docs/en/observability/threshold-alert.asciidoc b/docs/en/observability/threshold-alert.asciidoc index af5d08647a..5246a74406 100644 --- a/docs/en/observability/threshold-alert.asciidoc +++ b/docs/en/observability/threshold-alert.asciidoc @@ -1,5 +1,8 @@ [[custom-threshold-alert]] = Create a custom threshold rule +++++ +Custom threshold +++++ Create a custom threshold rule to trigger an alert when an {observability} data type reaches or exceeds a given value. @@ -149,4 +152,4 @@ You can add more context to the message by clicking the icon above the message t and selecting from a list of available variables. [role="screenshot"] -image::images/logs-threshold-alert-default-message.png[Default notification message for logs threshold rules with open "Add variable" popup listing available action variables,width=600] +image::images/logs-threshold-alert-default-message.png[Default notification message for log threshold rules with open "Add variable" popup listing available action variables,width=600] diff --git a/docs/en/observability/uptime-duration-anomaly-alert.asciidoc b/docs/en/observability/uptime-duration-anomaly-alert.asciidoc index 7fff6e2024..848e237fe2 100644 --- a/docs/en/observability/uptime-duration-anomaly-alert.asciidoc +++ b/docs/en/observability/uptime-duration-anomaly-alert.asciidoc @@ -1,5 +1,8 @@ [[duration-anomaly-alert]] = Create an uptime duration anomaly rule +++++ +Uptime duration anomaly +++++ Within the {uptime-app}, create an *Uptime duration anomaly* rule to receive notifications based on the response durations for all of the geographic locations of each monitor. When a @@ -20,7 +23,7 @@ The _anomaly score_ is a value from `0` to `100`, which indicates the significan compared to previously seen anomalies. The highly anomalous values are shown in red and the low scored values are indicated in blue. -|=== +|=== | *warning* | Score `0` and above. @@ -30,7 +33,7 @@ red and the low scored values are indicated in blue. | *critical* | Score `75` and above. -|=== +|=== [role="screenshot"] image::images/response-durations-alert.png[Uptime response duration rule] diff --git a/docs/en/observability/uptime-tls-alert.asciidoc b/docs/en/observability/uptime-tls-alert.asciidoc index 72ec3da25e..75273cab3c 100644 --- a/docs/en/observability/uptime-tls-alert.asciidoc +++ b/docs/en/observability/uptime-tls-alert.asciidoc @@ -1,5 +1,8 @@ [[tls-certificate-alert]] = Create a TLS certificate rule +++++ +TLS certificate +++++ Within the {uptime-app}, you can create a rule that notifies you when one or more of your monitors has a TLS certificate expiring @@ -18,7 +21,7 @@ The threshold values for each condition are configurable on the You can specify the following thresholds for your rule. -|=== +|=== | *Expiration threshold* | The `expiration` threshold specifies when you are notified about certificates that are approaching expiration dates. @@ -26,7 +29,7 @@ about certificates that are approaching expiration dates. | *Age limit* | The `age` threshold specifies when you are notified about certificates that have been valid for too long. -|=== +|=== Let's create a rule to check every 6 hours and notify us when any of the TLS certificates on sites we're monitoring are close to expiring. From b8734cc99574c596ac7de71dab133383ca129bd6 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Fri, 23 Feb 2024 13:25:06 -0800 Subject: [PATCH 2/5] Update docs/en/observability/create-alerts.asciidoc --- docs/en/observability/create-alerts.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/create-alerts.asciidoc b/docs/en/observability/create-alerts.asciidoc index 17917ce4a2..c7e5329c88 100644 --- a/docs/en/observability/create-alerts.asciidoc +++ b/docs/en/observability/create-alerts.asciidoc @@ -65,7 +65,7 @@ Learn how to create specific types of rules: * <> * <> * <> -* <> +* <> * <> * <> * <> From c6c0b241b1c2d5b3f1a42ec578706ef748f6540f Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Fri, 23 Feb 2024 13:27:12 -0800 Subject: [PATCH 3/5] Apply suggestions from code review --- docs/en/observability/metrics-threshold-alert.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/metrics-threshold-alert.asciidoc b/docs/en/observability/metrics-threshold-alert.asciidoc index fd99487fc3..5dfe65b381 100644 --- a/docs/en/observability/metrics-threshold-alert.asciidoc +++ b/docs/en/observability/metrics-threshold-alert.asciidoc @@ -1,5 +1,5 @@ [[metrics-threshold-alert]] -= Create a metrics threshold rule += Create a metric threshold rule ++++ Metrics threshold ++++ From 70ee7e37ca409529a8a458ae16734772570385d5 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Fri, 23 Feb 2024 13:28:29 -0800 Subject: [PATCH 4/5] Update docs/en/observability/metrics-threshold-alert.asciidoc --- docs/en/observability/metrics-threshold-alert.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/metrics-threshold-alert.asciidoc b/docs/en/observability/metrics-threshold-alert.asciidoc index 5dfe65b381..1f422d206a 100644 --- a/docs/en/observability/metrics-threshold-alert.asciidoc +++ b/docs/en/observability/metrics-threshold-alert.asciidoc @@ -1,7 +1,7 @@ [[metrics-threshold-alert]] = Create a metric threshold rule ++++ -Metrics threshold +Metric threshold ++++ Based on the metrics that are listed on the **Metrics Explorer** page within the {infrastructure-app}, From 0a05f5a4bb5070ee142f86699bfde3d7da4e2e7f Mon Sep 17 00:00:00 2001 From: dedemorton Date: Fri, 23 Feb 2024 13:30:11 -0800 Subject: [PATCH 5/5] Fix name of metric threshold rule --- docs/en/observability/metrics-threshold-alert.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/observability/metrics-threshold-alert.asciidoc b/docs/en/observability/metrics-threshold-alert.asciidoc index 1f422d206a..cf136e89dd 100644 --- a/docs/en/observability/metrics-threshold-alert.asciidoc +++ b/docs/en/observability/metrics-threshold-alert.asciidoc @@ -96,14 +96,14 @@ You can add more context to the message by clicking the icon above the message t and selecting from a list of available variables. [role="screenshot"] -image::images/metrics-threshold-alert-default-message.png[Default notification message for metrics threshold rules with open "Add variable" popup listing available action variables,width=600] +image::images/metrics-threshold-alert-default-message.png[Default notification message for metric threshold rules with open "Add variable" popup listing available action variables,width=600] // NOTE: This is an autogenerated screenshot. Do not edit it directly. [discrete] [[metrics-alert-settings]] == Settings -With metrics threshold rules, it's not possible to set an explicit index pattern as part of the configuration. The index pattern is instead inferred from +With metric threshold rules, it's not possible to set an explicit index pattern as part of the configuration. The index pattern is instead inferred from *Metrics indices* on the <> page of the {infrastructure-app}. With each execution of the rule check, the *Metrics indices* setting is checked, but it is not stored when the rule is created.