pino-elasticsearch

You can use the bundled docker-compose.yml file to quickly spin up a local environment containing both Elasticsearch and Kibana.

Prerequisites:

• docker
• docker-compose

Steps:

1. Navigate to the project folder.
2. Run the following command to launch the services:

   docker-compose -f docker-compose-v8.yml up

You can pipe Pino logs directly into the pino-elasticsearch CLI to stream them to an Elasticsearch instance. This is useful for processing log files or piping output from a running process.

cat log | pino-elasticsearch --node http://localhost:9200

To use ECS, do not use the ecs option in pino-elasticsearch (it has been removed). Instead, use the @elastic/ecs-pino-format package to format the logs before they reach the Elasticsearch stream.

const pino = require('pino')
const ecsFormat = require('@elastic/ecs-pino-format')()
const pinoElastic = require('pino-elasticsearch')

const streamToElastic = pinoElastic({
  index: 'an-index',
  node: 'http://localhost:9200',
  esVersion: 7,
  flushBytes: 1000
})

const logger = pino({ level: 'info', ...ecsFormat() }, streamToElastic)

logger.info('hello world')

To use the CLI version of the tool, install it globally using npm:

npm install pino-elasticsearch -g

You can send existing Pino log files or streams to Elasticsearch using the CLI. The minimum requirement is providing the --node flag with your Elasticsearch URL.

cat log | pino-elasticsearch --node http://localhost:9200

To log to both the console and Elasticsearch simultaneously, use pino.transport. Note that the options object provided to the target must be serializable (e.g., do not pass functions as values).

const pino = require('pino');

const pinoOptions = {};

return pino(pinoOptions, pino.transport({
  targets: [
    { 
      target: 'pino/file', // This will log to stdout
    }, 
    { 
      target: 'pino-elasticsearch',
      options: {
        index: 'an-index',
        node: 'http://localhost:9200',
        esVersion: 7,
        flushBytes: 1000
      }
    }
  ]
}));

The pino-elasticsearch CLI acts as a transport stream that reads JSON logs from stdin and sends them to an Elasticsearch instance. You can pipe logs from pino directly into this CLI.

Basic Usage

node path/to/cli.js | pino > logs.json
pino-elasticsearch < logs.json

Configuration via File

You can load configuration settings from a .json or .js file using the --read-config (or -r) flag. This is useful for managing complex connection settings without long command-line strings.

pino-elasticsearch --read-config config.json

To verify your installation and ensure the transport is working correctly with a local Elasticsearch instance, you can run the included example script and pipe its output to pino-elasticsearch.

Prerequisites:

• pino-elasticsearch must be installed globally.
• An Elasticsearch instance must be running (e.g., via the docker-compose setup).

Steps:

1. Navigate to the project folder.
2. Run the example script and pipe it to the transport:

   node example | pino-elasticsearch

Integrate pino-elasticsearch directly into your Node.js application by passing the stream returned by pinoElastic() to the pino logger.

const pino = require('pino')
const pinoElastic = require('pino-elasticsearch')

const streamToElastic = pinoElastic({
  index: 'an-index',
  node: 'http://localhost:9200',
  esVersion: 7,
  flushBytes: 1000
})

const logger = pino({ level: 'info' }, streamToElastic)

logger.info('hello world')

When using the module, you can pass a custom Elasticsearch Connection class via the Connection option to customize low-level client behavior.

const pino = require('pino')
const pinoElastic = require('pino-elasticsearch')

const Connection = <custom Connection>

const streamToElastic = pinoElastic({
  index: 'an-index',
  node: 'http://localhost:9200',
  esVersion: 7,
  flushBytes: 1000,
  Connection
})

const logger = pino({ level: 'info' }, streamToElastic)

logger.info('hello world')