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

    0.28.0 • Public • Published

    OpenTelemetry instrumentation for bunyan

    NPM Published Version Apache License

    This module provides automatic instrumentation for injection of trace context to bunyan.

    Compatible with OpenTelemetry JS API and SDK 1.0+.

    Installation

    npm install --save @opentelemetry/instrumentation-bunyan

    Supported Versions

    • ^1.0.0

    Usage

    const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
    const { BunyanInstrumentation } = require('@opentelemetry/instrumentation-bunyan');
    const { registerInstrumentations } = require('@opentelemetry/instrumentation');
    
    const provider = new NodeTracerProvider();
    provider.register();
    
    registerInstrumentations({
      instrumentations: [
        new BunyanInstrumentation({
          // Optional hook to insert additional context to bunyan records.
          // Called after trace context is added to the record.
          logHook: (span, record) => {
            record['resource.service.name'] = provider.resource.attributes['service.name'];
          },
        }),
        // other instrumentations
      ],
    });
    
    bunyan.createLogger({ name: 'example' }).info('foo');
    // {"name":"example","msg":"foo","trace_id":"e21c7a95fff34e04f77c7bd518779621","span_id":"b7589a981fde09f4","trace_flags":"01", ...}

    Fields added to bunyan records

    For the current active span, the following will be added to the bunyan record:

    • trace_id
    • span_id
    • trace_flags

    When no span context is active or the span context is invalid, injection is skipped.

    Useful links

    License

    Apache 2.0 - See LICENSE for more information.

    Install

    npm i @opentelemetry/instrumentation-bunyan

    DownloadsWeekly Downloads

    48,855

    Version

    0.28.0

    License

    Apache-2.0

    Unpacked Size

    27.9 kB

    Total Files

    16

    Last publish

    Collaborators

    • bogdandrutu
    • dyladan