@opentelemetry/instrumentation-http
Advanced tools
OpenTelemetry http/https automatic instrumentation package.
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.
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();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.
This module provides automatic instrumentation for http and https.
For automatic instrumentation see the @opentelemetry/node package.
npm install --save @opentelemetry/instrumentation-http
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-graphql');
const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/tracing');
const { NodeTracerProvider } = require('@opentelemetry/node');
const provider = new NodeTracerProvider({
// be sure to disable old plugins
plugins: {
http: { enabled: false, path: '@opentelemetry/plugin-http' },
https: { enabled: false, path: '@opentelemetry/plugin-https' }
},
});
const httpInstrumentation = new HttpInstrumentation({
// see under for available configuration
});
httpInstrumentation.enable();
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();
See examples/http for a short example.
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 |
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 |
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. |
Apache 2.0 - See LICENSE for more information.
0.15.0
opentelemetry-api-metrics, opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-sdk-node
opentelemetry-api, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-grpc-utils, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-node, opentelemetry-plugin-fetch, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-tracing, opentelemetry-web
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto
opentelemetry-api, opentelemetry-core, opentelemetry-instrumentation-http, opentelemetry-node, opentelemetry-plugin-fetch, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-propagator-b3, opentelemetry-shim-opentracing, opentelemetry-tracing
opentelemetry-instrumentation-http, opentelemetry-plugin-http, opentelemetry-plugin-https
opentelemetry-web
opentelemetry-instrumentation-fetch
opentelemetry-exporter-zipkin
opentelemetry-api-metrics, opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-sdk-node
opentelemetry-exporter-collector
opentelemetry-api
opentelemetry-instrumentation
opentelemetry-instrumentation, opentelemetry-node
opentelemetry-instrumentation-grpc, opentelemetry-instrumentation
opentelemetry-core, opentelemetry-tracing
opentelemetry-instrumentation-http
opentelemetry-core, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-instrumentation-http, opentelemetry-metrics, opentelemetry-node, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
opentelemetry-core
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto
FAQs
OpenTelemetry instrumentation for `node:http` and `node:https` http client and server modules
The npm package @opentelemetry/instrumentation-http receives a total of 2,519,166 weekly downloads. As such, @opentelemetry/instrumentation-http popularity was classified as popular.
We found that @opentelemetry/instrumentation-http demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.