diff --git a/docs/attributes-registry/exception.md b/docs/attributes-registry/exception.md index e3874f51b..e5d541c93 100644 --- a/docs/attributes-registry/exception.md +++ b/docs/attributes-registry/exception.md @@ -8,10 +8,10 @@ | Attribute | Type | Description | Examples | |---|---|---|---| -| `exception.escaped` | boolean | SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span. [1] | | -| `exception.message` | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | -| `exception.stacktrace` | string | A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. | `Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)` | -| `exception.type` | string | The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. | `java.net.ConnectException`; `OSError` | +| `exception.escaped` | boolean | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span. [1] | | +| `exception.message` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | +| `exception.stacktrace` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. | `Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)` | +| `exception.type` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)
The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. | `java.net.ConnectException`; `OSError` | **[1]:** An exception is considered to have escaped (or left) the scope of a span, if that span is ended while the exception is still logically "in flight". diff --git a/docs/exceptions/exceptions-logs.md b/docs/exceptions/exceptions-logs.md index 19c7c253d..11656ea1d 100644 --- a/docs/exceptions/exceptions-logs.md +++ b/docs/exceptions/exceptions-logs.md @@ -4,7 +4,7 @@ linkTitle: Logs # Semantic Conventions for Exceptions in Logs -**Status**: [Experimental][DocumentStatus] +**Status**: [Stable][DocumentStatus] This document defines semantic conventions for recording exceptions on [logs](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/logs/bridge-api.md#emit-a-logrecord) and [events](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/logs/event-api.md#emit-event) diff --git a/docs/exceptions/exceptions-spans.md b/docs/exceptions/exceptions-spans.md index 31f88edb5..18a91996a 100644 --- a/docs/exceptions/exceptions-spans.md +++ b/docs/exceptions/exceptions-spans.md @@ -4,7 +4,7 @@ linkTitle: Spans # Semantic Conventions for Exceptions on Spans -**Status**: [Experimental][DocumentStatus] +**Status**: [Stable][DocumentStatus] This document defines semantic conventions for recording application exceptions associated with spans. diff --git a/model/registry/exception.yaml b/model/registry/exception.yaml index 8894b316a..7e1b01188 100644 --- a/model/registry/exception.yaml +++ b/model/registry/exception.yaml @@ -8,6 +8,7 @@ groups: attributes: - id: type type: string + stability: stable brief: > The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type @@ -15,10 +16,12 @@ groups: examples: ["java.net.ConnectException", "OSError"] - id: message type: string + stability: stable brief: The exception message. examples: ["Division by zero", "Can't convert 'int' object to str implicitly"] - id: stacktrace type: string + stability: stable brief: > A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. @@ -28,6 +31,7 @@ groups: at com.example.GenerateTrace.main(GenerateTrace.java:5)' - id: escaped type: boolean + stability: stable brief: > SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.