Skip to content

Commit

Permalink
Merge + applied feedbacks #1231
Browse files Browse the repository at this point in the history
  • Loading branch information
ezimuel committed Jul 17, 2024
2 parents fa8ee30 + 02ecf0c commit 7068720
Show file tree
Hide file tree
Showing 140 changed files with 676 additions and 536 deletions.
7 changes: 7 additions & 0 deletions .chloggen/1156.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
change_type: breaking

component: messaging

note: Rename `messaging.kafka.message.offset` to `messaging.kafka.offset`

issues: [1156]
22 changes: 22 additions & 0 deletions .chloggen/1166.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: db

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Sampling relevant attributes defined for database client spans

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [ 1019 ]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
4 changes: 4 additions & 0 deletions .chloggen/1239.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: enhancement
component: network
note: Add QUIC to the list of well known network transports
issues: [ 1237, 1239 ]
4 changes: 4 additions & 0 deletions .chloggen/1241.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: breaking
component: messaging
note: Deprecate `messaging.destination_publish.*`` namespace and remove all usages.
issues: [ 1178, 1241 ]
22 changes: 22 additions & 0 deletions .chloggen/1243.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: db

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "`db.query.text` IN-clauses MAY be collapsed during the sanitization process"

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [ 1053 ]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
4 changes: 4 additions & 0 deletions .chloggen/1244.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: enhancement
component: db, messaging
note: Clarify that DB and messaging system-specific conventions override common ones
issues: [ 1235, 1244 ]
5 changes: 5 additions & 0 deletions .chloggen/cloud-events-restructure.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
change_type: 'enhancement'
component: cloudevents
note: CloudEvents conventions to follow HTTP/Messaging Span conventions
issues: [654]
subtext:
22 changes: 22 additions & 0 deletions .chloggen/log-original-body.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: log

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add 'log.record.original' attribute.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [1137]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ environment configured:
### 1. Modify the YAML model

Refer to the
[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.24.0/semantic-conventions/syntax.md)
[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.25.0/semantic-conventions/syntax.md)
to learn how to make changes to the YAML files.

#### Schema files
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ CHLOGGEN_CONFIG := .chloggen/config.yaml

# see https://github.com/open-telemetry/build-tools/releases for semconvgen updates
# Keep links in model/README.md and .vscode/settings.json in sync!
SEMCONVGEN_VERSION=0.24.0
SEMCONVGEN_VERSION=0.25.0
WEAVER_VERSION=0.5.0

# From where to resolve the containers (e.g. "otel/weaver").
Expand Down
6 changes: 3 additions & 3 deletions docs/attributes-registry/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

# Android

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

## Android Attributes

Expand All @@ -17,7 +17,7 @@ The Android platform on which the Android application is running.
| ---------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ---------------------------------------------------------------- |
| `android.os.api_level` | string | Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Android Deprecated Attributes
## Deprecated Android Attributes

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

Expand Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/aspnetcore.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Aspnetcore

## Aspnetcore Attributes
## ASP.NET Core Attributes

ASP.NET Core attributes

Expand Down
28 changes: 14 additions & 14 deletions docs/attributes-registry/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@

# AWS

- [Aws](#aws-attributes)
- [Aws Dynamodb](#aws-dynamodb-attributes)
- [Aws Ecs](#aws-ecs-attributes)
- [Aws Eks](#aws-eks-attributes)
- [Aws Lambda](#aws-lambda-attributes)
- [Aws Log](#aws-log-attributes)
- [Aws S3](#aws-s3-attributes)
- [General AWS Attributes](#general-aws-attributes)
- [Amazon DynamoDB Attributes](#amazon-dynamodb-attributes)
- [Amazon ECS Attributes](#amazon-ecs-attributes)
- [Amazon EKS Attributes](#amazon-eks-attributes)
- [Amazon Lambda Attributes](#amazon-lambda-attributes)
- [Amazon Logs Attributes](#amazon-logs-attributes)
- [Amazon S3 Attributes](#amazon-s3-attributes)

## AWS Attributes
## General AWS Attributes

This document defines generic attributes for AWS services.

| Attribute | Type | Description | Examples | Stability |
| ---------------- | ------ | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
| `aws.request_id` | string | The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## AWS DynamoDB Attributes
## Amazon DynamoDB Attributes

This document defines attributes for AWS DynamoDB.

Expand Down Expand Up @@ -51,7 +51,7 @@ This document defines attributes for AWS DynamoDB.
| `aws.dynamodb.table_names` | string[] | The keys in the `RequestItems` object field. | `["Users", "Cats"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `aws.dynamodb.total_segments` | int | The value of the `TotalSegments` request parameter. | `100` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## AWS ECS Attributes
## Amazon ECS Attributes

This document defines attributes for AWS Elastic Container Service (ECS).

Expand All @@ -72,15 +72,15 @@ This document defines attributes for AWS Elastic Container Service (ECS).
| `ec2` | ec2 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `fargate` | fargate | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## AWS EKS Attributes
## Amazon EKS Attributes

This document defines attributes for AWS Elastic Kubernetes Service (EKS).

| Attribute | Type | Description | Examples | Stability |
| --------------------- | ------ | -------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------- |
| `aws.eks.cluster.arn` | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## AWS Lambda Attributes
## Amazon Lambda Attributes

This document defines attributes for AWS Lambda.

Expand All @@ -90,7 +90,7 @@ This document defines attributes for AWS Lambda.

**[1]:** This may be different from `cloud.resource_id` if an alias is involved.

## AWS Log Attributes
## Amazon Logs Attributes

This document defines attributes for AWS Logs.

Expand All @@ -107,7 +107,7 @@ This document defines attributes for AWS Logs.

**[4]:** See the [log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream.

## AWS S3 Attributes
## Amazon S3 Attributes

This document defines attributes for AWS S3.

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

# Container

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

## Container Attributes

Expand Down Expand Up @@ -35,7 +35,7 @@ The ID is assigned by the container runtime and can vary in different environmen

**[3]:** [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field.

## Container Deprecated Attributes
## Deprecated Container Attributes

Describes deprecated container attributes.

Expand Down
41 changes: 25 additions & 16 deletions docs/attributes-registry/db.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,24 @@

# Db

<<<<<<< HEAD
- [Db](#db-attributes)
- [Db Cassandra](#db-cassandra-attributes)
- [Db Cosmosdb](#db-cosmosdb-attributes)
- [Db Deprecated](#db-deprecated-attributes)
- [Db Elasticsearch](#db-elasticsearch-attributes)
- [Db Metrics Deprecated](#db-metrics-deprecated-attributes)
- [Db Vector](#db-vector-attributes)
=======
- [General Database Attributes](#general-database-attributes)
- [Cassandra Attributes](#cassandra-attributes)
- [Azure Cosmos DB Attributes](#azure-cosmos-db-attributes)
- [Elasticsearch Attributes](#elasticsearch-attributes)
- [Deprecated Database Attributes](#deprecated-database-attributes)
- [Deprecated Database Metrics](#deprecated-database-metrics)
>>>>>>> upstream/main
## Db Attributes
## General Database Attributes

This group defines the attributes used to describe telemetry in the context of databases.

Expand Down Expand Up @@ -120,7 +129,7 @@ Even though parameterized query text can potentially have sensitive data, by usi
| `vector` | vector | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `vertica` | Vertica | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Db Cassandra Attributes
## Cassandra Attributes

This group defines attributes for Cassandra.

Expand Down Expand Up @@ -149,7 +158,7 @@ This group defines attributes for Cassandra.
| `three` | three | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `two` | two | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Db CosmosDB Attributes
## Azure Cosmos DB Attributes

This group defines attributes for Azure Cosmos DB.

Expand Down Expand Up @@ -190,7 +199,18 @@ This group defines attributes for Azure Cosmos DB.
| `Replace` | replace | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Upsert` | upsert | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Db Deprecated Attributes
## Elasticsearch Attributes

This group defines attributes for Elasticsearch.

| Attribute | Type | Description | Examples | Stability |
| ----------------------------------- | ------ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `db.elasticsearch.node.name` | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.elasticsearch.path_parts.<key>` | string | A dynamic value in the url path. [8] | `db.elasticsearch.path_parts.index=test-index`; `db.elasticsearch.path_parts.doc_id=123` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[8]:** Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.<key>`, where `<key>` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names.

## Deprecated Database Attributes

"Describes deprecated db attributes."

Expand All @@ -211,18 +231,7 @@ This group defines attributes for Azure Cosmos DB.
| `db.statement` | string | The database statement being executed. | `SELECT * FROM wuser_table`; `SET mykey "WuValue"` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `db.query.text`. |
| `db.user` | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>No replacement at this time. |

## Db Elasticsearch Attributes

This group defines attributes for Elasticsearch.

| Attribute | Type | Description | Examples | Stability |
| ----------------------------------- | ------ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `db.elasticsearch.node.name` | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.elasticsearch.path_parts.<key>` | string | A dynamic value in the url path. [8] | `db.elasticsearch.path_parts.index=test-index`; `db.elasticsearch.path_parts.doc_id=123` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[8]:** Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.<key>`, where `<key>` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names.

## Db Metrics Deprecated Attributes
## Deprecated Database Metrics

"Describes deprecated db metrics attributes."

Expand Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Dns

## Dns Attributes
## DNS Attributes

This document defines the shared attributes used to report a DNS query.

Expand Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/enduser.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Enduser

## Enduser Deprecated Attributes
## Deprecated End User Attributes

Describes deprecated enduser attributes. Complete enduser namespace has been deprecated

Expand Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/faas.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Faas

## Faas Attributes
## Function as a Service Attributes

FaaS attributes

Expand Down
Loading

0 comments on commit 7068720

Please sign in to comment.