@curve-technology/log4js-datadog

log4js-datadog

A basic Datadog appender for log4js.

Installation

npm install @curve-technology/log4js-datadog

Usage

The log4js-datadog appender enables the forwarding of log4js log events to Datadog. It has been specifically created for use in Auth0 action scripts and rules. To use this appender, simply include it in the list of appenders in the log4js configuration, and provide the relevant Datadog configuration details.

Note that message tags can be included in log events using DataDogTags:

log4js.configure({
     "appenders": [
         {
             type: "@curve-technology/log4js-datadog",
             apiKey: "datadog-api-key",
             intakeHost: "tcp-intake.logs.datadoghq.eu:443",
             errorHandler: e => console.log(e),
             category: "cheese",
             source: "some-source",
         },
     ]
 });
 
 const logger = log4js.getLogger("cheese");
 logger.info("Started cheese course", {tags: {env: "dev", severity: 3}}, "cheese selected", {tags: {"cheese": "epoisses"}});

Configuration

In addition to the standard log appender configuration options, the log4js-datadog appender requires DataDog specific settings:

• apiKey The Datadog API key for your organisation
• intakeHost The Datadog TCP log forwarding endpoint, including the port number
• errorHandler (optional) Handler that will be called when an error occurs with sending a log even to Datadog. Note that by default such errors will be ignored
• hostname (optional) The hostname that should appear in log messages. Defaults to the system hostname

License

MIT