Skip to content

Commit

Permalink
Merge branch 'main' into mx-psi/ecs-conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderWert authored Dec 14, 2023
2 parents 6b20de2 + bef6b4b commit 1ee4524
Show file tree
Hide file tree
Showing 13 changed files with 104 additions and 69 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,20 @@ 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))
- JVM metrics marked stable
([#569](https://github.com/open-telemetry/semantic-conventions/pull/569))

### Fixes

- Remove misleading pluralization wording related to count metrics
([#488](https://github.com/open-telemetry/semantic-conventions/pull/488))
- Remove no longer relevant Oct 1 mention from `OTEL_SEMCONV_STABILITY_OPT_IN`
([#541](https://github.com/open-telemetry/semantic-conventions/pull/541))
- Update stability definitions of HTTP client and server duration metrics to
be consistent with markdown.
([#587](https://github.com/open-telemetry/semantic-conventions/pull/587))
- Use `deprecated` property to mark attributes as deprecated instead of `stability`
([#588](https://github.com/open-telemetry/semantic-conventions/pull/588))

## v1.23.1 (2023-11-17)

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ Maintainers ([@open-telemetry/specs-semconv-maintainers](https://github.com/orgs
- [Josh Suereth](https://github.com/jsuereth), Google
- [Reiley Yang](https://github.com/reyang), Microsoft

_Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).
_Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer)._
18 changes: 9 additions & 9 deletions docs/attributes-registry/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
<!-- semconv attributes.http.deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `http.flavor` | string | Deprecated, use `network.protocol.name` instead. | `1.0` |
| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` |
| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` |
| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` |
| `http.scheme` | string | Deprecated, use `url.scheme` instead. | `http`; `https` |
| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` |
| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` |
| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` |
| `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1` |
| `http.flavor` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.protocol.name` instead. | `1.0` |
| `http.method` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` |
| `http.request_content_length` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.request.header.content-length` instead. | `3495` |
| `http.response_content_length` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.response.header.content-length` instead. | `3495` |
| `http.scheme` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `url.scheme` instead. | `http`; `https` |
| `http.status_code` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `http.response.status_code` instead. | `200` |
| `http.target` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` |
| `http.url` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` |
| `http.user_agent` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `user_agent.original` instead. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1` |

`http.flavor` 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 Down
26 changes: 13 additions & 13 deletions docs/attributes-registry/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,19 @@ different processes could be listening on TCP port 12345 and UDP port 12345.
<!-- semconv network-deprecated(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` |
| `net.host.port` | int | Deprecated, use `server.port`. | `8080` |
| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` |
| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` |
| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` |
| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` |
| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet` |
| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` |
| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` |
| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` |
| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` |
| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` |
| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp` |
| `net.host.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.address`. | `example.com` |
| `net.host.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.port`. | `8080` |
| `net.peer.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` |
| `net.peer.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` |
| `net.protocol.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` |
| `net.protocol.version` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.protocol.version`. | `3.1.1` |
| `net.sock.family` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.transport` and `network.type`. | `inet` |
| `net.sock.host.addr` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.local.address`. | `/var/my.sock` |
| `net.sock.host.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.local.port`. | `8080` |
| `net.sock.peer.addr` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.peer.address`. | `192.168.0.1` |
| `net.sock.peer.name` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, no replacement at this time. | `/var/my.sock` |
| `net.sock.peer.port` | int | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.peer.port`. | `65531` |
| `net.transport` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `network.transport`. | `ip_tcp` |

`net.sock.family` 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 Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| `process.executable.name` | string | The name of the process executable. On Linux based systems, can be set to the `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of `GetProcessImageFileNameW`. | `otelcol` |
| `process.executable.path` | string | The full path to the process executable. On Linux based systems, can be set to the target of `proc/[pid]/exe`. On Windows, can be set to the result of `GetProcessImageFileNameW`. | `/usr/bin/cmd/otelcol` |
| `process.owner` | string | The username of the user that owns the process. | `root` |
| `process.parent_pid` | int | Parent Process identifier (PID). | `111` |
| `process.parent_pid` | int | Parent Process identifier (PPID). | `111` |
| `process.pid` | int | Process identifier (PID). | `1234` |
| `process.runtime.description` | string | An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. | `Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0` |
| `process.runtime.name` | string | The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler. | `OpenJDK Runtime Environment` |
Expand Down
6 changes: 3 additions & 3 deletions docs/http/http-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,15 +388,15 @@ The following attributes can be important for making sampling decisions and SHOU

### HTTP client-server example

As an example, if a browser request for `https://example.com:8080/webshop/articles/4?s=1` is invoked from a host with IP 192.0.2.4, we may have the following Span on the client side:
As an example, if a browser request for `https://example.com:8080/webshop/articles/4?s=1&t=2` is invoked from a host with IP 192.0.2.4, we may have the following Span on the client side:

Span name: `GET`

| Attribute name | Value |
| :------------------- | :-------------------------------------------------------|
| `http.request.method`| `"GET"` |
| `network.protocol.version` | `"1.1"` |
| `url.full` | `"https://example.com:8080/webshop/articles/4?s=1"` |
| `url.full` | `"https://example.com:8080/webshop/articles/4?s=1&t=2"` |
| `server.address` | `example.com` |
| `server.port` | `8080` |
| `network.peer.address` | `"192.0.2.5"` |
Expand All @@ -412,7 +412,7 @@ Span name: `GET /webshop/articles/:article_id`.
| `http.request.method`| `"GET"` |
| `network.protocol.version` | `"1.1"` |
| `url.path` | `"/webshop/articles/4"` |
| `url.query` | `"?s=1"` |
| `url.query` | `"s=1&t=2"` |
| `server.address` | `"example.com"` |
| `server.port` | `8080` |
| `url.scheme` | `"https"` |
Expand Down
2 changes: 1 addition & 1 deletion docs/resource/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
| [`process.executable.name`](../attributes-registry/process.md) | string | The name of the process executable. On Linux based systems, can be set to the `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of `GetProcessImageFileNameW`. | `otelcol` | Conditionally Required: See alternative attributes below. |
| [`process.executable.path`](../attributes-registry/process.md) | string | The full path to the process executable. On Linux based systems, can be set to the target of `proc/[pid]/exe`. On Windows, can be set to the result of `GetProcessImageFileNameW`. | `/usr/bin/cmd/otelcol` | Conditionally Required: See alternative attributes below. |
| [`process.owner`](../attributes-registry/process.md) | string | The username of the user that owns the process. | `root` | Recommended |
| [`process.parent_pid`](../attributes-registry/process.md) | int | Parent Process identifier (PID). | `111` | Recommended |
| [`process.parent_pid`](../attributes-registry/process.md) | int | Parent Process identifier (PPID). | `111` | Recommended |
| [`process.pid`](../attributes-registry/process.md) | int | Process identifier (PID). | `1234` | Recommended |

**Additional attribute requirements:** At least one of the following sets of attributes is required:
Expand Down
Loading

0 comments on commit 1ee4524

Please sign in to comment.