Skip to content
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ cascade:
redirects:
- { from: 'attributes-registry/*', to: 'registry/attributes/:splat' }
- { from: 'database/*', to: 'db/:splat' }
- { from: 'registry/attributes/oracledb', to: 'registry/attributes/oracle' }
cSpell:ignore: semconv
auto_gen: below
linkTitle: Semantic conventions
Expand Down
11 changes: 9 additions & 2 deletions docs/cloud-providers/aws-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,21 @@ interesting conventions are found.

| Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- | --- |
| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.system.name`. | `Required` | string | The value `aws-api`. | `aws-api` |
| [`aws.extended_request_id`](/docs/registry/attributes/aws.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If available. | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` |
| [`aws.request_id`](/docs/registry/attributes/aws.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` |
| [`cloud.region`](/docs/registry/attributes/cloud.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The AWS Region where the requested service is being accessed. [1] | `us-east-1`; `us-west-2` |
| [`rpc.method`](/docs/registry/attributes/rpc.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The name of the operation corresponding to the request, as returned by the AWS SDK | `GetItem`; `PutItem` |
| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Value should be included in `rpc.method` which is expected to be a fully-qualified name. | `Recommended` | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` |

**[1] `cloud.region`:** Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute's value should adhere to the AWS Region codes outlined in the [AWS documentation](https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html#available-regions).

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

| Key | Stability | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- |
| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` |
| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` |

---

`rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand All @@ -63,6 +69,7 @@ interesting conventions are found.
| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) |
| `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) |

