@opentelemetry/instrumentation-bunyan

OpenTelemetry instrumentation for bunyan

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

Installation

npm install --save @opentelemetry/instrumentation-bunyan

Usage

const { NodeTracerProvider } = require('@opentelemetry/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

• 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.

Changelog

0.21.0

:bug: Bug Fix

• #524 [Hapi example] Fix undefined api.statusCode (@GradedJestRisk)

:rocket: Enhancement

• opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • #529 chore: update core and api to 0.21.0 (@dyladan)
  • #522 chore: move api into peer dependency (@Flarna)
• Other
  • #506 feat: knex instrumentation (@Rauno56)
  • #508 feat: graphql responseHook support (@nozik)
  • #484 feat(instrumentation-document-load): performance paint timing events (@kkruk-sumo)
  • #510 chore: add node:16 to the test matrix (@Rauno56)
  • #521 feat: mysql2 instrumentation (@Rauno56)

Committers: 6

• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Krystian Kruk (@kkruk-sumo)
• Ran Nozik (@nozik)
• Rauno Viskus (@Rauno56)
• @GradedJestRisk