Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/exceptions/exceptions-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,20 @@ This event describes a single exception.
|---|---|---|---|---|---|
| [`exception.message`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` [1] | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` |
| [`exception.type`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` [2] | 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`](/docs/registry/attributes/exception.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | `Recommended` | boolean | Indicates that the exception is escaping the scope of the span. | |
| [`exception.stacktrace`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `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.type`:** Required if `exception.message` is not set, recommended otherwise.

<details>
<summary><b>Deprecated Attributes:</b></summary>

| Key | Value Type | Summary | Example Values | Deprecation Explanation |
|---|---|---|---|---|
| [`exception.escaped`](/docs/registry/attributes/exception.md) | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. |

</details>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
16 changes: 6 additions & 10 deletions docs/registry/attributes/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@

# Android

- [Android Attributes](#android-attributes)
- [Deprecated Android Attributes](#deprecated-android-attributes)

## Android Attributes

The Android platform on which the Android application is running.
Expand All @@ -29,15 +26,12 @@ The Android platform on which the Android application is running.
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) |
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | ![Development](https://img.shields.io/badge/-development-blue) |

## Deprecated Android Attributes

This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform.

**Attributes:**
<details>
<summary><b>Deprecated Attributes:</b></summary>

| Key | Stability | Value Type | Description | Example Values |
| Key | Value Type | Summary | Example Values | Deprecation Explanation |
|---|---|---|---|---|
| <a id="android-state" href="#android-state">`android.state`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `android.app.state`. | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` |
| <a id="android-state" href="#android-state">`android.state`</a> | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` | Use `android.app.state` instead. |

---

Expand All @@ -48,3 +42,5 @@ This document defines attributes that represents an occurrence of a lifecycle tr
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. | ![Development](https://img.shields.io/badge/-development-blue) |
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) |
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | ![Development](https://img.shields.io/badge/-development-blue) |

</details>
11 changes: 7 additions & 4 deletions docs/registry/attributes/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,12 @@ This section defines attributes for Azure Cosmos DB.

This section describes deprecated Azure attributes.

**Attributes:**
<details>
<summary><b>Deprecated Attributes:</b></summary>

| Key | Stability | Value Type | Description | Example Values |
| Key | Value Type | Summary | Example Values | Deprecation Explanation |
|---|---|---|---|---|
| <a id="az-namespace" href="#az-namespace">`az.namespace`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `azure.resource_provider.namespace`. | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` |
| <a id="az-service-request-id" href="#az-service-request-id">`az.service_request_id`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `azure.service.request.id`. | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` |
| <a id="az-namespace" href="#az-namespace">`az.namespace`</a> | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. |
| <a id="az-service-request-id" href="#az-service-request-id">`az.service_request_id`</a> | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. |

</details>
24 changes: 10 additions & 14 deletions docs/registry/attributes/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@

# Code

- [Code Attributes](#code-attributes)
- [Deprecated Code Attributes](#deprecated-code-attributes)

## Code Attributes

These attributes provide context about source code
Expand Down Expand Up @@ -36,16 +33,15 @@ Examples:
* Rust: `playground::my_module::my_cool_func`
* C function: `fopen`

## Deprecated Code Attributes

These deprecated attributes provide context about source code

**Attributes:**
<details>
<summary><b>Deprecated Attributes:</b></summary>

| Key | Stability | Value Type | Description | Example Values |
| Key | Value Type | Summary | Example Values | Deprecation Explanation |
|---|---|---|---|---|
| <a id="code-column" href="#code-column">`code.column`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `code.column.number`. | int | Deprecated, use `code.column.number` | `16` |
| <a id="code-filepath" href="#code-filepath">`code.filepath`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `code.file.path`. | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` |
| <a id="code-function" href="#code-function">`code.function`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Value should be included in `code.function.name` which is expected to be a fully-qualified name. | string | Deprecated, use `code.function.name` instead | `serveRequest` |
| <a id="code-lineno" href="#code-lineno">`code.lineno`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `code.line.number`. | int | Deprecated, use `code.line.number` instead | `42` |
| <a id="code-namespace" href="#code-namespace">`code.namespace`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Value should be included in `code.function.name` which is expected to be a fully-qualified name. | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` |
| <a id="code-column" href="#code-column">`code.column`</a> | int | Deprecated, use `code.column.number` | `16` | Use `code.column.number` instead. |
| <a id="code-filepath" href="#code-filepath">`code.filepath`</a> | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | Use `code.file.path` instead. |
| <a id="code-function" href="#code-function">`code.function`</a> | string | Deprecated, use `code.function.name` instead | `serveRequest` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. |
| <a id="code-lineno" href="#code-lineno">`code.lineno`</a> | int | Deprecated, use `code.line.number` instead | `42` | Use `code.line.number` instead. |
| <a id="code-namespace" href="#code-namespace">`code.namespace`</a> | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. |

</details>
20 changes: 8 additions & 12 deletions docs/registry/attributes/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@

# Container

- [Container Attributes](#container-attributes)
- [Deprecated Container Attributes](#deprecated-container-attributes)

## Container Attributes

A container instance.
Expand Down Expand Up @@ -44,17 +41,14 @@ The ID is assigned by the container runtime and can vary in different environmen

**[6] `container.label.<key>`:** For example, a docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`.

## Deprecated Container Attributes

Describes deprecated container attributes.

**Attributes:**
<details>
<summary><b>Deprecated Attributes:</b></summary>

| Key | Stability | Value Type | Description | Example Values |
| Key | Value Type | Summary | Example Values | Deprecation Explanation |
|---|---|---|---|---|
| <a id="container-cpu-state" href="#container-cpu-state">`container.cpu.state`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `cpu.mode`. | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` |
| <a id="container-labels" href="#container-labels">`container.labels.<key>`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `container.label`. | string | Deprecated, use `container.label` instead. | `nginx` |
| <a id="container-runtime" href="#container-runtime">`container.runtime`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `container.runtime.name`. | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` |
| <a id="container-cpu-state" href="#container-cpu-state">`container.cpu.state`</a> | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | Use `cpu.mode` instead. |
| <a id="container-labels" href="#container-labels">`container.labels.<key>`</a> | string | Deprecated, use `container.label` instead. | `nginx` | Use `container.label` instead. |
| <a id="container-runtime" href="#container-runtime">`container.runtime`</a> | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | Use `container.runtime.name` instead. |

---

Expand All @@ -65,3 +59,5 @@ Describes deprecated container attributes.
| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) |
| `system` | When CPU is used by the system (host OS) | ![Development](https://img.shields.io/badge/-development-blue) |
| `user` | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) |

</details>
Loading
Loading