Not Particularly Meaningful

    @opentelemetry/instrumentation-http
    TypeScript icon, indicating that this package has built-in type declarations

    0.28.0 • Public • Published

    OpenTelemetry HTTP and HTTPS Instrumentation for Node.js

    NPM Published Version Apache License

    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, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
    const { NodeTracerProvider } = 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
    ignoreOutgoingUrls IgnoreMatcher[] Http instrumentation will not trace all outgoing requests that match urls

    Useful links

    License

    Apache 2.0 - See LICENSE for more information.

    Install

    npm i @opentelemetry/instrumentation-http

    DownloadsWeekly Downloads

    270,419

    Version

    0.28.0

    License

    Apache-2.0

    Unpacked Size

    153 kB

    Total Files

    21

    Last publish

    Collaborators

    • bogdandrutu
    • dyladan