diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 8f9245deb6..2397610ad6 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -21,6 +21,7 @@ # Logs semantic conventions /semantic_conventions/logs/ @tigrannajaryan +/specification/exceptions/exceptions-logs.md @tigrannajaryan /specification/general/events-general.md @tigrannajaryan /specification/general/logs-general.md @tigrannajaryan /specification/logs/ @tigrannajaryan diff --git a/specification/README.md b/specification/README.md index f3c9e0d125..6a8a05744c 100644 --- a/specification/README.md +++ b/specification/README.md @@ -7,6 +7,7 @@ The benefit to using Semantic Conventions is in following a common naming scheme Semantic Conventions are defined for the following areas: * [General](general/README.md): General Semantic Conventions. +* [Exceptions](exceptions/README.md): Semantic Conventions for Exceptions. * [HTTP](http/README.md): Semantic Conventions for HTTP client and server operations. * *Other areas can be found in the signal specific Semantic Conventions below* diff --git a/specification/exceptions/README.md b/specification/exceptions/README.md new file mode 100644 index 0000000000..2f0a2f9097 --- /dev/null +++ b/specification/exceptions/README.md @@ -0,0 +1,12 @@ +# Semantic conventions for Exceptions + +**Status**: [Experimental][DocumentStatus] + +This document defines semantic conventions for Exceptions. + +Semantic conventions for Exceptions are defined for the following signals: + +* [Exceptions on spans](exceptions-spans.md): Semantic Conventions for Exceptions associated with *spans*. +* [Exceptions in logs](exceptions-logs.md): Semantic Conventions for Exceptions recorded in *logs*. + +[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md diff --git a/specification/logs/semantic_conventions/exceptions.md b/specification/exceptions/exceptions-logs.md similarity index 95% rename from specification/logs/semantic_conventions/exceptions.md rename to specification/exceptions/exceptions-logs.md index 3ac3a181aa..28c26d1bb7 100644 --- a/specification/logs/semantic_conventions/exceptions.md +++ b/specification/exceptions/exceptions-logs.md @@ -1,4 +1,4 @@ -# Semantic Conventions for Exceptions +# Semantic Conventions for Exceptions in Logs **Status**: [Experimental][DocumentStatus] @@ -47,6 +47,6 @@ The table below indicates which attributes should be added to the ### Stacktrace Representation Same as [Trace Semantic Conventions for Exceptions - Stacktrace -Representation](../../trace/semantic_conventions/exceptions.md#stacktrace-representation). +Representation](exceptions-spans.md#stacktrace-representation). [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md diff --git a/specification/trace/semantic_conventions/exceptions.md b/specification/exceptions/exceptions-spans.md similarity index 97% rename from specification/trace/semantic_conventions/exceptions.md rename to specification/exceptions/exceptions-spans.md index 9ad1080fa1..999c975f2b 100644 --- a/specification/trace/semantic_conventions/exceptions.md +++ b/specification/exceptions/exceptions-spans.md @@ -1,9 +1,9 @@ -# Semantic Conventions for Exceptions +# Semantic Conventions for Exceptions on Spans **Status**: [Experimental][DocumentStatus] This document defines semantic conventions for recording application -exceptions. +exceptions associated with spans. @@ -102,7 +102,7 @@ grained information from a stacktrace, if necessary. [ruby-full-message]: https://ruby-doc.org/core-2.7.1/Exception.html#method-i-full_message [csharp-stacktrace]: https://docs.microsoft.com/en-us/dotnet/api/system.exception.tostring [go-stacktrace]: https://pkg.go.dev/runtime/debug#Stack -[telemetry-sdk-resource]: ../../resource/semantic_conventions/README.md#telemetry-sdk +[telemetry-sdk-resource]: ../resource/semantic_conventions/README.md#telemetry-sdk [erlang-stacktrace]: https://www.erlang.org/doc/man/erl_error.html#format_exception-3 [elixir-stacktrace]: https://hexdocs.pm/elixir/1.14.3/Exception.html#format/3 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md diff --git a/specification/general/events-general.md b/specification/general/events-general.md index 188c3d090a..3a616b96f4 100644 --- a/specification/general/events-general.md +++ b/specification/general/events-general.md @@ -8,7 +8,7 @@ in the data model by `LogRecord`s. The following semantic conventions for events are defined: * [General](#general-event-attributes): General semantic attributes that may be used in describing Events. -* [Exceptions](/specification/logs/semantic_conventions/exceptions.md): Semantic attributes that may be used in describing exceptions as events. +* [Exceptions](/specification/exceptions/exceptions-logs.md): Semantic attributes that may be used in describing exceptions as events. ## General event attributes diff --git a/specification/general/logs-general.md b/specification/general/logs-general.md index 4233c85d71..e52e7c7e08 100644 --- a/specification/general/logs-general.md +++ b/specification/general/logs-general.md @@ -19,7 +19,7 @@ They may be used in any Log Record they apply to. The following semantic conventions for logs are defined: * [General](#general-log-identification-attributes): General semantic attributes that may be used in describing Log Records. -* [Exceptions](/specification/logs/semantic_conventions/exceptions.md): Semantic attributes that may be used in describing exceptions in logs. +* [Exceptions](/specification/exceptions/exceptions-logs.md): Semantic attributes that may be used in describing exceptions in logs. * [Feature Flags](/specification/logs/semantic_conventions/feature-flags.md): Semantic attributes that may be used in describing feature flag evaluations in logs. Apart from semantic conventions for logs, [events](events-general.md), [traces](trace-general.md), and [metrics](metrics-general.md), diff --git a/specification/general/trace-general.md b/specification/general/trace-general.md index 5dec0122ca..3b96c2ff51 100644 --- a/specification/general/trace-general.md +++ b/specification/general/trace-general.md @@ -21,7 +21,7 @@ The following semantic conventions for spans are defined: * [RPC/RMI](/specification/trace/semantic_conventions/rpc.md): For remote procedure call (e.g., gRPC) spans. * [Messaging](/specification/trace/semantic_conventions/messaging.md): For messaging systems (queues, publish/subscribe, etc.) spans. * [FaaS](/specification/trace/semantic_conventions/faas.md): For [Function as a Service](https://en.wikipedia.org/wiki/Function_as_a_service) (e.g., AWS Lambda) spans. -* [Exceptions](/specification/trace/semantic_conventions/exceptions.md): For recording exceptions associated with a span. +* [Exceptions](/specification/exceptions/exceptions-spans.md): For recording exceptions associated with a span. * [Compatibility](/specification/trace/semantic_conventions/compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer. * [Feature Flags](/specification/trace/semantic_conventions/feature-flags.md): For recording feature flag evaluations associated with a span.