From c33dd958145541864005186c27fb5cd407e1808b Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 16 Oct 2024 09:51:08 -0500 Subject: [PATCH] [synthetics] Document Synthetics availability SLI (#4346) * add info on synthetics availability sli * add note about grouping * update serverless docs --- docs/en/observability/slo-create.asciidoc | 23 +++++++++++++++++++ .../synthetics-configuration.asciidoc | 4 ++-- docs/en/serverless/slos/create-an-slo.mdx | 21 +++++++++++++++++ .../configuration/monitor-config-options.mdx | 12 ++++++++-- 4 files changed, 56 insertions(+), 4 deletions(-) diff --git a/docs/en/observability/slo-create.asciidoc b/docs/en/observability/slo-create.asciidoc index 00052f5ba3..e1da49a152 100644 --- a/docs/en/observability/slo-create.asciidoc +++ b/docs/en/observability/slo-create.asciidoc @@ -29,6 +29,7 @@ The type of SLI to use depends on the location of your data: * <> — create an SLI based on a custom equation that uses multiple aggregations. * <> — create an SLI based on histogram metrics. * <> — create an SLI based on services using application performance monitoring (APM). +* <> — create an SLI based on the availability of your synthetic monitors. [discrete] [[custom-kql-sli]] @@ -161,6 +162,28 @@ When defining an APM latency or APM availability SLI, set the following fields: * *Threshold (APM latency only)* — The latency threshold in milliseconds (ms) to consider the request as good. * *Query filter* — An optional query filter on the APM data. +[discrete] +[[synthetics-availability-sli]] +== Synthetics availability + +Create an indicator based on the availability of your synthetic monitors. +Availability is determined by calculating the percentage of checks that are successful (`monitor.status : "up"`) +out of the total number of checks. + +*Example*: You can define an indicator based on a HTTP monitor being "up" for at least 99% of the time. + +When defining a Synthetics availability SLI, set the following fields: + +* *Monitor name* — The name of one or more <>. +* *Project* — The ID of one or more <> containing synthetic monitors. +* *Tags* — One or more <> assigned to synthetic monitors. +* *Query filter* — An optional KQL query used to filter the Synthetics checks on some relevant criteria. + +[NOTE] +==== +Synthetics availability SLIs are automatically grouped by monitor and location. +==== + [discrete] [[set-slo]] = Set your objectives diff --git a/docs/en/observability/synthetics-configuration.asciidoc b/docs/en/observability/synthetics-configuration.asciidoc index 68854a0f74..0f44da73d3 100644 --- a/docs/en/observability/synthetics-configuration.asciidoc +++ b/docs/en/observability/synthetics-configuration.asciidoc @@ -225,9 +225,9 @@ Default values to be applied to _all_ monitors when using the <`):: +[[synthetics-configuration-monitor-tags]] `tags` (`Array`):: A list of tags that will be sent with the monitor event. Tags are displayed in the {synthetics-app} and allow you to search monitors by tag. `schedule` (`number`):: The interval (in minutes) at which the monitor should run. diff --git a/docs/en/serverless/slos/create-an-slo.mdx b/docs/en/serverless/slos/create-an-slo.mdx index 94f299aadc..685e2c6577 100644 --- a/docs/en/serverless/slos/create-an-slo.mdx +++ b/docs/en/serverless/slos/create-an-slo.mdx @@ -161,6 +161,27 @@ When defining either an APM latency or APM availability SLI, set the following f * **Threshold (APM latency only):** The latency threshold in milliseconds (ms) to consider the request as good. * **Query filter:** An optional query filter on the APM data. +
+ +### Synthetics availability + +Create an indicator based on the availability of your synthetic monitors. +Availability is determined by calculating the percentage of checks that are successful (`monitor.status : "up"`) +out of the total number of checks. + +**Example**: You can define an indicator based on a HTTP monitor being "up" for at least 99% of the time. + +When defining a Synthetics availability SLI, set the following fields: + +* **Monitor name** — The name of one or more synthetic monitors. +* **Project** — The ID of one or more projects containing synthetic monitors. +* **Tags** — One or more tags assigned to synthetic monitors. +* **Query filter** — An optional KQL query used to filter the Synthetics checks on some relevant criteria. + + + Synthetics availability SLIs are automatically grouped by monitor and location. + +
## Set your objectives diff --git a/docs/en/serverless/transclusion/synthetics/configuration/monitor-config-options.mdx b/docs/en/serverless/transclusion/synthetics/configuration/monitor-config-options.mdx index 481a8096ec..895737a11a 100644 --- a/docs/en/serverless/transclusion/synthetics/configuration/monitor-config-options.mdx +++ b/docs/en/serverless/transclusion/synthetics/configuration/monitor-config-options.mdx @@ -6,12 +6,20 @@ A unique identifier for this monitor. - `name` (`string`) + + + `name` (`string`) + + A human readable name for the monitor. - `tags` (`Array`) + + + `tags` (`Array`) + + A list of tags that will be sent with the monitor event. Tags are displayed in the Synthetics UI and allow you to search monitors by tag.