Skip to content

Commit

Permalink
Clarify descriptions of APM indicators for SLOs (#3953)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Gil Raphaelli <[email protected]>
  • Loading branch information
dedemorton and graphaelli authored Jun 17, 2024
1 parent 4a57e39 commit 4770b0c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/en/observability/slo-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,15 +139,16 @@ When defining a histogram metric SLI, set the following fields:
[[apm-latency-sli]]
=== APM latency

Create an indicator based on the APM data that you received from your instrumented services and a latency threshold.
Create an indicator based on latency data received from your instrumented services and a latency threshold.

*Example:* You can define an indicator on an APM service named `banking-service` for the `production` environment, and the transaction name `POST /deposit` with a latency threshold value of 300ms.

[discrete]
[[apm-availability-sli]]
=== APM availability

Create an indicator based on the APM data received from your instrumented services.
Create an indicator based on the availability of your instrumented services.
Availability is determined by calculating the percentage of successful transactions (`event.outcome : "success"`) out of the total number of successful and failed transactions—unknown outcomes are excluded.

*Example:* You can define an indicator on an APM service named `search-service` for the `production` environment, and the transaction name `POST /search`.

Expand Down
5 changes: 3 additions & 2 deletions docs/en/serverless/slos/create-an-slo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,12 @@ When defining a histogram metric SLI, set the following fields:

There are two types of SLI you can create based on services using application performance monitoring (APM): APM latency and APM availability.

Use **APM latency** to create an indicator based on the APM data that you received from your instrumented services and a latency threshold.
Use **APM latency** to create an indicator based on latency data received from your instrumented services and a latency threshold.

**Example:** You can define an indicator on an APM service named `banking-service` for the `production` environment, and the transaction name `POST /deposit` with a latency threshold value of 300ms.

Use **APM availability** to create an indicator based on the APM data received from your instrumented services.
Use **APM availability** to create an indicator based on the availability of your instrumented services.
Availability is determined by calculating the percentage of successful transactions (`event.outcome : "success"`) out of the total number of successful and failed transactions—unknown outcomes are excluded.

**Example:** You can define an indicator on an APM service named `search-service` for the `production` environment, and the transaction name `POST /search`.

Expand Down

0 comments on commit 4770b0c

Please sign in to comment.