@loglayer/transport-betterstack 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LogLayer
+
+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,46 @@
+# @loglayer/transport-betterstack
+
+[![npm version](https://img.shields.io/npm/v/@loglayer/transport-betterstack.svg)](https://www.npmjs.com/package/@loglayer/transport-betterstack)
+[![npm downloads](https://img.shields.io/npm/dm/@loglayer/transport-betterstack.svg)](https://www.npmjs.com/package/@loglayer/transport-betterstack)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+
+Better Stack transport for the LogLayer logging library. This transport sends logs to [Better Stack's log management platform](https://betterstack.com/log-management) using their HTTP API.
+
+## Installation
+
+```bash
+npm install @loglayer/transport-betterstack
+```
+
+```bash
+yarn add @loglayer/transport-betterstack
+```
+
+```bash
+pnpm add @loglayer/transport-betterstack
+```
+
+## Usage
+
+- Create a "Javascript / Node.js" log source in your Better Stack account.
+- In the "Data ingestion" tab of your source, find your `source token` and the `ingesting host`.
+- Add `https://` in front of the ingesting host for the `url` parameter. 
+
+```typescript
+import { LogLayer } from "loglayer";
+import { BetterStackTransport } from "@loglayer/transport-betterstack";
+
+const transport = new BetterStackTransport({
+  sourceToken: "<source token>",
+  url: "https://<ingesting host>",
+});
+
+const log = new LogLayer({ transport });
+
+log.info("Hello, Better Stack!");
+log.withMetadata({ userId: "123" }).info("User logged in");
+```
+
+## Configuration
+
+For detailed configuration options and advanced usage, see the [Better Stack transport documentation](https://loglayer.dev/transports/betterstack).

package/dist/index.cjs

@@ -0,0 +1,83 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  BetterStackTransport: () => BetterStackTransport
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/BetterStackTransport.ts
+var import_transport_http = require("@loglayer/transport-http");
+var BetterStackTransport = class extends import_transport_http.HttpTransport {
+  /**
+   * Creates a new instance of BetterStackTransport.
+   *
+   * @param config - Configuration options for the transport
+   */
+  constructor(config) {
+    const url = config.url;
+    const includeTimestamp = config.includeTimestamp ?? true;
+    const timestampField = config.timestampField ?? "dt";
+    const httpConfig = {
+      ...config,
+      url,
+      headers: {
+        Authorization: `Bearer ${config.sourceToken}`,
+        "Content-Type": "application/json"
+      },
+      payloadTemplate: (data) => {
+        const payload = {
+          message: data.message
+        };
+        if (data.logLevel) {
+          payload.level = data.logLevel;
+        }
+        if (data.data) {
+          Object.assign(payload, data.data);
+        }
+        if (includeTimestamp) {
+          payload[timestampField] = (/* @__PURE__ */ new Date()).toISOString();
+        }
+        return JSON.stringify(payload);
+      },
+      // Better Stack specific defaults
+      batchMode: "array",
+      batchContentType: "application/json",
+      enableBatchSend: config.enableBatchSend ?? true,
+      batchSize: config.batchSize ?? 100,
+      batchSendTimeout: config.batchSendTimeout ?? 5e3,
+      compression: config.compression ?? false,
+      maxRetries: config.maxRetries ?? 3,
+      retryDelay: config.retryDelay ?? 1e3,
+      respectRateLimit: config.respectRateLimit ?? true,
+      maxLogSize: config.maxLogSize ?? 1048576,
+      // 1MB
+      maxPayloadSize: config.maxPayloadSize ?? 10485760
+      // 10MB (Better Stack limit)
+    };
+    super(httpConfig);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BetterStackTransport
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/BetterStackTransport.ts"],"sourcesContent":["export type { BetterStackTransportConfig } from \"./BetterStackTransport.js\";\nexport { BetterStackTransport } from \"./BetterStackTransport.js\";\n","import type { HttpTransportConfig } from \"@loglayer/transport-http\";\nimport { HttpTransport } from \"@loglayer/transport-http\";\n\n/**\n * Configuration options for the Better Stack transport.\n */\nexport interface BetterStackTransportConfig extends Omit<HttpTransportConfig, \"url\" | \"headers\" | \"payloadTemplate\"> {\n  /**\n   * Better Stack source token for authentication\n   */\n  sourceToken: string;\n  /**\n   * Better Stack ingestion host\n   */\n  url: string;\n  /**\n   * Whether to include timestamp in the log payload\n   * @default true\n   */\n  includeTimestamp?: boolean;\n  /**\n   * Custom field name for the timestamp\n   * @default \"dt\"\n   */\n  timestampField?: string;\n}\n\n/**\n * Better Stack transport for sending logs to Better Stack's log management platform.\n *\n * This transport extends the HTTP transport and configures it specifically for Better Stack's API.\n * It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.\n *\n * Features:\n * - Automatic authentication with source token\n * - Proper payload formatting for Better Stack API\n * - Support for custom timestamps\n * - Batch sending with configurable size and timeout\n * - Error handling and retry logic\n * - Compression support\n */\nexport class BetterStackTransport extends HttpTransport {\n  /**\n   * Creates a new instance of BetterStackTransport.\n   *\n   * @param config - Configuration options for the transport\n   */\n  constructor(config: BetterStackTransportConfig) {\n    const url = config.url;\n    const includeTimestamp = config.includeTimestamp ?? true;\n    const timestampField = config.timestampField ?? \"dt\";\n\n    // Configure the HTTP transport with Better Stack specific settings\n    const httpConfig: HttpTransportConfig = {\n      ...config,\n      url: url,\n      headers: {\n        Authorization: `Bearer ${config.sourceToken}`,\n        \"Content-Type\": \"application/json\",\n      },\n      payloadTemplate: (data) => {\n        const payload: Record<string, any> = {\n          message: data.message,\n        };\n\n        // Add log level if available\n        if (data.logLevel) {\n          payload.level = data.logLevel;\n        }\n\n        // Add metadata if available\n        if (data.data) {\n          Object.assign(payload, data.data);\n        }\n\n        // Add timestamp if enabled\n        if (includeTimestamp) {\n          payload[timestampField] = new Date().toISOString();\n        }\n\n        return JSON.stringify(payload);\n      },\n      // Better Stack specific defaults\n      batchMode: \"array\",\n      batchContentType: \"application/json\",\n      enableBatchSend: config.enableBatchSend ?? true,\n      batchSize: config.batchSize ?? 100,\n      batchSendTimeout: config.batchSendTimeout ?? 5000,\n      compression: config.compression ?? false,\n      maxRetries: config.maxRetries ?? 3,\n      retryDelay: config.retryDelay ?? 1000,\n      respectRateLimit: config.respectRateLimit ?? true,\n      maxLogSize: config.maxLogSize ?? 1048576, // 1MB\n      maxPayloadSize: config.maxPayloadSize ?? 10485760, // 10MB (Better Stack limit)\n    };\n\n    super(httpConfig);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,4BAA8B;AAwCvB,IAAM,uBAAN,cAAmC,oCAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMtD,YAAY,QAAoC;AAC9C,UAAM,MAAM,OAAO;AACnB,UAAM,mBAAmB,OAAO,oBAAoB;AACpD,UAAM,iBAAiB,OAAO,kBAAkB;AAGhD,UAAM,aAAkC;AAAA,MACtC,GAAG;AAAA,MACH;AAAA,MACA,SAAS;AAAA,QACP,eAAe,UAAU,OAAO,WAAW;AAAA,QAC3C,gBAAgB;AAAA,MAClB;AAAA,MACA,iBAAiB,CAAC,SAAS;AACzB,cAAM,UAA+B;AAAA,UACnC,SAAS,KAAK;AAAA,QAChB;AAGA,YAAI,KAAK,UAAU;AACjB,kBAAQ,QAAQ,KAAK;AAAA,QACvB;AAGA,YAAI,KAAK,MAAM;AACb,iBAAO,OAAO,SAAS,KAAK,IAAI;AAAA,QAClC;AAGA,YAAI,kBAAkB;AACpB,kBAAQ,cAAc,KAAI,oBAAI,KAAK,GAAE,YAAY;AAAA,QACnD;AAEA,eAAO,KAAK,UAAU,OAAO;AAAA,MAC/B;AAAA;AAAA,MAEA,WAAW;AAAA,MACX,kBAAkB;AAAA,MAClB,iBAAiB,OAAO,mBAAmB;AAAA,MAC3C,WAAW,OAAO,aAAa;AAAA,MAC/B,kBAAkB,OAAO,oBAAoB;AAAA,MAC7C,aAAa,OAAO,eAAe;AAAA,MACnC,YAAY,OAAO,cAAc;AAAA,MACjC,YAAY,OAAO,cAAc;AAAA,MACjC,kBAAkB,OAAO,oBAAoB;AAAA,MAC7C,YAAY,OAAO,cAAc;AAAA;AAAA,MACjC,gBAAgB,OAAO,kBAAkB;AAAA;AAAA,IAC3C;AAEA,UAAM,UAAU;AAAA,EAClB;AACF;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,49 @@
+import { HttpTransportConfig, HttpTransport } from '@loglayer/transport-http';
+
+/**
+ * Configuration options for the Better Stack transport.
+ */
+interface BetterStackTransportConfig extends Omit<HttpTransportConfig, "url" | "headers" | "payloadTemplate"> {
+    /**
+     * Better Stack source token for authentication
+     */
+    sourceToken: string;
+    /**
+     * Better Stack ingestion host
+     */
+    url: string;
+    /**
+     * Whether to include timestamp in the log payload
+     * @default true
+     */
+    includeTimestamp?: boolean;
+    /**
+     * Custom field name for the timestamp
+     * @default "dt"
+     */
+    timestampField?: string;
+}
+/**
+ * Better Stack transport for sending logs to Better Stack's log management platform.
+ *
+ * This transport extends the HTTP transport and configures it specifically for Better Stack's API.
+ * It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.
+ *
+ * Features:
+ * - Automatic authentication with source token
+ * - Proper payload formatting for Better Stack API
+ * - Support for custom timestamps
+ * - Batch sending with configurable size and timeout
+ * - Error handling and retry logic
+ * - Compression support
+ */
+declare class BetterStackTransport extends HttpTransport {
+    /**
+     * Creates a new instance of BetterStackTransport.
+     *
+     * @param config - Configuration options for the transport
+     */
+    constructor(config: BetterStackTransportConfig);
+}
+
+export { BetterStackTransport, type BetterStackTransportConfig };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { HttpTransportConfig, HttpTransport } from '@loglayer/transport-http';
+
+/**
+ * Configuration options for the Better Stack transport.
+ */
+interface BetterStackTransportConfig extends Omit<HttpTransportConfig, "url" | "headers" | "payloadTemplate"> {
+    /**
+     * Better Stack source token for authentication
+     */
+    sourceToken: string;
+    /**
+     * Better Stack ingestion host
+     */
+    url: string;
+    /**
+     * Whether to include timestamp in the log payload
+     * @default true
+     */
+    includeTimestamp?: boolean;
+    /**
+     * Custom field name for the timestamp
+     * @default "dt"
+     */
+    timestampField?: string;
+}
+/**
+ * Better Stack transport for sending logs to Better Stack's log management platform.
+ *
+ * This transport extends the HTTP transport and configures it specifically for Better Stack's API.
+ * It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.
+ *
+ * Features:
+ * - Automatic authentication with source token
+ * - Proper payload formatting for Better Stack API
+ * - Support for custom timestamps
+ * - Batch sending with configurable size and timeout
+ * - Error handling and retry logic
+ * - Compression support
+ */
+declare class BetterStackTransport extends HttpTransport {
+    /**
+     * Creates a new instance of BetterStackTransport.
+     *
+     * @param config - Configuration options for the transport
+     */
+    constructor(config: BetterStackTransportConfig);
+}
+
+export { BetterStackTransport, type BetterStackTransportConfig };

package/dist/index.js

@@ -0,0 +1,56 @@
+// src/BetterStackTransport.ts
+import { HttpTransport } from "@loglayer/transport-http";
+var BetterStackTransport = class extends HttpTransport {
+  /**
+   * Creates a new instance of BetterStackTransport.
+   *
+   * @param config - Configuration options for the transport
+   */
+  constructor(config) {
+    const url = config.url;
+    const includeTimestamp = config.includeTimestamp ?? true;
+    const timestampField = config.timestampField ?? "dt";
+    const httpConfig = {
+      ...config,
+      url,
+      headers: {
+        Authorization: `Bearer ${config.sourceToken}`,
+        "Content-Type": "application/json"
+      },
+      payloadTemplate: (data) => {
+        const payload = {
+          message: data.message
+        };
+        if (data.logLevel) {
+          payload.level = data.logLevel;
+        }
+        if (data.data) {
+          Object.assign(payload, data.data);
+        }
+        if (includeTimestamp) {
+          payload[timestampField] = (/* @__PURE__ */ new Date()).toISOString();
+        }
+        return JSON.stringify(payload);
+      },
+      // Better Stack specific defaults
+      batchMode: "array",
+      batchContentType: "application/json",
+      enableBatchSend: config.enableBatchSend ?? true,
+      batchSize: config.batchSize ?? 100,
+      batchSendTimeout: config.batchSendTimeout ?? 5e3,
+      compression: config.compression ?? false,
+      maxRetries: config.maxRetries ?? 3,
+      retryDelay: config.retryDelay ?? 1e3,
+      respectRateLimit: config.respectRateLimit ?? true,
+      maxLogSize: config.maxLogSize ?? 1048576,
+      // 1MB
+      maxPayloadSize: config.maxPayloadSize ?? 10485760
+      // 10MB (Better Stack limit)
+    };
+    super(httpConfig);
+  }
+};
+export {
+  BetterStackTransport
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/BetterStackTransport.ts"],"sourcesContent":["import type { HttpTransportConfig } from \"@loglayer/transport-http\";\nimport { HttpTransport } from \"@loglayer/transport-http\";\n\n/**\n * Configuration options for the Better Stack transport.\n */\nexport interface BetterStackTransportConfig extends Omit<HttpTransportConfig, \"url\" | \"headers\" | \"payloadTemplate\"> {\n  /**\n   * Better Stack source token for authentication\n   */\n  sourceToken: string;\n  /**\n   * Better Stack ingestion host\n   */\n  url: string;\n  /**\n   * Whether to include timestamp in the log payload\n   * @default true\n   */\n  includeTimestamp?: boolean;\n  /**\n   * Custom field name for the timestamp\n   * @default \"dt\"\n   */\n  timestampField?: string;\n}\n\n/**\n * Better Stack transport for sending logs to Better Stack's log management platform.\n *\n * This transport extends the HTTP transport and configures it specifically for Better Stack's API.\n * It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.\n *\n * Features:\n * - Automatic authentication with source token\n * - Proper payload formatting for Better Stack API\n * - Support for custom timestamps\n * - Batch sending with configurable size and timeout\n * - Error handling and retry logic\n * - Compression support\n */\nexport class BetterStackTransport extends HttpTransport {\n  /**\n   * Creates a new instance of BetterStackTransport.\n   *\n   * @param config - Configuration options for the transport\n   */\n  constructor(config: BetterStackTransportConfig) {\n    const url = config.url;\n    const includeTimestamp = config.includeTimestamp ?? true;\n    const timestampField = config.timestampField ?? \"dt\";\n\n    // Configure the HTTP transport with Better Stack specific settings\n    const httpConfig: HttpTransportConfig = {\n      ...config,\n      url: url,\n      headers: {\n        Authorization: `Bearer ${config.sourceToken}`,\n        \"Content-Type\": \"application/json\",\n      },\n      payloadTemplate: (data) => {\n        const payload: Record<string, any> = {\n          message: data.message,\n        };\n\n        // Add log level if available\n        if (data.logLevel) {\n          payload.level = data.logLevel;\n        }\n\n        // Add metadata if available\n        if (data.data) {\n          Object.assign(payload, data.data);\n        }\n\n        // Add timestamp if enabled\n        if (includeTimestamp) {\n          payload[timestampField] = new Date().toISOString();\n        }\n\n        return JSON.stringify(payload);\n      },\n      // Better Stack specific defaults\n      batchMode: \"array\",\n      batchContentType: \"application/json\",\n      enableBatchSend: config.enableBatchSend ?? true,\n      batchSize: config.batchSize ?? 100,\n      batchSendTimeout: config.batchSendTimeout ?? 5000,\n      compression: config.compression ?? false,\n      maxRetries: config.maxRetries ?? 3,\n      retryDelay: config.retryDelay ?? 1000,\n      respectRateLimit: config.respectRateLimit ?? true,\n      maxLogSize: config.maxLogSize ?? 1048576, // 1MB\n      maxPayloadSize: config.maxPayloadSize ?? 10485760, // 10MB (Better Stack limit)\n    };\n\n    super(httpConfig);\n  }\n}\n"],"mappings":";AACA,SAAS,qBAAqB;AAwCvB,IAAM,uBAAN,cAAmC,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMtD,YAAY,QAAoC;AAC9C,UAAM,MAAM,OAAO;AACnB,UAAM,mBAAmB,OAAO,oBAAoB;AACpD,UAAM,iBAAiB,OAAO,kBAAkB;AAGhD,UAAM,aAAkC;AAAA,MACtC,GAAG;AAAA,MACH;AAAA,MACA,SAAS;AAAA,QACP,eAAe,UAAU,OAAO,WAAW;AAAA,QAC3C,gBAAgB;AAAA,MAClB;AAAA,MACA,iBAAiB,CAAC,SAAS;AACzB,cAAM,UAA+B;AAAA,UACnC,SAAS,KAAK;AAAA,QAChB;AAGA,YAAI,KAAK,UAAU;AACjB,kBAAQ,QAAQ,KAAK;AAAA,QACvB;AAGA,YAAI,KAAK,MAAM;AACb,iBAAO,OAAO,SAAS,KAAK,IAAI;AAAA,QAClC;AAGA,YAAI,kBAAkB;AACpB,kBAAQ,cAAc,KAAI,oBAAI,KAAK,GAAE,YAAY;AAAA,QACnD;AAEA,eAAO,KAAK,UAAU,OAAO;AAAA,MAC/B;AAAA;AAAA,MAEA,WAAW;AAAA,MACX,kBAAkB;AAAA,MAClB,iBAAiB,OAAO,mBAAmB;AAAA,MAC3C,WAAW,OAAO,aAAa;AAAA,MAC/B,kBAAkB,OAAO,oBAAoB;AAAA,MAC7C,aAAa,OAAO,eAAe;AAAA,MACnC,YAAY,OAAO,cAAc;AAAA,MACjC,YAAY,OAAO,cAAc;AAAA,MACjC,kBAAkB,OAAO,oBAAoB;AAAA,MAC7C,YAAY,OAAO,cAAc;AAAA;AAAA,MACjC,gBAAgB,OAAO,kBAAkB;AAAA;AAAA,IAC3C;AAEA,UAAM,UAAU;AAAA,EAClB;AACF;","names":[]}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@loglayer/transport-betterstack",
+  "description": "Better Stack transport for the LogLayer logging library.",
+  "version": "1.0.0",
+  "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": {
+    "type": "git",
+    "url": "https://github.com/loglayer/loglayer.git",
+    "directory": "packages/transports/betterstack"
+  },
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "betterstack",
+    "transport",
+    "better stack"
+  ],
+  "dependencies": {
+    "@loglayer/transport": "2.3.3",
+    "@loglayer/transport-http": "1.1.1"
+  },
+  "devDependencies": {
+    "dotenv": "17.2.3",
+    "@types/node": "24.6.1",
+    "serialize-error": "12.0.0",
+    "tsx": "4.20.6",
+    "tsup": "8.5.0",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4",
+    "loglayer": "6.8.3",
+    "@internal/tsconfig": "2.1.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",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --no-errors-on-unmatched --write --unsafe src",
+    "lint:staged": "biome check --no-errors-on-unmatched --write --unsafe --staged src",
+    "verify-types": "tsc --noEmit",
+    "livetest": "tsx src/__tests__/livetest.ts"
+  }
+}