-
Notifications
You must be signed in to change notification settings - Fork 352
Define messaging exception events #3435
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| change_type: enhancement | ||
| component: messaging | ||
| note: Define domain-specific exception events for messaging | ||
| issues: [3435] | ||
| subtext: | | ||
| These domain-specific exception events provide a structured way to record | ||
| exceptions that occur during messaging operations: | ||
| - `messaging.create.exception` for messaging create operations | ||
| - `messaging.send.exception` for messaging send operations | ||
| - `messaging.receive.exception` for messaging receive operations | ||
| - `messaging.settle.exception` for messaging settle operations | ||
| - `messaging.process.exception` for messaging process operations |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| linkTitle: Exceptions | ||
| ---> | ||
|
|
||
| # Semantic conventions for messaging exceptions | ||
|
|
||
| **Status**: [Development][DocumentStatus] | ||
|
|
||
| This document defines semantic conventions for recording exceptions on messaging operations. | ||
|
|
||
| <!-- toc --> | ||
|
|
||
| - [Messaging create exception](#messaging-create-exception) | ||
| - [Messaging send exception](#messaging-send-exception) | ||
| - [Messaging receive exception](#messaging-receive-exception) | ||
| - [Messaging settle exception](#messaging-settle-exception) | ||
| - [Messaging process exception](#messaging-process-exception) | ||
|
|
||
| <!-- tocstop --> | ||
|
|
||
| ## Messaging create exception | ||
|
|
||
| <!-- semconv event.messaging.create.exception --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
| **Status:**  | ||
|
|
||
| The event name MUST be `messaging.create.exception`. | ||
|
|
||
| This event represents an exception that occurred during a messaging create operation. | ||
|
|
||
| This event SHOULD be recorded when an exception occurs during a messaging create operation. | ||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
| Instrumentations MAY provide a configuration option to populate exception events with the attributes captured on the corresponding messaging create span. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | | ||
| | [`exception.message`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [1] | string | The exception message. [2] | `Division by zero`; `Can't convert 'int' object to str implicitly` | | ||
| | [`exception.type`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [3] | 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.stacktrace`](/docs/registry/attributes/exception.md) |  | `Recommended` | 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)` | | ||
|
|
||
| **[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise. | ||
|
|
||
| **[2] `exception.message`:** | ||
|
|
||
| > [!WARNING] | ||
| > | ||
| > This attribute may contain sensitive information. | ||
|
|
||
| **[3] `exception.type`:** Required if `exception.message` is not set, recommended otherwise. | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ## Messaging send exception | ||
|
|
||
| <!-- semconv event.messaging.send.exception --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
| **Status:**  | ||
|
|
||
| The event name MUST be `messaging.send.exception`. | ||
|
|
||
| This event represents an exception that occurred during a messaging send operation. | ||
|
|
||
| This event SHOULD be recorded when an exception occurs during a messaging send operation. | ||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
| Instrumentations MAY provide a configuration option to populate exception events with the attributes captured on the corresponding messaging send span. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | | ||
| | [`exception.message`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [1] | string | The exception message. [2] | `Division by zero`; `Can't convert 'int' object to str implicitly` | | ||
| | [`exception.type`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [3] | 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.stacktrace`](/docs/registry/attributes/exception.md) |  | `Recommended` | 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)` | | ||
|
|
||
| **[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise. | ||
|
|
||
| **[2] `exception.message`:** | ||
|
|
||
| > [!WARNING] | ||
| > | ||
| > This attribute may contain sensitive information. | ||
|
|
||
| **[3] `exception.type`:** Required if `exception.message` is not set, recommended otherwise. | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ## Messaging receive exception | ||
|
|
||
| <!-- semconv event.messaging.receive.exception --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
| **Status:**  | ||
|
|
||
| The event name MUST be `messaging.receive.exception`. | ||
|
|
||
| This event represents an exception that occurred during a messaging receive operation. | ||
|
|
||
| This event SHOULD be recorded when an exception occurs during a messaging receive operation. | ||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
| Instrumentations MAY provide a configuration option to populate exception events with the attributes captured on the corresponding messaging receive span. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | | ||
| | [`exception.message`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [1] | string | The exception message. [2] | `Division by zero`; `Can't convert 'int' object to str implicitly` | | ||
| | [`exception.type`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [3] | 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.stacktrace`](/docs/registry/attributes/exception.md) |  | `Recommended` | 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)` | | ||
|
|
||
| **[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise. | ||
|
|
||
| **[2] `exception.message`:** | ||
|
|
||
| > [!WARNING] | ||
| > | ||
| > This attribute may contain sensitive information. | ||
|
|
||
| **[3] `exception.type`:** Required if `exception.message` is not set, recommended otherwise. | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ## Messaging settle exception | ||
|
|
||
| <!-- semconv event.messaging.settle.exception --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
| **Status:**  | ||
|
|
||
| The event name MUST be `messaging.settle.exception`. | ||
|
|
||
| This event represents an exception that occurred during a messaging settle operation. | ||
|
|
||
| This event SHOULD be recorded when an exception occurs during a messaging settle operation. | ||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
| Instrumentations MAY provide a configuration option to populate exception events with the attributes captured on the corresponding messaging settle span. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | | ||
| | [`exception.message`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [1] | string | The exception message. [2] | `Division by zero`; `Can't convert 'int' object to str implicitly` | | ||
| | [`exception.type`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [3] | 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.stacktrace`](/docs/registry/attributes/exception.md) |  | `Recommended` | 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)` | | ||
|
|
||
| **[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise. | ||
|
|
||
| **[2] `exception.message`:** | ||
|
|
||
| > [!WARNING] | ||
| > | ||
| > This attribute may contain sensitive information. | ||
|
|
||
| **[3] `exception.type`:** Required if `exception.message` is not set, recommended otherwise. | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ## Messaging process exception | ||
|
|
||
| <!-- semconv event.messaging.process.exception --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
| **Status:**  | ||
|
|
||
| The event name MUST be `messaging.process.exception`. | ||
|
|
||
| This event represents an exception that occurred during messaging process operations. | ||
|
|
||
| This event SHOULD be recorded when an exception occurs during messaging process operations. | ||
| Instrumentations SHOULD set the severity to ERROR (severity number 17) when recording this event. | ||
| Instrumentations MAY provide a configuration option to populate exception events with the attributes captured on the corresponding messaging process span. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | | ||
| | [`exception.message`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [1] | string | The exception message. [2] | `Division by zero`; `Can't convert 'int' object to str implicitly` | | ||
| | [`exception.type`](/docs/registry/attributes/exception.md) |  | `Conditionally Required` [3] | 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.stacktrace`](/docs/registry/attributes/exception.md) |  | `Recommended` | 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)` | | ||
|
|
||
| **[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise. | ||
|
|
||
| **[2] `exception.message`:** | ||
|
|
||
| > [!WARNING] | ||
| > | ||
| > This attribute may contain sensitive information. | ||
|
|
||
| **[3] `exception.type`:** Required if `exception.message` is not set, recommended otherwise. | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| groups: | ||
| - id: event.messaging.create.exception | ||
| name: messaging.create.exception | ||
| stability: development | ||
| type: event | ||
| brief: > | ||
| This event represents an exception that occurred during a messaging create operation. | ||
| note: > | ||
| This event SHOULD be recorded when an exception occurs during a messaging create operation. | ||
|
|
||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
|
|
||
| Instrumentations MAY provide a configuration option to populate exception events | ||
| with the attributes captured on the corresponding messaging create span. | ||
| attributes: | ||
| - ref: exception.type | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.message` is not set, recommended otherwise. | ||
| - ref: exception.message | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.type` is not set, recommended otherwise. | ||
| - ref: exception.stacktrace | ||
|
|
||
| - id: event.messaging.send.exception | ||
| name: messaging.send.exception | ||
| stability: development | ||
| type: event | ||
| brief: > | ||
| This event represents an exception that occurred during a messaging send operation. | ||
| note: > | ||
| This event SHOULD be recorded when an exception occurs during a messaging send operation. | ||
|
|
||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
|
|
||
| Instrumentations MAY provide a configuration option to populate exception events | ||
| with the attributes captured on the corresponding messaging send span. | ||
| attributes: | ||
| - ref: exception.type | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.message` is not set, recommended otherwise. | ||
| - ref: exception.message | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.type` is not set, recommended otherwise. | ||
| - ref: exception.stacktrace | ||
|
|
||
| - id: event.messaging.receive.exception | ||
| name: messaging.receive.exception | ||
| stability: development | ||
| type: event | ||
| brief: > | ||
| This event represents an exception that occurred during a messaging receive operation. | ||
| note: > | ||
| This event SHOULD be recorded when an exception occurs during a messaging receive operation. | ||
|
|
||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
|
|
||
| Instrumentations MAY provide a configuration option to populate exception events | ||
| with the attributes captured on the corresponding messaging receive span. | ||
| attributes: | ||
| - ref: exception.type | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.message` is not set, recommended otherwise. | ||
| - ref: exception.message | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.type` is not set, recommended otherwise. | ||
| - ref: exception.stacktrace | ||
|
|
||
| - id: event.messaging.settle.exception | ||
| name: messaging.settle.exception | ||
| stability: development | ||
| type: event | ||
| brief: > | ||
| This event represents an exception that occurred during a messaging settle operation. | ||
| note: > | ||
| This event SHOULD be recorded when an exception occurs during a messaging settle operation. | ||
|
|
||
| Instrumentations SHOULD set the severity to WARN (severity number 13) when recording this event. | ||
|
|
||
| Instrumentations MAY provide a configuration option to populate exception events | ||
| with the attributes captured on the corresponding messaging settle span. | ||
| attributes: | ||
| - ref: exception.type | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.message` is not set, recommended otherwise. | ||
| - ref: exception.message | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.type` is not set, recommended otherwise. | ||
| - ref: exception.stacktrace | ||
|
|
||
| - id: event.messaging.process.exception | ||
| name: messaging.process.exception | ||
| stability: development | ||
| type: event | ||
| brief: > | ||
| This event represents an exception that occurred during messaging process operations. | ||
| note: > | ||
| This event SHOULD be recorded when an exception occurs during messaging process operations. | ||
|
|
||
| Instrumentations SHOULD set the severity to ERROR (severity number 17) when recording this event. | ||
|
|
||
| Instrumentations MAY provide a configuration option to populate exception events | ||
| with the attributes captured on the corresponding messaging process span. | ||
| attributes: | ||
| - ref: exception.type | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.message` is not set, recommended otherwise. | ||
| - ref: exception.message | ||
| requirement_level: | ||
| conditionally_required: Required if `exception.type` is not set, recommended otherwise. | ||
| - ref: exception.stacktrace | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.