Skip to content

Files

Latest commit

071e0ad · Dec 23, 2024

History

History

ecs-winston-format

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Oct 18, 2023
Oct 26, 2023
Mar 18, 2024
Oct 26, 2023
Mar 18, 2024
Oct 18, 2023
Oct 19, 2023
Oct 27, 2023
Oct 26, 2023
Mar 18, 2024
Dec 23, 2024

@elastic/ecs-winston-format

npm test

This Node.js package provides a formatter for the winston 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.

winston 3.x versions are supported.

Please see the Node.js ECS winston documentation.

Install

npm install @elastic/ecs-winston-format

Usage

const winston = require('winston');
const { ecsFormat } = require('@elastic/ecs-winston-format');

const logger = winston.createLogger({
  level: 'info',
  format: ecsFormat(/* options */),
  transports: [
    new winston.transports.Console()
  ]
});

logger.info('hi');
logger.error('oops there is a problem', { foo: 'bar' });

Running this script will produce log output similar to the following:

% node examples/basic.js
{"@timestamp":"2021-01-13T21:32:38.095Z","log.level":"info","message":"hi","ecs":{"version":"8.10.0"}}
{"@timestamp":"2021-01-13T21:32:38.096Z","log.level":"error","message":"oops there is a problem","ecs":{"version":"8.10.0"},"foo":"bar"}

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

License

This software is licensed under the Apache 2 license.