DataDog Transport

Ships logs server-side to Datadog using the datadog-transport-common library.

Transport Source

Important Notes

• Only works server-side (not in browsers)
  • For browser-side logging, use the @loglayer/transport-datadog-browser-logs package
• You will not get any console output since this sends directly to DataDog. Use the onDebug option to log out messages.

Installation

Install the required packages (datadog-transport-common is installed as part of @loglayer/transport-datadog):

npm

npm i loglayer @loglayer/transport-datadog serialize-error

pnpm

pnpm add loglayer @loglayer/transport-datadog serialize-error

yarn

yarn add loglayer @loglayer/transport-datadog serialize-error

Usage Example

import { LogLayer } from 'loglayer'
import { DataDogTransport } from "@loglayer/transport-datadog"
import { serializeError } from "serialize-error";

const log = new LogLayer({
  errorSerializer: serializeError,
  transport: new DataDogTransport({
    options: {
      ddClientConf: {
        authMethods: {
          apiKeyAuth: "YOUR_API_KEY",
        },
      },
      ddServerConf: {
        // Note: This must match the site you use for your DataDog login - See below for more info
        site: "datadoghq.eu"
      },
      onDebug: (msg) => {
        console.log(msg);
      },
      onError: (err, logs) => {
        console.error(err, logs);
      },
    },
  })
})

Transport Configuration

interface DatadogTransportConfig {
  /**
   * Whether the transport is enabled. Default is true.
   */
  enabled?: boolean
  /**
   * The field name to use for the message. Default is "message".
   */
  messageField?: string;
  /**
   * The field name to use for the log level. Default is "level".
   */
  levelField?: string;
  /**
   * The field name to use for the timestamp. Default is "time".
   */
  timestampField?: string;
  /**
   * A custom function to stamp the timestamp. The default timestamp uses the ISO 8601 format.
   */
  timestampFunction?: () => any;
  /**
   * Minimum log level to process. Logs below this level will be filtered out. Default is "trace".
   */
  level?: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
  /**
   * The options for the transport.
   */
  options: DDTransportOptions
}

Changelog

View the changelog here.