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.

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

Adding SLOs troubleshooting document (attempt 2) #4486

Merged
merged 33 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
452b655
slo troubleshooting doc added
eedugon Nov 6, 2024
2df9670
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 14, 2024
924940f
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 14, 2024
008d817
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 14, 2024
261f810
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 14, 2024
e0c2b19
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 14, 2024
5688516
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 14, 2024
414f25e
Update docs/en/observability/slo-create.asciidoc
eedugon Nov 14, 2024
9a6d826
minor change
eedugon Nov 14, 2024
e1c067e
applied suggestions by Luca. ready for review
eedugon Nov 21, 2024
b5a8137
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
7f5db60
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
7671397
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
e07b826
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
da9e989
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
21cb591
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
384a582
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
8175ede
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
a06bc66
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 21, 2024
d6c8ec0
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
a8bb386
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
ec96873
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
ba5010c
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
3082206
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
116ab1e
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
5b489ee
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
fb7931b
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
4d80bb8
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 22, 2024
0813ddd
code blocks updated
eedugon Nov 22, 2024
a62b1a5
beta link added
eedugon Nov 25, 2024
0f1f10e
Update docs/en/observability/slo-troubleshoot.asciidoc
eedugon Nov 26, 2024
e365d5f
SLO update statement fixed
eedugon Nov 26, 2024
77ea56e
SLO update statement fixed
eedugon Nov 26, 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
2 changes: 2 additions & 0 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ include::slo-privileges.asciidoc[leveloffset=+3]

include::slo-create.asciidoc[leveloffset=+3]

include::slo-troubleshoot.asciidoc[leveloffset=+3]

//Data Set Quality
include::logs-monitor-datasets.asciidoc[leveloffset=+1]

Expand Down
6 changes: 6 additions & 0 deletions docs/en/observability/slo-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ From here, complete the following steps:
. <<set-slo>>.
. <<slo-describe>>.

[NOTE]
====
For SLOs to function, the cluster must include one or more nodes with both `ingest` and `transform` {ref}/modules-node.html#node-roles[roles] (they can co-exist or be distributed across separate nodes).
eedugon marked this conversation as resolved.
Show resolved Hide resolved
On ESS deployments (Elastic Cloud), this is handled by the hot nodes, which serve as both `ingest` and `transform` nodes.
====

[discrete]
[[define-sli]]
= Define your SLI
Expand Down
60 changes: 4 additions & 56 deletions docs/en/observability/slo-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
// tag::slo-license[]
[IMPORTANT]
====
To create and manage SLOs, you need an {subscriptions}[appropriate license] and <<slo-privileges,SLO access>> must be configured.
To create and manage SLOs, you need an {subscriptions}[appropriate license], an {es} cluster with both `transform` and `ingest` {ref}/modules-node.html#node-roles[node roles] present, and <<slo-privileges,SLO access>> must be configured.
====
// end::slo-license[]

Expand All @@ -29,6 +29,8 @@ SLO:: The target you set for your SLI. It specifies th
Error budget:: The amount of time that your SLI can not meet the SLO target before it violates your SLO.
Burn rate:: The rate at which your service consumes your error budget.

In addition to these key concepts related to SLO functionality, see <<slo-understanding-slos>> for more information on how SLOs work and their relationship with other system components, such as {ref}/transforms.html[{es} Transforms].

[discrete]
[[slo-in-elastic]]
== SLO overview
Expand Down Expand Up @@ -94,61 +96,7 @@ Starting in version 8.12.0, SLOs are generally available (GA).
If you're upgrading from a beta version of SLOs (available in 8.11.0 and earlier),
you must migrate your SLO definitions to a new format.

[%collapsible]
.Migrate your SLO definitions
====
To migrate your SLO definitions, open the SLO overview.
A banner will display the number of outdated SLOs detected.
For each outdated SLO, click **Reset**. If you no longer need the SLO, select **Delete**.

If you have a large number of SLO definitions, it is possible to automate this process.
To do this, you'll need to use two Elastic APIs:

* https://github.com/elastic/kibana/blob/9cb830fe9a021cda1d091effbe3e0cd300220969/x-pack/plugins/observability/docs/openapi/slo/bundled.yaml#L453-L514[SLO Definitions Find API] (`/api/observability/slos/_definitions`)
* https://github.com/elastic/kibana/blob/9cb830fe9a021cda1d091effbe3e0cd300220969/x-pack/plugins/observability/docs/openapi/slo/bundled.yaml#L368-L410[SLO Reset API] (`/api/observability/slos/${id}/_reset`)

Pass in `includeOutdatedOnly=1` as a query parameter to the Definitions Find API.
This will display your outdated SLO definitions.
Loop through this list, one by one, calling the Reset API on each outdated SLO definition.
The Reset API loads the outdated SLO definition and resets it to the new format required for GA.
Once an SLO is reset, it will start to regenerate SLIs and summary data.
====

[%collapsible]
.Remove legacy summary transforms
====
After migrating to 8.12 or later, you might have some legacy SLO summary transforms running.
You can safely delete the following legacy summary transforms:

[source,sh]
----------------------------------
# Stop all legacy summary transforms
POST _transform/slo-summary-occurrences-30d-rolling/_stop?force=true
POST _transform/slo-summary-occurrences-7d-rolling/_stop?force=true
POST _transform/slo-summary-occurrences-90d-rolling/_stop?force=true
POST _transform/slo-summary-occurrences-monthly-aligned/_stop?force=true
POST _transform/slo-summary-occurrences-weekly-aligned/_stop?force=true
POST _transform/slo-summary-timeslices-30d-rolling/_stop?force=true
POST _transform/slo-summary-timeslices-7d-rolling/_stop?force=true
POST _transform/slo-summary-timeslices-90d-rolling/_stop?force=true
POST _transform/slo-summary-timeslices-monthly-aligned/_stop?force=true
POST _transform/slo-summary-timeslices-weekly-aligned/_stop?force=true

# Delete all legacy summary transforms
DELETE _transform/slo-summary-occurrences-30d-rolling?force=true
DELETE _transform/slo-summary-occurrences-7d-rolling?force=true
DELETE _transform/slo-summary-occurrences-90d-rolling?force=true
DELETE _transform/slo-summary-occurrences-monthly-aligned?force=true
DELETE _transform/slo-summary-occurrences-weekly-aligned?force=true
DELETE _transform/slo-summary-timeslices-30d-rolling?force=true
DELETE _transform/slo-summary-timeslices-7d-rolling?force=true
DELETE _transform/slo-summary-timeslices-90d-rolling?force=true
DELETE _transform/slo-summary-timeslices-monthly-aligned?force=true
DELETE _transform/slo-summary-timeslices-weekly-aligned?force=true
----------------------------------

Do not delete any new summary transforms used by your migrated SLOs.
====
Refer to <<slo-troubleshoot-beta>> for more details on how to proceed.

[discrete]
[[slo-overview-next-steps]]
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/slo-privileges.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<titleabbrev>Configure SLO access</titleabbrev>
++++

IMPORTANT: To create and manage SLOs, you need an {subscriptions}[appropriate license].
IMPORTANT: To create and manage SLOs, you need an {subscriptions}[appropriate license] and an {es} cluster with both `transform` and `ingest` {ref}/modules-node.html#node-roles[node roles] present.

You can enable access to SLOs in two different ways:

Expand Down
Loading