Ogma Instrumentation for OpenTelemetry

This module provides automatic instrumentation for injection of trace context for the ogma module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

1npm install --save @ogma/instrumentation

Usage

1const {
2  NodeTracerProvider
3} = require('@opentelemetry/sdk-trace-node');
4const {
5  registerInstrumentations
6} = require('@opentelemetry/instrumentation');
7const { OgmaInstrumentation } = require('@ogma/instrumentation');
8
9const provider = new NodeTracerProvider();
10provider.register();
11
12registerInstrumentations({
13  instrumentations: [
14    new OgmaInstrumentation({
15      // Optional hook to insert additional context to log object.
16      logHook: (span, record, level) => {
17        record['resource.service.name'] =
18          provider.resource.attributes['service.name'];
19      }
20    })
21    // other instrumentations
22  ]
23});
24
25const { Ogma } = require('@ogma/logger');
26const logger = new Ogma();
27logger.info('foobar');
28// {"level":"INFO","meta":{"trace_id":"80d20824ae2f4a039c9ddd6463ecf2a2","span_id":"bdf2a9482f641cb9","trace_flags":"01"},"message":"foobar"...}

Fields added to ogma log objects

For the current active span, the following fields are injected:

• trace_id
• span_id
• trace_flags

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

Supported versions

>=3.2.0

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][discussions-url]