</details>
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->
Expand Down
143 changes: 117 additions & 26 deletions docs/db/dynamodb.md

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/db/oracledb.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ Spans representing calls to a Oracle SQL Database adhere to the general [Semanti
| [`db.query.summary`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [11] | string | Low cardinality summary of a database query. [12] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` |
| [`db.query.text`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [13] | string | The database query being executed. [14] | `SELECT * FROM wuser_table where username = ?` |
| [`db.stored_procedure.name`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [15] | string | The name of a stored procedure within the database. [16] | `GetCustomer` |
| [`oracle.db.domain`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database domain associated with the connection. [17] | `example.com`; `corp.internal`; `prod.db.local` |
| [`oracle.db.instance.name`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [18] | `ORCL1`; `ORCL2`; `ORCL3` |
| [`oracle.db.name`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database name associated with the connection. [19] | `ORCL1`; `FREE` |
| [`oracle.db.pdb`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The pluggable database (PDB) name associated with the connection. [20] | `PDB1`; `FREEPDB` |
| [`oracle.db.service`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The service name currently associated with the database connection. [21] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` |
| [`oracle.db.domain`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database domain associated with the connection. [17] | `example.com`; `corp.internal`; `prod.db.local` |
| [`oracle.db.instance.name`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [18] | `ORCL1`; `ORCL2`; `ORCL3` |
| [`oracle.db.name`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database name associated with the connection. [19] | `ORCL1`; `FREE` |
| [`oracle.db.pdb`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The pluggable database (PDB) name associated with the connection. [20] | `PDB1`; `FREEPDB` |
| [`oracle.db.service`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The service name currently associated with the database connection. [21] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` |
| [`server.address`](/docs/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the database host. [22] | `example.com`; `10.1.2.80`; `/tmp/my.sock` |
| [`db.query.parameter.<key>`](/docs/registry/attributes/db.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | string | A database query parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value. [23] | `someval`; `55` |
| [`db.response.returned_rows`](/docs/registry/attributes/db.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | Number of rows returned by the operation. [24] | `10`; `30`; `1000` |
Expand Down Expand Up @@ -190,11 +190,11 @@ and SHOULD be provided **at span creation time** (if provided at all):
* [`db.namespace`](/docs/registry/attributes/db.md)
* [`db.query.summary`](/docs/registry/attributes/db.md)
* [`db.query.text`](/docs/registry/attributes/db.md)
* [`oracle.db.domain`](/docs/registry/attributes/oracledb.md)
* [`oracle.db.instance.name`](/docs/registry/attributes/oracledb.md)
* [`oracle.db.name`](/docs/registry/attributes/oracledb.md)
* [`oracle.db.pdb`](/docs/registry/attributes/oracledb.md)
* [`oracle.db.service`](/docs/registry/attributes/oracledb.md)
* [`oracle.db.domain`](/docs/registry/attributes/oracle.md)
* [`oracle.db.instance.name`](/docs/registry/attributes/oracle.md)
* [`oracle.db.name`](/docs/registry/attributes/oracle.md)
* [`oracle.db.pdb`](/docs/registry/attributes/oracle.md)
* [`oracle.db.service`](/docs/registry/attributes/oracle.md)
* [`server.address`](/docs/registry/attributes/server.md)
* [`server.port`](/docs/registry/attributes/server.md)

Expand Down
9 changes: 8 additions & 1 deletion docs/exceptions/exceptions-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ 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. [2] | `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` [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. [4] | `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.
Expand All @@ -73,6 +72,14 @@ exception instead. For example, in Go, errors created with `fmt.Errorf`
using `%w` MAY be unwrapped when the wrapper type does not help
classify the failure.

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

| Key | Stability | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- |
| [`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. | boolean | Indicates that the exception is escaping the scope of the span. | |

</details>
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->
Expand Down
11 changes: 9 additions & 2 deletions docs/object-stores/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Semantic Conventions for AWS S3 client spans extend the general [AWS SDK Semanti

| Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- | --- |
| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.system.name`. | `Required` | string | The value `aws-api`. | `aws-api` |
| [`aws.extended_request_id`](/docs/registry/attributes/aws.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If available. | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` |
| [`aws.request_id`](/docs/registry/attributes/aws.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` |
| [`aws.s3.bucket`](/docs/registry/attributes/aws.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations. [1] | `some-bucket-name` |
Expand All @@ -34,7 +33,6 @@ Semantic Conventions for AWS S3 client spans extend the general [AWS SDK Semanti
| [`aws.s3.upload_id`](/docs/registry/attributes/aws.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Upload ID that identifies the multipart upload. [6] | `dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ` |
| [`cloud.region`](/docs/registry/attributes/cloud.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The AWS Region where the requested service is being accessed. [7] | `us-east-1`; `us-west-2` |
| [`rpc.method`](/docs/registry/attributes/rpc.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The name of the operation corresponding to the request, as returned by the AWS SDK | `GetItem`; `PutItem` |
| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Value should be included in `rpc.method` which is expected to be a fully-qualified name. | `Recommended` | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` |

**[1] `aws.s3.bucket`:** The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter.
This applies to almost all S3 operations except `list-buckets`.
Expand Down Expand Up @@ -84,6 +82,14 @@ This applies in particular to the following operations:

**[7] `cloud.region`:** Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute's value should adhere to the AWS Region codes outlined in the [AWS documentation](https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-regions.html#available-regions).

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

| Key | Stability | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- |
| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` |
| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` |

---

`rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand All @@ -98,6 +104,7 @@ This applies in particular to the following operations:
| `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) |
| `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) |

</details>
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->
Expand Down
9 changes: 7 additions & 2 deletions docs/registry/attributes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Currently, the following namespaces exist:
- [Artifact](artifact.md)
- [Aspnetcore](aspnetcore.md)
- [AWS](aws.md)
- [Az](az.md)
- [Azure](azure.md)
- [Browser](browser.md)
- [Cassandra](cassandra.md)
Expand Down Expand Up @@ -68,10 +69,10 @@ Currently, the following namespaces exist:
- [Geo](geo.md)
- [Go](go.md)
- [GraphQL](graphql.md)
- [Hardware](hardware.md)
- [Heroku](heroku.md)
- [Host](host.md)
- [HTTP](http.md)
- [Hw](hardware.md)
- [iOS](ios.md)
- [JSONRPC](jsonrpc.md)
- [JVM](jvm.md)
Expand All @@ -80,7 +81,9 @@ Currently, the following namespaces exist:
- [Log](log.md)
- [Mainframe](mainframe.md)
- [MCP](mcp.md)
- [Message](message.md)
- [Messaging](messaging.md)
- [Net](net.md)
- [Network](network.md)
- [NFS](nfs.md)
- [NodeJS](nodejs.md)
Expand All @@ -89,11 +92,13 @@ Currently, the following namespaces exist:
- [OpenAI](openai.md)
- [Openshift](openshift.md)
- [OpenTracing](opentracing.md)
- [Oracle](oracle.md)
- [Oracle Cloud](oracle-cloud.md)
- [OracleDB](oracledb.md)
Comment thread
thompson-tomo marked this conversation as resolved.
- [OS](os.md)
- [OTel](otel.md)
- [Other](other.md)
- [Peer](peer.md)
- [Pool](pool.md)
- [Pprof](pprof.md)
- [Process](process.md)
- [Profile](profile.md)
Expand Down
14 changes: 4 additions & 10 deletions docs/registry/attributes/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,8 @@

# Android

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

## Android Attributes

The Android platform on which the Android application is running.

**Attributes:**

| Key | Stability | Value Type | Description | Example Values |
Expand All @@ -29,11 +24,8 @@ 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 open>
<summary><b>Deprecated Attributes:</b></summary>

| Key | Stability | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- |
Expand All @@ -48,3 +40,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>
2 changes: 0 additions & 2 deletions docs/registry/attributes/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@

## Application Attributes

Describes attributes related to client-side applications (e.g. web apps or mobile apps).

**Attributes:**

| Key | Stability | Value Type | Description | Example Values |
Expand Down
2 changes: 1 addition & 1 deletion docs/registry/attributes/artifact.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
<!-- see templates/registry/markdown/attribute_group_namespace.md.j2 -->

# Artifact

Expand Down
2 changes: 0 additions & 2 deletions docs/registry/attributes/aspnetcore.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@

## ASP.NET Core Attributes

ASP.NET Core attributes

**Attributes:**

| Key | Stability | Value Type | Description | Example Values |
Expand Down
2 changes: 1 addition & 1 deletion docs/registry/attributes/aws.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
<!-- see templates/registry/markdown/attribute_group_namespace.md.j2 -->

# AWS

Expand Down
Loading
Loading