Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 47c9138

Browse files
authored
Merge pull request #2289 from splunk/bhillmer-DOCGUILD-26768-doc-feedback-2-0-instrumentation
[DOCGUILD-26768] update with 2.0 instrumentation attribute
2 parents 3a3bfd9 + c0fedf7 commit 47c9138

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

apm/apm-spans-traces/apm-errors.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ With Splunk APM error detection, you can isolate specific causes of errors in yo
1111

1212
.. _apm-error-detection:
1313

14-
How error spans are detected
14+
How Splunk APM detects error spans
1515
=========================================
1616

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:
1818

1919
* 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.
2020

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.
2222
* See :ref:`apm-grpc-status` to learn which ``rpc.grpc.status_code`` tag values set ``otel.status_code`` to ``ERROR`` in the OpenTelemetry instrumentation.
2323
* The ``error`` tag for the span is set to a truthy value, which is any value other than ``False`` or ``0``.
2424

@@ -204,8 +204,8 @@ However, depending on your application's logic, a ``4xx`` status code might repr
204204

205205
For example, if Kai wants to alert on the rate of ``401`` errors returned by a given service, they do the following:
206206

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`.
209209
3. Set up an alert on the rate of ``401`` errors as compared to all requests. See :ref:`apm-alerts`.
210210

211211
.. _5xx-error-logic:

0 commit comments

Comments
 (0)