From 5b888ae04108e17af7b70a039c93ac0c6f1644d3 Mon Sep 17 00:00:00 2001 From: JamieDanielson Date: Tue, 26 Mar 2024 17:29:18 -0400 Subject: [PATCH 1/2] docs(instr-http): document semantic conventions in use --- .../README.md | 34 ++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/experimental/packages/opentelemetry-instrumentation-http/README.md b/experimental/packages/opentelemetry-instrumentation-http/README.md index 8fd50c3107..3be82a4e19 100644 --- a/experimental/packages/opentelemetry-instrumentation-http/README.md +++ b/experimental/packages/opentelemetry-instrumentation-http/README.md @@ -67,7 +67,39 @@ The following options are deprecated: | Options | Type | Description | | ------- | ---- | ----------- | | `ignoreIncomingPaths` | `IgnoreMatcher[]` | Http instrumentation will not trace all incoming requests that match paths | -| `ignoreOutgoingUrls` | `IgnoreMatcher[]` | Http instrumentation will not trace all outgoing requests that match URLs | + +## Semantic Conventions + +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) + +Attributes collected: + +| Attribute | Short Description | Notes | +| ------------------------------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------- | +| `ip_tcp` | Transport protocol used | Key: `NETTRANSPORTVALUES_IP_TCP` | +| `ip_udp` | Transport protocol used | Key: `NETTRANSPORTVALUES_IP_UDP` | +| `http.client_ip` | The IP address of the original client behind all proxies, if known | Key: `SEMATTRS_HTTP_CLIENT_IP` | +| `http.flavor` | Kind of HTTP protocol used | Key: `SEMATTRS_HTTP_FLAVOR` | +| `http.host` | The value of the HTTP host header | Key: `SEMATTRS_HTTP_HOST` | +| `http.method` | HTTP request method | Key: `SEMATTRS_HTTP_METHOD` | +| `http.request_content_length` | The size of the request payload body in bytes | Key: `SEMATTRS_HTTP_REQUEST_CONTENT_LENGTH` | +| `http.request_content_length_uncompressed` | The size of the uncompressed request payload body after transport decoding | Key: `SEMATTRS_HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED` | +| `http.response_content_length` | The size of the response payload body in bytes | Key: `SEMATTRS_HTTP_RESPONSE_CONTENT_LENGTH` | +| `http.response_content_length_uncompressed` | The size of the uncompressed response payload body after transport decoding | Key: `SEMATTRS_HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED` | +| `http.route` | The matched route (path template). | Key: `SEMATTRS_HTTP_ROUTE` | +| `http.scheme` | The URI scheme identifying the used protocol | Key: `SEMATTRS_HTTP_SCHEME` | +| `http.server_name` | The primary server name of the matched virtual host | Key: `SEMATTRS_HTTP_SERVER_NAME` | +| `http.status_code` | HTTP response status code | Key: `SEMATTRS_HTTP_STATUS_CODE` | +| `http.target` | The full request target as passed in a HTTP request line or equivalent | Key: `SEMATTRS_HTTP_TARGET` | +| `http.url` | Full HTTP request URL in the form `scheme://host[:port]/path?query[#fragment]` | Key: `SEMATTRS_HTTP_URL` | +| `http.user_agent` | Value of the HTTP User-Agent header sent by the client | Key: `SEMATTRS_HTTP_USER_AGENT` | +| `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` | +| `net.host.name` | Local hostname or similar | Key: `SEMATTRS_NET_HOST_NAME` | +| `net.host.port` | Like net.peer.port but for the host port | Key: `SEMATTRS_NET_HOST_PORT` | +| `net.peer.ip.` | Remote address of the peer (dotted decimal for IPv4 or RFC5952 for IPv6) | Key: `SEMATTRS_NET_PEER_IP` | +| `net.peer.name` | Remote hostname or similar | Key: `SEMATTRS_NET_PEER_NAME` | +| `net.peer.port` | Remote port number | Key: `SEMATTRS_NET_PEER_PORT` | +| `net.transport` | Transport protocol used | Key: `SEMATTRS_NET_TRANSPORT` | ## Useful links From fd72c9f45cfc4ee28a47480e6d660fc75484601f Mon Sep 17 00:00:00 2001 From: JamieDanielson Date: Tue, 26 Mar 2024 17:41:18 -0400 Subject: [PATCH 2/2] add changelog entry --- experimental/CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md index 62588e6877..b2562c8e09 100644 --- a/experimental/CHANGELOG.md +++ b/experimental/CHANGELOG.md @@ -35,6 +35,8 @@ All notable changes to experimental packages in this project will be documented ### :books: (Refine Doc) +* docs(instr-http): document semantic conventions and attributes in use. [#4587](https://github.com/open-telemetry/opentelemetry-js/pull/4587/) @JamieDanielson + ### :house: (Internal) ## 0.49.1