New Relic's official winston log enricher for use with the
Node Agent.
The winston-enricher log format adds additional app, distributed trace and span information output as JSON-formatted log messages. This is most commonly used with the New Relic Logs product.
For the latest information, please see the New Relic docs.
npm install @newrelic/winston-enricher// index.js
require('newrelic')
const newrelicFormatter = require('@newrelic/winston-enricher')The New Relic formatter can be used individually or combined with other formatters as the final format.
format: winston.format.combine(
winston.format.label({label: 'test'}),
newrelicFormatter()
)Note for unhandledException log messages:
The stack trace will be written to the error.stack property.
To accommodate the New Relic Logs 4000 character log line limit, the stack and trace properties will be removed and the message, error.message and error.stack values will be truncated to 1024 characters.
winston versions 3.0.0 and greater are supported.
For more information, including currently supported Node versions, please see the agent compatibility and requirements.
For general agent setup, please see the agent installation guide.
This project is distributed under the Apache 2 license.
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.
We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
https://discuss.newrelic.com/t/node-log-enrichers-logs-in-context/88806
Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.
Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself 😁). Please review our Contributors Guide.
Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource+newrelic-winston-logenricher-node@newrelic.com.