@loglayer/transport-datadog 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Theo Gravity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,160 @@
+# Datadog Transport for LogLayer
+
+[![NPM Version](https://img.shields.io/npm/v/%40loglayer%2Ftransport-datadog)](https://www.npmjs.com/package/@loglayer/transport-datadog)
+[![NPM Downloads](https://img.shields.io/npm/dm/%40loglayer%2Ftransport-datadog)](https://www.npmjs.com/package/@loglayer/transport-datadog)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+
+Ships logs to Datadog using the [datadog-transport-common](https://www.npmjs.com/package/datadog-transport-common) library.
+
+## Important Notes
+
+- Only works server-side (not in browsers)
+    * For browser-side logging, use the [`@loglayer/transport-datadog-browser-logs`](https://loglayer.dev/transports/datadog-browser-logs.html) package
+- import `createDataDogTransport` from `@loglayer/transport-datadog` to create a new DataDog transport
+- You will not get any console output since this sends directly to DataDog. Use the `onDebug` option to log out messages.
+
+## Installation
+
+```bash
+npm install loglayer @loglayer/transport-datadog
+```
+
+## Usage
+
+```typescript
+import { LogLayer } from 'loglayer'
+import { createDataDogTransport } from "@loglayer/transport-datadog"
+
+const log = new LogLayer({
+  transport: createDataDogTransport({
+    id: "datadog",
+    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);
+      },
+    },
+  })
+})
+```
+
+## Configuration
+
+```typescript
+interface DataDogTransportOptions {
+  /**
+   * The ID of the transport.
+   */
+  id?: string
+  /**
+   * 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;
+  /**
+   * The options for the transport.
+   */
+  options: DDTransportOptions
+}
+```
+
+```typescript
+export interface DDTransportOptions {
+  /**
+   * DataDog client configuration parameters.
+   * @see https://datadoghq.dev/datadog-api-client-typescript/interfaces/client.Configuration.html
+   */
+  ddClientConf: ConfigurationParameters
+  /**
+   * Datadog server config for the client. Use this to change the Datadog server region.
+   * @see https://github.com/DataDog/datadog-api-client-typescript/blob/1e1097c68a437894b482701ecbe3d61522429319/packages/datadog-api-client-common/servers.ts#L90
+   */
+  ddServerConf?: {
+    /**
+     * The datadog server to use. Default is datadoghq.com.
+     * Other values could be:
+     * - us3.datadoghq.com
+     * - us5.datadoghq.com
+     * - datadoghq.eu
+     * - ddog-gov.com
+     */
+    site?: string
+    subdomain?: string
+    protocol?: string
+  }
+  /**
+   * The integration name associated with your log: the technology from which
+   * the log originated. When it matches an integration name, Datadog
+   * automatically installs the corresponding parsers and facets.
+   * @see https://docs.datadoghq.com/logs/log_collection/?tab=host#reserved-attributes
+   */
+  ddsource?: string
+  /**
+   * Comma separated tags associated with your logs. Ex: "env:prod,org:finance"
+   */
+  ddtags?: string
+  /**
+   * The name of the application or service generating the log events.
+   * Default is "Electron"
+   * @see https://docs.datadoghq.com/logs/log_collection/?tab=host#reserved-attributes
+   */
+  service?: string
+  /**
+   * Called when the plugin is ready to process logs.
+   */
+  onInit?: () => void
+  /**
+   * Error handler for when the submitLog() call fails.
+   */
+  onError?: (err: any, logs?: Array<Record<string, any>>) => void
+  /**
+   * Define this callback to get debug messages from this transport
+   */
+  onDebug?: (msg: string) => void
+  /**
+   * Number of times to retry sending the log before onError() is called.
+   * Default is 5.
+   */
+  retries?: number
+  /**
+   * Interval in which logs are sent to Datadog.
+   * Default is 3000 milliseconds.
+   */
+  sendIntervalMs?: number
+  /**
+   * Set to true to disable batch sending and send each log as it comes in. This disables
+   * the send interval.
+   */
+  sendImmediate?: boolean
+}
+```
+
+## Documentation
+
+For more details, visit [https://loglayer.dev/transports/datadog](https://loglayer.dev/transports/datadog)

package/dist/index.cjs

@@ -0,0 +1,41 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }// src/DataDogTransport.ts
+var _transport = require('@loglayer/transport');
+var _datadogtransportcommon = require('datadog-transport-common');
+var DataDogTransport = class extends _transport.BaseTransport {
+  
+  
+  
+  
+  constructor(config) {
+    super(config);
+    this.messageField = _nullishCoalesce(config.messageField, () => ( "message"));
+    this.levelField = _nullishCoalesce(config.levelField, () => ( "level"));
+    this.timestampField = _nullishCoalesce(config.timestampField, () => ( "time"));
+    this.timestampFunction = config.timestampFunction;
+  }
+  shipToLogger({ logLevel, messages, data, hasData }) {
+    const logEntry = {};
+    if (data && hasData) {
+      Object.assign(logEntry, data);
+    }
+    if (this.timestampField && this.timestampFunction) {
+      logEntry[this.timestampField] = this.timestampFunction();
+    } else {
+      logEntry[this.timestampField] = (/* @__PURE__ */ new Date()).toISOString();
+    }
+    logEntry[this.levelField] = logLevel;
+    logEntry[this.messageField] = messages.join(" ");
+    this.logger.processLog(logEntry);
+    return messages;
+  }
+};
+function createDataDogTransport(config) {
+  return new DataDogTransport({
+    ...config,
+    logger: new (0, _datadogtransportcommon.DataDogTransport)(config.options)
+  });
+}
+
+
+exports.createDataDogTransport = createDataDogTransport;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/loglayer/loglayer/packages/transports/datadog/dist/index.cjs","../src/DataDogTransport.ts"],"names":[],"mappings":"AAAA;ACAA,gDAA4D;AAE5D,kEAAoF;AAyBpF,IAAM,iBAAA,EAAN,MAAA,QAA+B,yBAAsC;AAAA,EACnE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,WAAA,CAAY,MAAA,EAAkG;AAC5G,IAAA,KAAA,CAAM,MAAM,CAAA;AAEZ,IAAA,IAAA,CAAK,aAAA,mBAAe,MAAA,CAAO,YAAA,UAAgB,WAAA;AAC3C,IAAA,IAAA,CAAK,WAAA,mBAAa,MAAA,CAAO,UAAA,UAAc,SAAA;AACvC,IAAA,IAAA,CAAK,eAAA,mBAAiB,MAAA,CAAO,cAAA,UAAkB,QAAA;AAC/C,IAAA,IAAA,CAAK,kBAAA,EAAoB,MAAA,CAAO,iBAAA;AAAA,EAClC;AAAA,EAEA,YAAA,CAAa,EAAE,QAAA,EAAU,QAAA,EAAU,IAAA,EAAM,QAAQ,CAAA,EAA4B;AAC3E,IAAA,MAAM,SAAA,EAAgC,CAAC,CAAA;AAEvC,IAAA,GAAA,CAAI,KAAA,GAAQ,OAAA,EAAS;AACnB,MAAA,MAAA,CAAO,MAAA,CAAO,QAAA,EAAU,IAAI,CAAA;AAAA,IAC9B;AAEA,IAAA,GAAA,CAAI,IAAA,CAAK,eAAA,GAAkB,IAAA,CAAK,iBAAA,EAAmB;AACjD,MAAA,QAAA,CAAS,IAAA,CAAK,cAAc,EAAA,EAAI,IAAA,CAAK,iBAAA,CAAkB,CAAA;AAAA,IACzD,EAAA,KAAO;AACL,MAAA,QAAA,CAAS,IAAA,CAAK,cAAc,EAAA,EAAA,iBAAI,IAAI,IAAA,CAAK,CAAA,CAAA,CAAE,WAAA,CAAY,CAAA;AAAA,IACzD;AAEA,IAAA,QAAA,CAAS,IAAA,CAAK,UAAU,EAAA,EAAI,QAAA;AAC5B,IAAA,QAAA,CAAS,IAAA,CAAK,YAAY,EAAA,EAAI,QAAA,CAAS,IAAA,CAAK,GAAG,CAAA;AAE/C,IAAA,IAAA,CAAK,MAAA,CAAO,UAAA,CAAW,QAAQ,CAAA;AAE/B,IAAA,OAAO,QAAA;AAAA,EACT;AACF,CAAA;AAEO,SAAS,sBAAA,CAAuB,MAAA,EAAgC;AACrE,EAAA,OAAO,IAAI,gBAAA,CAAiB;AAAA,IAC1B,GAAG,MAAA;AAAA,IACH,MAAA,EAAQ,IAAI,6CAAA,CAAuB,MAAA,CAAO,OAAO;AAAA,EACnD,CAAC,CAAA;AACH;ADhCA;AACE;AACF,wDAAC","file":"/home/runner/work/loglayer/loglayer/packages/transports/datadog/dist/index.cjs","sourcesContent":[null,"import { BaseTransport, type LogLayerTransportParams } from \"@loglayer/transport\";\nimport type { LogLayerTransportConfig } from \"@loglayer/transport\";\nimport { type DDTransportOptions, DataDogTransport as DatadogTransportCommon } from \"datadog-transport-common\";\n\nexport interface DatadogTransportConfig extends Omit<LogLayerTransportConfig<DatadogTransportCommon>, \"logger\"> {\n  /**\n   * The options to pass to the datadog-transport-common instance.\n   */\n  options: DDTransportOptions;\n  /**\n   * The field name to use for the message. Default is \"message\".\n   */\n  messageField?: string;\n  /**\n   * The field name to use for the log level. Default is \"level\".\n   */\n  levelField?: string;\n  /**\n   * The field name to use for the timestamp. Default is \"time\".\n   */\n  timestampField?: string;\n  /**\n   * A custom function to stamp the timestamp\n   */\n  timestampFunction?: () => any;\n}\n\nclass DataDogTransport extends BaseTransport<DatadogTransportCommon> {\n  messageField: string;\n  levelField: string;\n  timestampField: string;\n  timestampFunction?: () => any;\n\n  constructor(config: DatadogTransportConfig & Pick<LogLayerTransportConfig<DatadogTransportCommon>, \"logger\">) {\n    super(config);\n\n    this.messageField = config.messageField ?? \"message\";\n    this.levelField = config.levelField ?? \"level\";\n    this.timestampField = config.timestampField ?? \"time\";\n    this.timestampFunction = config.timestampFunction;\n  }\n\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams) {\n    const logEntry: Record<string, any> = {};\n\n    if (data && hasData) {\n      Object.assign(logEntry, data);\n    }\n\n    if (this.timestampField && this.timestampFunction) {\n      logEntry[this.timestampField] = this.timestampFunction();\n    } else {\n      logEntry[this.timestampField] = new Date().toISOString();\n    }\n\n    logEntry[this.levelField] = logLevel;\n    logEntry[this.messageField] = messages.join(\" \");\n\n    this.logger.processLog(logEntry);\n\n    return messages;\n  }\n}\n\nexport function createDataDogTransport(config: DatadogTransportConfig) {\n  return new DataDogTransport({\n    ...config,\n    logger: new DatadogTransportCommon(config.options),\n  });\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,37 @@
+import { LogLayerTransportConfig, BaseTransport, LogLayerTransportParams } from '@loglayer/transport';
+import { DataDogTransport as DataDogTransport$1, DDTransportOptions } from 'datadog-transport-common';
+export { DDTransportOptions } from 'datadog-transport-common';
+
+interface DatadogTransportConfig extends Omit<LogLayerTransportConfig<DataDogTransport$1>, "logger"> {
+    /**
+     * The options to pass to the datadog-transport-common instance.
+     */
+    options: DDTransportOptions;
+    /**
+     * 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
+     */
+    timestampFunction?: () => any;
+}
+declare class DataDogTransport extends BaseTransport<DataDogTransport$1> {
+    messageField: string;
+    levelField: string;
+    timestampField: string;
+    timestampFunction?: () => any;
+    constructor(config: DatadogTransportConfig & Pick<LogLayerTransportConfig<DataDogTransport$1>, "logger">);
+    shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[];
+}
+declare function createDataDogTransport(config: DatadogTransportConfig): DataDogTransport;
+
+export { type DatadogTransportConfig, createDataDogTransport };

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import { LogLayerTransportConfig, BaseTransport, LogLayerTransportParams } from '@loglayer/transport';
+import { DataDogTransport as DataDogTransport$1, DDTransportOptions } from 'datadog-transport-common';
+export { DDTransportOptions } from 'datadog-transport-common';
+
+interface DatadogTransportConfig extends Omit<LogLayerTransportConfig<DataDogTransport$1>, "logger"> {
+    /**
+     * The options to pass to the datadog-transport-common instance.
+     */
+    options: DDTransportOptions;
+    /**
+     * 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
+     */
+    timestampFunction?: () => any;
+}
+declare class DataDogTransport extends BaseTransport<DataDogTransport$1> {
+    messageField: string;
+    levelField: string;
+    timestampField: string;
+    timestampFunction?: () => any;
+    constructor(config: DatadogTransportConfig & Pick<LogLayerTransportConfig<DataDogTransport$1>, "logger">);
+    shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[];
+}
+declare function createDataDogTransport(config: DatadogTransportConfig): DataDogTransport;
+
+export { type DatadogTransportConfig, createDataDogTransport };

package/dist/index.js

@@ -0,0 +1,41 @@
+// src/DataDogTransport.ts
+import { BaseTransport } from "@loglayer/transport";
+import { DataDogTransport as DatadogTransportCommon } from "datadog-transport-common";
+var DataDogTransport = class extends BaseTransport {
+  messageField;
+  levelField;
+  timestampField;
+  timestampFunction;
+  constructor(config) {
+    super(config);
+    this.messageField = config.messageField ?? "message";
+    this.levelField = config.levelField ?? "level";
+    this.timestampField = config.timestampField ?? "time";
+    this.timestampFunction = config.timestampFunction;
+  }
+  shipToLogger({ logLevel, messages, data, hasData }) {
+    const logEntry = {};
+    if (data && hasData) {
+      Object.assign(logEntry, data);
+    }
+    if (this.timestampField && this.timestampFunction) {
+      logEntry[this.timestampField] = this.timestampFunction();
+    } else {
+      logEntry[this.timestampField] = (/* @__PURE__ */ new Date()).toISOString();
+    }
+    logEntry[this.levelField] = logLevel;
+    logEntry[this.messageField] = messages.join(" ");
+    this.logger.processLog(logEntry);
+    return messages;
+  }
+};
+function createDataDogTransport(config) {
+  return new DataDogTransport({
+    ...config,
+    logger: new DatadogTransportCommon(config.options)
+  });
+}
+export {
+  createDataDogTransport
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/DataDogTransport.ts"],"sourcesContent":["import { BaseTransport, type LogLayerTransportParams } from \"@loglayer/transport\";\nimport type { LogLayerTransportConfig } from \"@loglayer/transport\";\nimport { type DDTransportOptions, DataDogTransport as DatadogTransportCommon } from \"datadog-transport-common\";\n\nexport interface DatadogTransportConfig extends Omit<LogLayerTransportConfig<DatadogTransportCommon>, \"logger\"> {\n  /**\n   * The options to pass to the datadog-transport-common instance.\n   */\n  options: DDTransportOptions;\n  /**\n   * The field name to use for the message. Default is \"message\".\n   */\n  messageField?: string;\n  /**\n   * The field name to use for the log level. Default is \"level\".\n   */\n  levelField?: string;\n  /**\n   * The field name to use for the timestamp. Default is \"time\".\n   */\n  timestampField?: string;\n  /**\n   * A custom function to stamp the timestamp\n   */\n  timestampFunction?: () => any;\n}\n\nclass DataDogTransport extends BaseTransport<DatadogTransportCommon> {\n  messageField: string;\n  levelField: string;\n  timestampField: string;\n  timestampFunction?: () => any;\n\n  constructor(config: DatadogTransportConfig & Pick<LogLayerTransportConfig<DatadogTransportCommon>, \"logger\">) {\n    super(config);\n\n    this.messageField = config.messageField ?? \"message\";\n    this.levelField = config.levelField ?? \"level\";\n    this.timestampField = config.timestampField ?? \"time\";\n    this.timestampFunction = config.timestampFunction;\n  }\n\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams) {\n    const logEntry: Record<string, any> = {};\n\n    if (data && hasData) {\n      Object.assign(logEntry, data);\n    }\n\n    if (this.timestampField && this.timestampFunction) {\n      logEntry[this.timestampField] = this.timestampFunction();\n    } else {\n      logEntry[this.timestampField] = new Date().toISOString();\n    }\n\n    logEntry[this.levelField] = logLevel;\n    logEntry[this.messageField] = messages.join(\" \");\n\n    this.logger.processLog(logEntry);\n\n    return messages;\n  }\n}\n\nexport function createDataDogTransport(config: DatadogTransportConfig) {\n  return new DataDogTransport({\n    ...config,\n    logger: new DatadogTransportCommon(config.options),\n  });\n}\n"],"mappings":";AAAA,SAAS,qBAAmD;AAE5D,SAAkC,oBAAoB,8BAA8B;AAyBpF,IAAM,mBAAN,cAA+B,cAAsC;AAAA,EACnE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,YAAY,QAAkG;AAC5G,UAAM,MAAM;AAEZ,SAAK,eAAe,OAAO,gBAAgB;AAC3C,SAAK,aAAa,OAAO,cAAc;AACvC,SAAK,iBAAiB,OAAO,kBAAkB;AAC/C,SAAK,oBAAoB,OAAO;AAAA,EAClC;AAAA,EAEA,aAAa,EAAE,UAAU,UAAU,MAAM,QAAQ,GAA4B;AAC3E,UAAM,WAAgC,CAAC;AAEvC,QAAI,QAAQ,SAAS;AACnB,aAAO,OAAO,UAAU,IAAI;AAAA,IAC9B;AAEA,QAAI,KAAK,kBAAkB,KAAK,mBAAmB;AACjD,eAAS,KAAK,cAAc,IAAI,KAAK,kBAAkB;AAAA,IACzD,OAAO;AACL,eAAS,KAAK,cAAc,KAAI,oBAAI,KAAK,GAAE,YAAY;AAAA,IACzD;AAEA,aAAS,KAAK,UAAU,IAAI;AAC5B,aAAS,KAAK,YAAY,IAAI,SAAS,KAAK,GAAG;AAE/C,SAAK,OAAO,WAAW,QAAQ;AAE/B,WAAO;AAAA,EACT;AACF;AAEO,SAAS,uBAAuB,QAAgC;AACrE,SAAO,IAAI,iBAAiB;AAAA,IAC1B,GAAG;AAAA,IACH,QAAQ,IAAI,uBAAuB,OAAO,OAAO;AAAA,EACnD,CAAC;AACH;","names":[]}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@loglayer/transport-datadog",
+  "description": "DataDog transport for loglayer.",
+  "version": "1.0.1",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "repository": "loglayer/loglayer.git",
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "datadog",
+    "transport"
+  ],
+  "dependencies": {
+    "@datadog/datadog-api-client": "1.31.0",
+    "datadog-transport-common": "3.0.2",
+    "@loglayer/transport": "1.1.0"
+  },
+  "devDependencies": {
+    "hash-runner": "2.0.1",
+    "@types/node": "22.10.4",
+    "tsup": "8.3.5",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8",
+    "loglayer": "5.0.4",
+    "@internal/tsconfig": "1.0.0"
+  },
+  "bugs": "https://github.com/loglayer/loglayer/issues",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://loglayer.dev",
+  "scripts": {
+    "build": "tsup src/index.ts",
+    "test": "vitest --run",
+    "build:dev": "hash-runner",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --write --unsafe src && biome format src --write && biome lint src --fix",
+    "verify-types": "tsc --noEmit"
+  }
+}