@opentelemetry/instrumentation-http

What is @opentelemetry/instrumentation-http?

The @opentelemetry/instrumentation-http package is part of the OpenTelemetry project, which provides a collection of tools, APIs, and SDKs to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) to help you analyze your software's performance and behavior. This specific package provides automatic instrumentation for HTTP and HTTPS requests in Node.js applications, allowing developers to capture detailed information about incoming and outgoing requests.

What are @opentelemetry/instrumentation-http's main functionalities?

Automatic Tracing of HTTP Requests

This feature automatically traces all HTTP and HTTPS requests made or received by your application. The code sample initializes a NodeTracerProvider, registers it, and then enables the HTTP instrumentation to start tracing HTTP requests.

const { NodeTracerProvider } = require('@opentelemetry/node');
const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');

const provider = new NodeTracerProvider();
provider.register();

const httpInstrumentation = new HttpInstrumentation();
httpInstrumentation.enable();

Configurable Instrumentation

This feature allows developers to configure which requests should be ignored by the instrumentation. In the code sample, the instrumentation is configured to ignore incoming requests to '/healthz' and outgoing requests to 'example.com'.

const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
const httpInstrumentation = new HttpInstrumentation({
  ignoreIncomingPaths: [ /healthz/ ],
  ignoreOutgoingUrls: [ /example.com/ ]
});
httpInstrumentation.enable();

Other packages similar to @opentelemetry/instrumentation-http

dd-trace

dd-trace is a DataDog tracing library that also provides automatic instrumentation for HTTP requests among other integrations. It is similar to @opentelemetry/instrumentation-http but is specifically tailored for integration with DataDog's monitoring and analytics platform, whereas OpenTelemetry provides vendor-neutral instrumentation.

README

OpenTelemetry HTTP and HTTPS Instrumentation for Node.js

Note: This is an experimental package under active development. New releases may include breaking changes.

This module provides automatic instrumentation for http and https.

For automatic instrumentation see the @opentelemetry/sdk-trace-node package.

Installation

npm install --save @opentelemetry/instrumentation-http

Usage

OpenTelemetry HTTP Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.

To load a specific instrumentation (HTTP in this case), specify it in the Node Tracer's configuration.

const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
const {
  ConsoleSpanExporter,
  NodeTracerProvider,
  SimpleSpanProcessor,
} = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();

provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();

registerInstrumentations({
  instrumentations: [new HttpInstrumentation()],
});

See examples/http for a short example.

Http instrumentation Options

Http instrumentation has few options available to choose from. You can set the following:

Options	Type	Description
applyCustomAttributesOnSpan	HttpCustomAttributeFunction	Function for adding custom attributes
requestHook	HttpRequestCustomAttributeFunction	Function for adding custom attributes before request is handled
responseHook	HttpResponseCustomAttributeFunction	Function for adding custom attributes before response is handled
startIncomingSpanHook	StartIncomingSpanCustomAttributeFunction	Function for adding custom attributes before a span is started in incomingRequest
startOutgoingSpanHook	StartOutgoingSpanCustomAttributeFunction	Function for adding custom attributes before a span is started in outgoingRequest
ignoreIncomingRequestHook	IgnoreIncomingRequestFunction	Http instrumentation will not trace all incoming requests that matched with custom function
ignoreOutgoingRequestHook	IgnoreOutgoingRequestFunction	Http instrumentation will not trace all outgoing requests that matched with custom function
serverName	string	The primary server name of the matched virtual host.
requireParentforOutgoingSpans	Boolean	Require that is a parent span to create new span for outgoing requests.
requireParentforIncomingSpans	Boolean	Require that is a parent span to create new span for incoming requests.
headersToSpanAttributes	object	List of case insensitive HTTP headers to convert to span attributes. Client (outgoing requests, incoming responses) and server (incoming requests, outgoing responses) headers will be converted to span attributes in the form of http.{request|response}.header.header_name, e.g. http.response.header.content_length

The following options are deprecated:

Options	Type	Description
ignoreIncomingPaths	IgnoreMatcher[]	Http instrumentation will not trace all incoming requests that match paths

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

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

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.