Merge branch 'main' into fix/3485

open-telemetry · Jan 9, 2024 · e4407c7 · e4407c7
2 parents 90bbe28 + 75f9d42
commit e4407c7
Show file tree

Hide file tree

Showing 22 changed files with 733 additions and 94 deletions.
diff --git a/.markdown_link_check_config.json b/.markdown_link_check_config.json
@@ -10,7 +10,7 @@
       "replacement": "{{BASEURL}}/"
     },
     {
-      "pattern": "^https://github.com/open-telemetry/semantic-conventions/(blob|tree)/[^/]+/docs/",
+      "pattern": "^https://github.com/open-telemetry/semantic-conventions/(blob|tree)/[^v][^/]*/docs/",
       "replacement": "LINK-CHECK-ERROR-USE-LOCAL-PATH-TO-DOC-PAGE-NOT-EXTERNAL-URL/"
     }
   ],

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,18 +7,25 @@ release.
 
 ## Unreleased
 
-- Replace AWS X-Ray Environment Span Link section with AWS X-Ray Active Tracing Considerations
-  ([#354](https://github.com/open-telemetry/semantic-conventions/pull/354))
-- Move Exceptions to attribute registry
-  ([#574](https://github.com/open-telemetry/semantic-conventions/pull/574))
-- Add `azure_container_apps` to `cloud.platform` semantic conventions ([#615](https://github.com/open-telemetry/semantic-conventions/pull/615))
+### Breaking
+
+- Rename `system.processes.*` namespace to `system.process.*`
+  ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484))
+- Add `azure_container_apps` to `cloud.platform` semantic conventions 
+  ([#615](https://github.com/open-telemetry/semantic-conventions/pull/615))
+
+### Features
+
+### Fixes
+
+## v1.24.0 (2023-12-15)
 
 ### Breaking
 
 - Update `jvm.gc.duration` histogram buckets to `[ 0.01, 0.1, 1, 10 ]`
   ([#317](https://github.com/open-telemetry/semantic-conventions/pull/317))
 - BREAKING: Change type of `host.cpu.model.id` and `host.cpu.model.family` to string.
-  ([#495](https://github.com/open-telemetry/semantic-conventions/issues/495))
+  ([#499](https://github.com/open-telemetry/semantic-conventions/pull/499))
 - Changed `messaging.system` attribute type to an open enum
   ([#517](https://github.com/open-telemetry/semantic-conventions/pull/517))
 - Rename metrics `jvm.memory.usage` to `jvm.memory.used` and `jvm.memory.usage_after_last_gc`
@@ -29,11 +36,17 @@ release.
 - BREAKING: Change `system.disk.io.direction` and `system.network.io.direction`
   to global attributes `disk.io.direction` and `network.io.direction`
   ([#530](https://github.com/open-telemetry/semantic-conventions/pull/530))
+- BREAKING: Change `messaging.kafka.partition` to `messaging.kafka.destination.partition`
+  ([#547](https://github.com/open-telemetry/semantic-conventions/pull/547))
 
 ### Features
 
 - Adds `labels` attribute to `k8s.pod` resource
   ([#494](https://github.com/open-telemetry/semantic-conventions/pull/494))
+- Change Erlang managed thread attribute to be the Erlang process
+  ([#491](https://github.com/open-telemetry/semantic-conventions/pull/491))
+- Add gcp_pubsub as a messaging system
+  ([#490](https://github.com/open-telemetry/semantic-conventions/pull/490))
 - Adds `annotation` attribute to `k8s.pod` resource
   ([#494](https://github.com/open-telemetry/semantic-conventions/pull/573))
 - Add `code.stacktrace` attribute
@@ -53,8 +66,14 @@ release.
   ([#163](https://github.com/open-telemetry/semantic-conventions/pull/163))
 - Add .NET 8.0 metrics for HTTP client, ASP.NET Core, SignalR server and Kestrel.
   ([#283](https://github.com/open-telemetry/semantic-conventions/pull/283))
+- Add system shared IO direction attributes
+  ([#530](https://github.com/open-telemetry/semantic-conventions/pull/530))
 - JVM metrics marked stable
   ([#569](https://github.com/open-telemetry/semantic-conventions/pull/569))
+- Add attribute for k8s pod annotations
+  ([#573](https://github.com/open-telemetry/semantic-conventions/pull/573))
+- Replace AWS X-Ray Environment Span Link section with AWS X-Ray Active Tracing Considerations
+  ([#354](https://github.com/open-telemetry/semantic-conventions/pull/354))
 
 ### Fixes
 

diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md
@@ -27,6 +27,7 @@ All registered attributes are listed by namespace in this registry.
 
 Currently, the following namespaces exist:
 
+* [Browser](browser.md)
 * [Client](client.md)
 * [Cloud](cloud.md)
 * [Code](code.md)

diff --git a/docs/attributes-registry/browser.md b/docs/attributes-registry/browser.md
@@ -0,0 +1,24 @@
+<!--- Hugo front matter used to generate the website version of this page:
+--->
+
+# Browser
+
+## Browser Attributes
+
+<!-- semconv registry.browser(omit_requirement_level) -->
+| Attribute  | Type | Description  | Examples  |
+|---|---|---|---|
+| `browser.brands` | string[] | Array of brand name and version separated by a space [1] | `[ Not A;Brand 99, Chromium 99, Chrome 99]` |
+| `browser.language` | string | Preferred language of the user using the browser [2] | `en`; `en-US`; `fr`; `fr-FR` |
+| `browser.mobile` | boolean | A boolean that is true if the browser is running on a mobile device [3] |  |
+| `browser.platform` | string | The platform on which the browser is running [4] | `Windows`; `macOS`; `Android` |
+
+**[1]:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`).
+
+**[2]:** This value is intended to be taken from the Navigator API `navigator.language`.
+
+**[3]:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset.
+
+**[4]:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.platform`). If unavailable, the legacy `navigator.platform` API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent.
+The list of possible values is defined in the [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides.
+<!-- endsemconv -->
diff --git a/docs/attributes-registry/exception.md b/docs/attributes-registry/exception.md
@@ -8,10 +8,10 @@
 <!-- semconv registry.exception(omit_requirement_level) -->
 | 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)<br>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)<br>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)<br>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)<br>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
@@ -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
@@ -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.