Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x](backport #4346) [synthetics] Document Synthetics availability SLI #4380

Merged
merged 2 commits into from
Oct 16, 2024
Merged

[8.x](backport #4346) [synthetics] Document Synthetics availability SLI #4380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f7bf8c
[synthetics] Document Synthetics availability SLI (#4346)
colleenmcginnis Oct 16, 2024
00f4389
Delete docs/en/serverless directory
github-actions[bot] Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/en/observability/slo-create.asciidoc
View file
Open in desktop
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
View file
Open in desktop
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