@elastic/ecs-pino-format

This Node.js package provides a formatter for the pino logger compatible with Elastic Common Schema (ECS) logging. In combination with the filebeat shipper, you can send your logs directly to Elasticsearch and leverage Kibana's Logs app to inspect all logs in one single place.

pino 6.x, 7.x, and 8.x versions are supported.

Please see the Node.js ECS pino documentation.

Install

1npm install @elastic/ecs-pino-format

Usage

This package will configure Pino's formatters, messageKey and timestamp options.

1const { ecsFormat } = require('@elastic/ecs-pino-format')
2const pino = require('pino')
3
4const log = pino(ecsFormat(/* options */))
5log.info('Hello world')
6
7const child = log.child({ module: 'foo' })
8child.warn('From child')

Running this will produce log output similar to the following:

1{"log.level":"info","@timestamp":"2023-10-16T18:08:02.601Z","process.pid":74325,"host.hostname":"pink.local","ecs.version":"8.10.0","message":"Hello world"}
2{"log.level":"warn","@timestamp":"2023-10-16T18:08:02.602Z","process.pid":74325,"host.hostname":"pink.local","ecs.version":"8.10.0","module":"foo","message":"From child"}

Please see the Node.js ECS pino documentation for more.

License

This software is licensed under the Apache 2 license.