Skip to content

Commit

Permalink
[8.x](backport #4346) [synthetics] Document Synthetics availability S…
Browse files Browse the repository at this point in the history
…LI (#4380)

* [synthetics] Document Synthetics availability SLI (#4346)

* add info on synthetics availability sli

* add note about grouping

* update serverless docs

(cherry picked from commit c33dd95)

# Conflicts:
#	docs/en/serverless/slos/create-an-slo.mdx
#	docs/en/serverless/transclusion/synthetics/configuration/monitor-config-options.mdx

* Delete docs/en/serverless directory

---------

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Oct 16, 2024
1 parent 403bd5a commit 6c3bd1d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
23 changes: 23 additions & 0 deletions docs/en/observability/slo-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The type of SLI to use depends on the location of your data:
* <<timeslice-metric-sli, Timeslice metric>> — create an SLI based on a custom equation that uses multiple aggregations.
* <<histogram-metric-sli, Histogram metric>> — create an SLI based on histogram metrics.
* <<apm-latency-and-availability-sli, APM latency and APM availability>> — create an SLI based on services using application performance monitoring (APM).
* <<synthetics-availability-sli>> — create an SLI based on the availability of your synthetic monitors.

[discrete]
[[custom-kql-sli]]
Expand Down Expand Up @@ -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 <<synthetics-configuration-monitor-name,synthetic monitors>>.
* *Project* — The ID of one or more <<synthetics-configuration-project,projects>> containing synthetic monitors.
* *Tags* — One or more <<synthetics-configuration-monitor-tags,tags>> 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
Expand Down
4 changes: 2 additions & 2 deletions docs/en/observability/synthetics-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,9 @@ Default values to be applied to _all_ monitors when using the <<elastic-syntheti
// tag::monitor-config-options[]
`id` (`string`)::
A unique identifier for this monitor.
`name` (`string`)::
[[synthetics-configuration-monitor-name]] `name` (`string`)::
A human readable name for the monitor.
`tags` (`Array<string>`)::
[[synthetics-configuration-monitor-tags]] `tags` (`Array<string>`)::
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.
Expand Down

0 comments on commit 6c3bd1d

Please sign in to comment.