You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: apm/apm-spans-traces/apm-errors.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,14 @@ With Splunk APM error detection, you can isolate specific causes of errors in yo
11
11
12
12
.. _apm-error-detection:
13
13
14
-
How error spans are detected
14
+
How Splunk APM detects error spans
15
15
=========================================
16
16
17
-
Each :term:`span` in Splunk APM captures a single operation. Splunk APM considers a span to be an error span if the operation that the span captures results in an error. A span is considered to be an error span when any of the following conditions are met:
17
+
Each :term:`span` in Splunk APM captures a single operation. Splunk APM considers a span to be an error span if the operation that the span captures results in an error as defined by the following conditions:
18
18
19
19
* The ``otel.status_code`` field for the span is ``ERROR``. ``otel.status_code`` is set in the Splunk Distribution of the OpenTelemetry instrumentation using the native OTel field ``span.status``. ``span.status``, and subsequently ``otel.status_code``, are set based on either the HTTP status code or the gRPC status code.
20
20
21
-
* See :ref:`apm-http-status` to learn which ``http.status_code`` tag values set ``otel.status_code`` to ``ERROR`` in the OpenTelemetry instrumentation.
21
+
* See :ref:`apm-http-status` to learn which status code values set ``otel.status_code`` to ``ERROR`` in the OpenTelemetry instrumentation.
22
22
* See :ref:`apm-grpc-status` to learn which ``rpc.grpc.status_code`` tag values set ``otel.status_code`` to ``ERROR`` in the OpenTelemetry instrumentation.
23
23
* The ``error`` tag for the span is set to a truthy value, which is any value other than ``False`` or ``0``.
24
24
@@ -204,8 +204,8 @@ However, depending on your application's logic, a ``4xx`` status code might repr
204
204
205
205
For example, if Kai wants to alert on the rate of ``401`` errors returned by a given service, they do the following:
206
206
207
-
1. Index ``http.status_code``. See :ref:`apm-index-span-tags`.
208
-
2. Create a custom Monitoring MetricSet on ``http.status_code`` for the service's endpoints to get a time series for each status code. See :ref:`cmms`.
207
+
1. Index ``http.status_code`` in libraries that support OpenTelemetry semantic conventions version 1.16.0 or lower. Or index ``http.response.status_code`` in libraries that support OpenTelemetry semantic conventions version 1.17.0 or higher. See :ref:`apm-index-span-tags`.
208
+
2. Create a custom Monitoring MetricSet on the status code tag for the service's endpoints to get a time series for each status code. See :ref:`cmms`.
209
209
3. Set up an alert on the rate of ``401`` errors as compared to all requests. See :ref:`apm-alerts`.
0 commit comments