Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] change prefix for deprecated attributes #898

Merged
merged 4 commits into from
Apr 8, 2024
Merged
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
15 changes: 15 additions & 0 deletions docs/attributes-registry/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@

# Container

<!-- toc -->

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

<!-- tocstop -->

## Container Attributes

<!-- semconv registry.container(omit_requirement_level) -->
Expand Down Expand Up @@ -37,3 +44,11 @@ The ID is assinged by the container runtime and can vary in different environmen
| `system` | When CPU is used by the system (host OS) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->

## Deprecated Container Attributes

<!-- semconv registry.container.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `container.labels.<key>` | string | Deprecated, use `container.label` instead. | `container.label.app=nginx` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `container.label`. |
<!-- endsemconv -->
14 changes: 1 addition & 13 deletions docs/attributes-registry/db.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
- [Redis Attributes](#redis-attributes)
- [SQL Attributes](#sql-attributes)
- [Deprecated DB Attributes](#deprecated-db-attributes)
- [Deprecated Elasticsearch Attributes](#deprecated-elasticsearch-attributes)

<!-- tocstop -->

Expand Down Expand Up @@ -213,18 +212,7 @@

## Deprecated DB Attributes

<!-- semconv attributes.db.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>"Replaced by `server.address` and `server.port`." |
| `db.elasticsearch.node.name` | string | Deprecated, use `db.instance.id` instead. | `instance-0000000001` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `db.instance.id`. |
| `db.jdbc.driver_classname` | string | Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed as not used. |
| `db.operation` | string | Deprecated, use `db.operation.name` instead. | `findAndModify`; `HMSET`; `SELECT` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `db.operation.name`. |
<!-- endsemconv -->

### Deprecated Elasticsearch Attributes

<!-- semconv attributes.db.deprecated(omit_requirement_level) -->
<!-- semconv registry.db.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>"Replaced by `server.address` and `server.port`." |
Expand Down
9 changes: 8 additions & 1 deletion docs/attributes-registry/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@

# HTTP

<!-- toc -->

- [HTTP Attributes](#http-attributes)
- [Deprecated HTTP Attributes](#deprecated-http-attributes)

<!-- tocstop -->

## HTTP Attributes

<!-- semconv registry.http(omit_requirement_level) -->
Expand Down Expand Up @@ -74,7 +81,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin

## Deprecated HTTP Attributes

<!-- semconv attributes.http.deprecated(omit_requirement_level) -->
<!-- semconv registry.http.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `http.flavor` | string | Deprecated, use `network.protocol.name` instead. | `1.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.protocol.name`. |
Expand Down
17 changes: 16 additions & 1 deletion docs/attributes-registry/k8s.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Kubernetes

## Kubernetes Resource Attributes
<!-- toc -->

- [Kubernetes Attributes](#kubernetes-attributes)
- [Deprecated Kubernetes Attributes](#deprecated-kubernetes-attributes)

<!-- tocstop -->

## Kubernetes Attributes

<!-- semconv registry.k8s(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
Expand Down Expand Up @@ -52,3 +59,11 @@ Which states:
Therefore, UIDs between clusters should be extremely unlikely to
conflict.
<!-- endsemconv -->

## Deprecated Kubernetes Attributes

<!-- semconv registry.k8s.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `k8s.pod.labels.<key>` | string | Deprecated, use `k8s.pod.label` instead. | `k8s.pod.label.app=my-app` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `k8s.pod.label`. |
<!-- endsemconv -->
2 changes: 1 addition & 1 deletion docs/attributes-registry/messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ size should be used.

## Deprecated Messaging Attributes

<!-- semconv attributes.messaging.deprecated(omit_requirement_level) -->
<!-- semconv registry.messaging.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `messaging.kafka.destination.partition` | int | "Deprecated, use `messaging.destination.partition.id` instead." | `2` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `messaging.destination.partition.id`. |
Expand Down
9 changes: 8 additions & 1 deletion docs/attributes-registry/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@

These attributes may be used for any network related operation.

<!-- toc -->

- [Network Attributes](#network-attributes)
- [Deprecated Network Attributes](#deprecated-network-attributes)

<!-- tocstop -->

## Network Attributes

<!-- semconv registry.network(omit_requirement_level) -->
Expand Down Expand Up @@ -100,7 +107,7 @@ different processes could be listening on TCP port 12345 and UDP port 12345.

## Deprecated Network Attributes

<!-- semconv attributes.network.deprecated(omit_requirement_level) -->
<!-- semconv registry.network.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `server.address`. |
Expand Down
18 changes: 17 additions & 1 deletion docs/attributes-registry/otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,27 @@

# OpenTelemetry

## Scope Attributes
<!-- toc -->

- [OpenTelemetry Attributes](#opentelemetry-attributes)
- [Deprecated OpenTelemetry Attributes](#deprecated-opentelemetry-attributes)

<!-- tocstop -->

## OpenTelemetry Attributes

<!-- semconv registry.otel.scope(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
<!-- endsemconv -->

## Deprecated OpenTelemetry Attributes

<!-- semconv registry.otel.library.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `otel.library.name` | string | None | `io.opentelemetry.contrib.mongodb` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>use the `otel.scope.name` attribute. |
| `otel.library.version` | string | None | `1.0.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>use the `otel.scope.version` attribute. |
<!-- endsemconv -->
25 changes: 25 additions & 0 deletions docs/attributes-registry/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@

# RPC

<!-- toc -->

- [RPC Attributes](#rpc-attributes)
- [Deprecated RPC Attributes](#deprecated-rpc-attributes)

<!-- tocstop -->

## RPC Attributes

RPC attributes are intended to be used in the context of events related to remote procedure calls (RPC).
Expand Down Expand Up @@ -102,3 +109,21 @@ RPC attributes are intended to be used in the context of events related to remot
| `apache_dubbo` | Apache Dubbo | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `connect_rpc` | Connect RPC | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->

## Deprecated RPC Attributes

<!-- semconv registry.rpc.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `message.compressed_size` | int | Deprecated, use `rpc.message.compressed_size` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.message.compressed_size`. |
| `message.id` | int | Deprecated, use `rpc.message.id` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.message.id`. |
| `message.type` | string | Deprecated, use `rpc.message.type` instead. | `SENT` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.message.type`. |
| `message.uncompressed_size` | int | Deprecated, use `rpc.message.uncompressed_size` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `rpc.message.uncompressed_size`. |

`message.type` MUST be one of the following:

| Value | Description | Stability |
|---|---|---|
| `SENT` | sent | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `RECEIVED` | received | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->
2 changes: 1 addition & 1 deletion model/registry/deprecated/container.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.container.deprecated
- id: registry.container.deprecated
type: attribute_group
brief: "Describes deprecated container attributes."
attributes:
Expand Down
2 changes: 1 addition & 1 deletion model/registry/deprecated/db.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.db.deprecated
- id: registry.db.deprecated
prefix: db
type: attribute_group
brief: >
Expand Down
2 changes: 1 addition & 1 deletion model/registry/deprecated/http.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.http.deprecated
- id: registry.http.deprecated
type: attribute_group
brief: "Describes deprecated HTTP attributes."
prefix: http
Expand Down
2 changes: 1 addition & 1 deletion model/registry/deprecated/k8s.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.k8s.deprecated
- id: registry.k8s.deprecated
type: attribute_group
brief: "Describes deprecated k8s attributes."
attributes:
Expand Down
2 changes: 1 addition & 1 deletion model/registry/deprecated/messaging.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.messaging.deprecated
- id: registry.messaging.deprecated
type: attribute_group
brief: "Describes deprecated messaging attributes."
attributes:
Expand Down
2 changes: 1 addition & 1 deletion model/registry/deprecated/network.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.network.deprecated
- id: registry.network.deprecated
prefix: net
type: attribute_group
brief: >
Expand Down
7 changes: 3 additions & 4 deletions model/registry/deprecated/otel.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
groups:
- id: otel.library
- id: registry.otel.library.deprecated
prefix: otel.library
type: resource
brief: >
Span attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts.
type: attribute_group
brief: "Describes deprecated otel.library attributes."
attributes:
- id: name
type: string
Expand Down
2 changes: 1 addition & 1 deletion model/registry/deprecated/rpc.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.rpc.deprecated
- id: registry.rpc.deprecated
type: attribute_group
brief: 'Deprecated rpc message attributes.'
attributes:
Expand Down
2 changes: 1 addition & 1 deletion model/registry/deprecated/system.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
groups:
- id: attributes.system.deprecated
- id: registry.system.deprecated
type: attribute_group
brief: "Deprecated system attributes."
attributes:
Expand Down
Loading