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

Rename/replace (client|server).socket.(address|port) attributes with network.(peer|local).(address|port). #342

Merged
merged 30 commits into from
Oct 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
0f7b90e
alt
trask Sep 20, 2023
0279698
physical
trask Sep 25, 2023
41f6f1f
Merge remote-tracking branch 'upstream/main' into alt-network
trask Sep 26, 2023
93443ef
network.peer.* / network.local.*
trask Sep 26, 2023
00e7a38
Remove proxy.* for now
trask Sep 27, 2023
4cbf9b0
Merge remote-tracking branch 'upstream/main' into alt-network
trask Sep 27, 2023
b41ecd5
attributes.md
trask Sep 27, 2023
2110115
changelog.md
trask Sep 27, 2023
6f9b43b
toc
trask Sep 27, 2023
52b7714
examples
trask Sep 27, 2023
e07ee3d
fix
trask Sep 27, 2023
2957475
toc
trask Sep 27, 2023
975c885
Fix port on image
trask Sep 28, 2023
c5f2688
Unix domain *socket* name
trask Sep 28, 2023
4b450bf
remove redundant
trask Sep 28, 2023
a7e812b
or other POSIX systems
trask Sep 28, 2023
995f7ce
update ports in images
trask Sep 28, 2023
328a2c6
Remove de-duplication
trask Sep 28, 2023
2e941f4
Update docs/general/attributes.md
trask Sep 28, 2023
49d5705
simplify
trask Sep 28, 2023
1a14e45
Merge branch 'alt-network' of https://github.com/trask/semantic-conve…
trask Sep 28, 2023
0d7d06b
toc
trask Sep 28, 2023
3590acf
tables
trask Sep 28, 2023
24b2689
Merge remote-tracking branch 'upstream/main' into alt-network
trask Oct 2, 2023
f2a0c2a
remove source and destination domain attribute
trask Oct 2, 2023
6039383
fix
trask Oct 2, 2023
d714318
Merge remote-tracking branch 'upstream/main' into alt-network
trask Oct 3, 2023
ab91760
Merge branch 'main' into alt-network
trask Oct 9, 2023
94b35a7
empty
trask Oct 9, 2023
0b74968
Merge remote-tracking branch 'upstream/main' into alt-network
trask Oct 9, 2023
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ release.
([#366](https://github.com/open-telemetry/semantic-conventions/pull/366))
- Add `host.ip` resource attribute convention.
([#203](https://github.com/open-telemetry/semantic-conventions/pull/203))
- BREAKING: Rename/replace `(client|server).socket.(address|port)` attributes
with `network.(peer|local).(address|port)`.
([#342](https://github.com/open-telemetry/semantic-conventions/pull/342))

## v1.21.0 (2023-07-13)

Expand Down
19 changes: 4 additions & 15 deletions docs/database/database-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ Some database systems may allow a connection to switch to a different `db.user`,
| `db.connection_string` | string | The connection string used to connect to the database. It is recommended to remove embedded credentials. | `Server=(localdb)\v11.0;Integrated Security=true;` | Recommended |
| `db.system` | string | An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers. | `other_sql` | Required |
| `db.user` | string | Username for accessing the database. | `readonly_user`; `reporting_user` | Recommended |
| [`network.peer.address`](../general/attributes.md) | string | Peer address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` | Recommended: If different than `server.address`. |
| [`network.peer.port`](../general/attributes.md) | int | Peer port number of the network connection. | `65123` | Recommended: If `network.peer.address` is set. |
| [`network.transport`](../general/attributes.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://en.wikipedia.org/wiki/Inter-process_communication). [1] | `tcp`; `udp` | Recommended |
| [`network.type`](../general/attributes.md) | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [2] | `ipv4`; `ipv6` | Recommended |
| [`server.address`](../general/attributes.md) | string | Name of the database host. [3] | `example.com` | Conditionally Required: See alternative attributes below. |
| [`server.port`](../general/attributes.md) | int | Server port number [4] | `80`; `8080`; `443` | Conditionally Required: [5] |
| [`server.socket.address`](../general/attributes.md) | string | Server address of the socket connection - IP address or Unix domain socket name. [6] | `10.5.3.2` | See below |
| [`server.socket.port`](../general/attributes.md) | int | Server port number of the socket connection. [7] | `16456` | Recommended: If different than `server.port`. |
| [`server.address`](../general/attributes.md) | string | Name of the database host. [3] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
| [`server.port`](../general/attributes.md) | int | Server port number. [4] | `80`; `8080`; `443` | Conditionally Required: [5] |

**[1]:** The value SHOULD be normalized to lowercase.

Expand All @@ -89,17 +89,6 @@ the server address behind any intermediaries (e.g. proxies) if it's available.

**[5]:** If using a port other than the default port for this DBMS and if `server.address` is set.

**[6]:** When observed from the client side, this SHOULD represent the immediate server peer address.
When observed from the server side, this SHOULD represent the physical server address.

**[7]:** When observed from the client side, this SHOULD represent the immediate server peer port.
When observed from the server side, this SHOULD represent the physical server port.

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

* [`server.address`](../general/attributes.md)
* [`server.socket.address`](../general/attributes.md)

`db.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.

| Value | Description |
Expand Down
4 changes: 2 additions & 2 deletions docs/database/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ If the endpoint id is not available, the span name SHOULD be the `http.request.m
| [`db.operation`](database-spans.md) | string | The endpoint identifier for the request. [4] | `search`; `ml.close_job`; `cat.aliases` | Required |
| [`db.statement`](database-spans.md) | string | The request body for a [search-type query](https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html), as a json string. | `"{\"query\":{\"term\":{\"user.id\":\"kimchy\"}}}"` | Recommended: [5] |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [6] | `GET`; `POST`; `HEAD` | Required |
| [`server.address`](../general/attributes.md) | string | Name of the database host. [7] | `example.com` | Conditionally Required: See alternative attributes below. |
| [`server.port`](../general/attributes.md) | int | Server port number [8] | `80`; `8080`; `443` | Conditionally Required: [9] |
| [`server.address`](../general/attributes.md) | string | Name of the database host. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
| [`server.port`](../general/attributes.md) | int | Server port number. [8] | `80`; `8080`; `443` | Conditionally Required: [9] |
| [`url.full`](../url/url.md) | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [10] | `https://localhost:9200/index/_search?q=user.id:kimchy` | Required |

**[1]:** When communicating with an Elastic Cloud deployment, this should be collected from the "X-Found-Handling-Cluster" HTTP response header.
Expand Down
Loading
Loading