pino-opentelemetry-transport

pino-opentelemetry-transport

Pino transport for OpenTelemetry. Outputs logs in the OpenTelemetry Log Data Model and sends them to OTLP logs collector.

Install

npm i pino-opentelemetry-transport

Configuration

The transport is using OpenTelemetry JS SDK, which can be configured using environment variables as described in the docs

The OTLP collector URL can be set by setting either of the following environment variables: OTEL_EXPORTER_OTLP_LOGS_ENDPOINT, OTEL_EXPORTER_OTLP_ENDPOINT

Usage

const pino = require('pino')

const transport = pino.transport({
  target: 'pino-opentelemetry-transport'
})

const logger = pino(transport)

transport.on('ready', () => {
  setInterval(() => {
    logger.info('test log')
  }, 1000)
})

(Also works in CommonJS)

Test locally

Create the log file to be mounted by OTLP collector container

touch otlp-logs.log

Run the OTLP collector in a container

npm run docker-run

Run example.js

OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://localhost:4317 node example.js

Observe the logs

tail -f /tmp/test-logs/otlp-logs.log

Note that not all log entries will immediately be written to the otlp-logs.log file. The collector will flush to the disk eventualy. The flush will be forced if the collector receives a kill signal.

Options

When using the transport, the following options can be used:

• messageKey: The key of the log message to be used as the OpenTelemetry log entry Body. Optional, value msg used by default (like in Pino itself).

License

MIT