You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: experimental/CHANGELOG.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,8 @@ All notable changes to experimental packages in this project will be documented
36
36
37
37
### :books: (Refine Doc)
38
38
39
+
* docs(instr-http): document semantic conventions and attributes in use. [#4587](https://github.com/open-telemetry/opentelemetry-js/pull/4587/)@JamieDanielson
Copy file name to clipboardExpand all lines: experimental/packages/opentelemetry-instrumentation-http/README.md
+33-1Lines changed: 33 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,39 @@ The following options are deprecated:
67
67
| Options | Type | Description |
68
68
| ------- | ---- | ----------- |
69
69
|`ignoreIncomingPaths`|`IgnoreMatcher[]`| Http instrumentation will not trace all incoming requests that match paths |
70
-
|`ignoreOutgoingUrls`|`IgnoreMatcher[]`| Http instrumentation will not trace all outgoing requests that match URLs |
70
+
71
+
## Semantic Conventions
72
+
73
+
This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
|`http.request_content_length`| The size of the request payload body in bytes | Key: `SEMATTRS_HTTP_REQUEST_CONTENT_LENGTH`|
86
+
|`http.request_content_length_uncompressed`| The size of the uncompressed request payload body after transport decoding | Key: `SEMATTRS_HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED`|
87
+
|`http.response_content_length`| The size of the response payload body in bytes | Key: `SEMATTRS_HTTP_RESPONSE_CONTENT_LENGTH`|
88
+
|`http.response_content_length_uncompressed`| The size of the uncompressed response payload body after transport decoding | Key: `SEMATTRS_HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED`|
89
+
|`http.route`| The matched route (path template). | Key: `SEMATTRS_HTTP_ROUTE`|
90
+
|`http.scheme`| The URI scheme identifying the used protocol | Key: `SEMATTRS_HTTP_SCHEME`|
91
+
|`http.server_name`| The primary server name of the matched virtual host | Key: `SEMATTRS_HTTP_SERVER_NAME`|
92
+
|`http.status_code`| HTTP response status code | Key: `SEMATTRS_HTTP_STATUS_CODE`|
93
+
|`http.target`| The full request target as passed in a HTTP request line or equivalent | Key: `SEMATTRS_HTTP_TARGET`|
94
+
|`http.url`| Full HTTP request URL in the form `scheme://host[:port]/path?query[#fragment]`| Key: `SEMATTRS_HTTP_URL`|
95
+
|`http.user_agent`| Value of the HTTP User-Agent header sent by the client | Key: `SEMATTRS_HTTP_USER_AGENT`|
96
+
|`net.host.ip`| Like net.peer.ip but for the host IP. Useful in case of a multi-IP host | Key: `SEMATTRS_NET_HOST_IP`|
97
+
|`net.host.name`| Local hostname or similar | Key: `SEMATTRS_NET_HOST_NAME`|
98
+
|`net.host.port`| Like net.peer.port but for the host port | Key: `SEMATTRS_NET_HOST_PORT`|
99
+
|`net.peer.ip.`| Remote address of the peer (dotted decimal for IPv4 or RFC5952 for IPv6) | Key: `SEMATTRS_NET_PEER_IP`|
100
+
|`net.peer.name`| Remote hostname or similar | Key: `SEMATTRS_NET_PEER_NAME`|
101
+
|`net.peer.port`| Remote port number | Key: `SEMATTRS_NET_PEER_PORT`|
102
+
|`net.transport`| Transport protocol used | Key: `SEMATTRS_NET_TRANSPORT`|
0 commit comments