@loglayer/transport-sumo-logic 1.0.0

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,41 @@
+# Sumo Logic Transport for LogLayer
+
+[![NPM Version](https://img.shields.io/npm/v/%40loglayer%2Ftransport-sumo-logic)](https://www.npmjs.com/package/@loglayer/transport-sumo-logic)
+[![NPM Downloads](https://img.shields.io/npm/dm/%40loglayer%2Ftransport-sumo-logic)](https://www.npmjs.com/package/@loglayer/transport-sumo-logic)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+
+A [LogLayer](https://loglayer.dev) transport for sending logs to Sumo Logic via [HTTP Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/logs-metrics/upload-logs/).
+
+## Installation
+
+```bash
+npm install @loglayer/transport-sumo-logic serialize-error
+# or
+yarn add @loglayer/transport-sumo-logic serialize-error
+# or
+pnpm add @loglayer/transport-sumo-logic serialize-error
+```
+
+## Usage
+
+```typescript
+import { LogLayer } from "loglayer";
+import { SumoLogicTransport } from "@loglayer/transport-sumo-logic";
+import { serializeError } from "serialize-error";
+
+const transport = new SumoLogicTransport({
+  url: "YOUR_SUMO_LOGIC_HTTP_SOURCE_URL",
+});
+
+const logger = new LogLayer({
+  errorSerializer: serializeError,
+  transport
+});
+
+// Basic logging
+logger.info("Hello from LogLayer!");
+```
+
+## Documentation
+
+For more details, visit [https://loglayer.dev/transports/sumo-logic](https://loglayer.dev/transports/sumo-logic)

package/dist/index.cjs

@@ -0,0 +1,137 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/SumoLogicTransport.ts
+var _transport = require('@loglayer/transport');
+var MAX_PAYLOAD_SIZE = 1e6;
+var SumoLogicTransport = class extends _transport.LoggerlessTransport {
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  constructor(config) {
+    super(config);
+    this.url = config.url;
+    this.useCompression = _nullishCoalesce(config.useCompression, () => ( true));
+    this.sourceCategory = config.sourceCategory;
+    this.sourceName = config.sourceName;
+    this.sourceHost = config.sourceHost;
+    this.fields = _nullishCoalesce(config.fields, () => ( {}));
+    this.headers = _nullishCoalesce(config.headers, () => ( {}));
+    this.maxRetries = _nullishCoalesce(_optionalChain([config, 'access', _ => _.retryConfig, 'optionalAccess', _2 => _2.maxRetries]), () => ( 3));
+    this.initialRetryMs = _nullishCoalesce(_optionalChain([config, 'access', _3 => _3.retryConfig, 'optionalAccess', _4 => _4.initialRetryMs]), () => ( 1e3));
+    this.onError = config.onError;
+    this.messageField = _nullishCoalesce(config.messageField, () => ( "message"));
+  }
+  /**
+   * Compresses data using gzip compression.
+   */
+  async compressData(data) {
+    const stream = new CompressionStream("gzip");
+    const writer = stream.writable.getWriter();
+    const textEncoder = new TextEncoder();
+    const chunks = [];
+    await writer.write(textEncoder.encode(data));
+    await writer.close();
+    const reader = stream.readable.getReader();
+    while (true) {
+      const { value, done } = await reader.read();
+      if (done) break;
+      chunks.push(value);
+    }
+    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+    const result = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const chunk of chunks) {
+      result.set(chunk, offset);
+      offset += chunk.length;
+    }
+    return result;
+  }
+  /**
+   * Handles errors by calling the onError callback if defined
+   */
+  handleError(error) {
+    if (this.onError) {
+      this.onError(error);
+    }
+  }
+  /**
+   * Sends logs to SumoLogic with retry logic, compression, and size validation.
+   */
+  async sendToSumoLogic(payload, retryCount = 0) {
+    try {
+      const rawSize = new TextEncoder().encode(payload).length;
+      if (rawSize > MAX_PAYLOAD_SIZE) {
+        const error = `Payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${rawSize} bytes`;
+        this.handleError(error);
+        return;
+      }
+      let compressedPayload;
+      if (this.useCompression) {
+        compressedPayload = await this.compressData(payload);
+        if (compressedPayload.length > MAX_PAYLOAD_SIZE) {
+          const error = `Compressed payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${compressedPayload.length} bytes`;
+          this.handleError(error);
+          return;
+        }
+      }
+      const headers = {
+        ...this.headers,
+        "Content-Type": "application/json"
+      };
+      if (this.sourceCategory) {
+        headers["X-Sumo-Category"] = this.sourceCategory;
+      }
+      if (this.sourceName) {
+        headers["X-Sumo-Name"] = this.sourceName;
+      }
+      if (this.sourceHost) {
+        headers["X-Sumo-Host"] = this.sourceHost;
+      }
+      if (this.useCompression) {
+        headers["Content-Encoding"] = "gzip";
+      }
+      if (Object.keys(this.fields).length > 0) {
+        headers["X-Sumo-Fields"] = Object.entries(this.fields).map(([key, value]) => `${key}=${value}`).join(",");
+      }
+      const response = await fetch(this.url, {
+        method: "POST",
+        headers,
+        body: this.useCompression ? compressedPayload : payload
+      });
+      if (!response.ok) {
+        throw new Error(`HTTP error! status: ${response.status}`);
+      }
+    } catch (error) {
+      if (retryCount < this.maxRetries) {
+        const delay = this.initialRetryMs * 2 ** retryCount;
+        await new Promise((resolve) => setTimeout(resolve, delay));
+        return this.sendToSumoLogic(payload, retryCount + 1);
+      }
+      this.handleError(error instanceof Error ? error : String(error));
+    }
+  }
+  shipToLogger({ logLevel, messages, data, hasData }) {
+    const stringMessages = messages.filter((msg) => typeof msg === "string");
+    const message = stringMessages.join(" ");
+    const payload = {
+      severity: logLevel,
+      timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+      ...data && hasData ? data : {}
+    };
+    if (message) {
+      payload[this.messageField] = message;
+    }
+    this.sendToSumoLogic(JSON.stringify(payload));
+    return messages;
+  }
+};
+
+
+exports.SumoLogicTransport = SumoLogicTransport;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/loglayer/loglayer/packages/transports/sumo-logic/dist/index.cjs","../src/SumoLogicTransport.ts"],"names":[],"mappings":"AAAA;ACAA,gDAAkG;AA0DlG,IAAM,iBAAA,EAAmB,GAAA;AAElB,IAAM,mBAAA,EAAN,MAAA,QAAiC,+BAAoB;AAAA,EAClD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAER,WAAA,CAAY,MAAA,EAAkC;AAC5C,IAAA,KAAA,CAAM,MAAM,CAAA;AACZ,IAAA,IAAA,CAAK,IAAA,EAAM,MAAA,CAAO,GAAA;AAClB,IAAA,IAAA,CAAK,eAAA,mBAAiB,MAAA,CAAO,cAAA,UAAkB,MAAA;AAC/C,IAAA,IAAA,CAAK,eAAA,EAAiB,MAAA,CAAO,cAAA;AAC7B,IAAA,IAAA,CAAK,WAAA,EAAa,MAAA,CAAO,UAAA;AACzB,IAAA,IAAA,CAAK,WAAA,EAAa,MAAA,CAAO,UAAA;AACzB,IAAA,IAAA,CAAK,OAAA,mBAAS,MAAA,CAAO,MAAA,UAAU,CAAC,GAAA;AAChC,IAAA,IAAA,CAAK,QAAA,mBAAU,MAAA,CAAO,OAAA,UAAW,CAAC,GAAA;AAClC,IAAA,IAAA,CAAK,WAAA,mCAAa,MAAA,mBAAO,WAAA,6BAAa,YAAA,UAAc,GAAA;AACpD,IAAA,IAAA,CAAK,eAAA,mCAAiB,MAAA,qBAAO,WAAA,6BAAa,gBAAA,UAAkB,KAAA;AAC5D,IAAA,IAAA,CAAK,QAAA,EAAU,MAAA,CAAO,OAAA;AACtB,IAAA,IAAA,CAAK,aAAA,mBAAe,MAAA,CAAO,YAAA,UAAgB,WAAA;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,YAAA,CAAa,IAAA,EAAmC;AAC5D,IAAA,MAAM,OAAA,EAAS,IAAI,iBAAA,CAAkB,MAAM,CAAA;AAC3C,IAAA,MAAM,OAAA,EAAS,MAAA,CAAO,QAAA,CAAS,SAAA,CAAU,CAAA;AACzC,IAAA,MAAM,YAAA,EAAc,IAAI,WAAA,CAAY,CAAA;AACpC,IAAA,MAAM,OAAA,EAAuB,CAAC,CAAA;AAE9B,IAAA,MAAM,MAAA,CAAO,KAAA,CAAM,WAAA,CAAY,MAAA,CAAO,IAAI,CAAC,CAAA;AAC3C,IAAA,MAAM,MAAA,CAAO,KAAA,CAAM,CAAA;AAEnB,IAAA,MAAM,OAAA,EAAS,MAAA,CAAO,QAAA,CAAS,SAAA,CAAU,CAAA;AAEzC,IAAA,MAAA,CAAO,IAAA,EAAM;AACX,MAAA,MAAM,EAAE,KAAA,EAAO,KAAK,EAAA,EAAI,MAAM,MAAA,CAAO,IAAA,CAAK,CAAA;AAC1C,MAAA,GAAA,CAAI,IAAA,EAAM,KAAA;AACV,MAAA,MAAA,CAAO,IAAA,CAAK,KAAK,CAAA;AAAA,IACnB;AAEA,IAAA,MAAM,YAAA,EAAc,MAAA,CAAO,MAAA,CAAO,CAAC,GAAA,EAAK,KAAA,EAAA,GAAU,IAAA,EAAM,KAAA,CAAM,MAAA,EAAQ,CAAC,CAAA;AACvE,IAAA,MAAM,OAAA,EAAS,IAAI,UAAA,CAAW,WAAW,CAAA;AACzC,IAAA,IAAI,OAAA,EAAS,CAAA;AAEb,IAAA,IAAA,CAAA,MAAW,MAAA,GAAS,MAAA,EAAQ;AAC1B,MAAA,MAAA,CAAO,GAAA,CAAI,KAAA,EAAO,MAAM,CAAA;AACxB,MAAA,OAAA,GAAU,KAAA,CAAM,MAAA;AAAA,IAClB;AAEA,IAAA,OAAO,MAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKQ,WAAA,CAAY,KAAA,EAA6B;AAC/C,IAAA,GAAA,CAAI,IAAA,CAAK,OAAA,EAAS;AAChB,MAAA,IAAA,CAAK,OAAA,CAAQ,KAAK,CAAA;AAAA,IACpB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,eAAA,CAAgB,OAAA,EAAiB,WAAA,EAAa,CAAA,EAAkB;AAC5E,IAAA,IAAI;AAEF,MAAA,MAAM,QAAA,EAAU,IAAI,WAAA,CAAY,CAAA,CAAE,MAAA,CAAO,OAAO,CAAA,CAAE,MAAA;AAClD,MAAA,GAAA,CAAI,QAAA,EAAU,gBAAA,EAAkB;AAC9B,QAAA,MAAM,MAAA,EAAQ,CAAA,gCAAA,EAAmC,gBAAgB,CAAA,cAAA,EAAiB,OAAO,CAAA,MAAA,CAAA;AACzF,QAAA,IAAA,CAAK,WAAA,CAAY,KAAK,CAAA;AACtB,QAAA,MAAA;AAAA,MACF;AAEA,MAAA,IAAI,iBAAA;AACJ,MAAA,GAAA,CAAI,IAAA,CAAK,cAAA,EAAgB;AACvB,QAAA,kBAAA,EAAoB,MAAM,IAAA,CAAK,YAAA,CAAa,OAAO,CAAA;AACnD,QAAA,GAAA,CAAI,iBAAA,CAAkB,OAAA,EAAS,gBAAA,EAAkB;AAC/C,UAAA,MAAM,MAAA,EAAQ,CAAA,2CAAA,EAA8C,gBAAgB,CAAA,cAAA,EAAiB,iBAAA,CAAkB,MAAM,CAAA,MAAA,CAAA;AACrH,UAAA,IAAA,CAAK,WAAA,CAAY,KAAK,CAAA;AACtB,UAAA,MAAA;AAAA,QACF;AAAA,MACF;AAEA,MAAA,MAAM,QAAA,EAAkC;AAAA,QACtC,GAAG,IAAA,CAAK,OAAA;AAAA,QACR,cAAA,EAAgB;AAAA,MAClB,CAAA;AAEA,MAAA,GAAA,CAAI,IAAA,CAAK,cAAA,EAAgB;AACvB,QAAA,OAAA,CAAQ,iBAAiB,EAAA,EAAI,IAAA,CAAK,cAAA;AAAA,MACpC;AACA,MAAA,GAAA,CAAI,IAAA,CAAK,UAAA,EAAY;AACnB,QAAA,OAAA,CAAQ,aAAa,EAAA,EAAI,IAAA,CAAK,UAAA;AAAA,MAChC;AACA,MAAA,GAAA,CAAI,IAAA,CAAK,UAAA,EAAY;AACnB,QAAA,OAAA,CAAQ,aAAa,EAAA,EAAI,IAAA,CAAK,UAAA;AAAA,MAChC;AACA,MAAA,GAAA,CAAI,IAAA,CAAK,cAAA,EAAgB;AACvB,QAAA,OAAA,CAAQ,kBAAkB,EAAA,EAAI,MAAA;AAAA,MAChC;AACA,MAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,MAAM,CAAA,CAAE,OAAA,EAAS,CAAA,EAAG;AACvC,QAAA,OAAA,CAAQ,eAAe,EAAA,EAAI,MAAA,CAAO,OAAA,CAAQ,IAAA,CAAK,MAAM,CAAA,CAClD,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,EAAA,GAAM,CAAA,EAAA;AAE3B,MAAA;AAEwC,MAAA;AAC9B,QAAA;AACR,QAAA;AACgD,QAAA;AACjD,MAAA;AAEiB,MAAA;AACwC,QAAA;AAC1D,MAAA;AACc,IAAA;AACoB,MAAA;AACS,QAAA;AACgB,QAAA;AACN,QAAA;AACrD,MAAA;AAC+D,MAAA;AACjE,IAAA;AACF,EAAA;AAEoF,EAAA;AAEX,IAAA;AAChC,IAAA;AAEvB,IAAA;AACJ,MAAA;AACwB,MAAA;AACJ,MAAA;AAChC,IAAA;AAEa,IAAA;AACkB,MAAA;AAC/B,IAAA;AAE4C,IAAA;AAErC,IAAA;AACT,EAAA;AACF;ADhFsF;AACA;AACA","file":"/home/runner/work/loglayer/loglayer/packages/transports/sumo-logic/dist/index.cjs","sourcesContent":[null,"import { type LogLayerTransportParams, LoggerlessTransport, type LoggerlessTransportConfig } from \"@loglayer/transport\";\n\ninterface SumoLogicTransportConfig extends LoggerlessTransportConfig {\n  /**\n   * The URL of your HTTP Source endpoint\n   */\n  url: string;\n\n  /**\n   * Whether to use gzip compression (defaults to true)\n   */\n  useCompression?: boolean;\n\n  /**\n   * Source category to assign to the logs (optional)\n   */\n  sourceCategory?: string;\n\n  /**\n   * Source name to assign to the logs (optional)\n   */\n  sourceName?: string;\n\n  /**\n   * Source host to assign to the logs (optional)\n   */\n  sourceHost?: string;\n\n  /**\n   * Fields to be added as X-Sumo-Fields header (optional)\n   * Will be formatted as a comma-separated list of key=value pairs\n   */\n  fields?: Record<string, string>;\n\n  /**\n   * Custom headers to be added to the request (optional)\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * Retry configuration (optional)\n   */\n  retryConfig?: {\n    maxRetries?: number;\n    initialRetryMs?: number;\n  };\n\n  /**\n   * Optional callback for error handling\n   */\n  onError?: (error: Error | string) => void;\n\n  /**\n   * Field name to use for the message (defaults to \"message\")\n   */\n  messageField?: string;\n}\n\nconst MAX_PAYLOAD_SIZE = 1000000; // 1MB limit as per SumoLogic docs\n\nexport class SumoLogicTransport extends LoggerlessTransport {\n  private url: string;\n  private useCompression: boolean;\n  private sourceCategory?: string;\n  private sourceName?: string;\n  private sourceHost?: string;\n  private fields: Record<string, string>;\n  private headers: Record<string, string>;\n  private maxRetries: number;\n  private initialRetryMs: number;\n  private onError?: (error: Error | string) => void;\n  private messageField: string;\n\n  constructor(config: SumoLogicTransportConfig) {\n    super(config);\n    this.url = config.url;\n    this.useCompression = config.useCompression ?? true;\n    this.sourceCategory = config.sourceCategory;\n    this.sourceName = config.sourceName;\n    this.sourceHost = config.sourceHost;\n    this.fields = config.fields ?? {};\n    this.headers = config.headers ?? {};\n    this.maxRetries = config.retryConfig?.maxRetries ?? 3;\n    this.initialRetryMs = config.retryConfig?.initialRetryMs ?? 1000;\n    this.onError = config.onError;\n    this.messageField = config.messageField ?? \"message\";\n  }\n\n  /**\n   * Compresses data using gzip compression.\n   */\n  private async compressData(data: string): Promise<Uint8Array> {\n    const stream = new CompressionStream(\"gzip\");\n    const writer = stream.writable.getWriter();\n    const textEncoder = new TextEncoder();\n    const chunks: Uint8Array[] = [];\n\n    await writer.write(textEncoder.encode(data));\n    await writer.close();\n\n    const reader = stream.readable.getReader();\n\n    while (true) {\n      const { value, done } = await reader.read();\n      if (done) break;\n      chunks.push(value);\n    }\n\n    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);\n    const result = new Uint8Array(totalLength);\n    let offset = 0;\n\n    for (const chunk of chunks) {\n      result.set(chunk, offset);\n      offset += chunk.length;\n    }\n\n    return result;\n  }\n\n  /**\n   * Handles errors by calling the onError callback if defined\n   */\n  private handleError(error: Error | string): void {\n    if (this.onError) {\n      this.onError(error);\n    }\n  }\n\n  /**\n   * Sends logs to SumoLogic with retry logic, compression, and size validation.\n   */\n  private async sendToSumoLogic(payload: string, retryCount = 0): Promise<void> {\n    try {\n      // Check payload size before compression\n      const rawSize = new TextEncoder().encode(payload).length;\n      if (rawSize > MAX_PAYLOAD_SIZE) {\n        const error = `Payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${rawSize} bytes`;\n        this.handleError(error);\n        return;\n      }\n\n      let compressedPayload: Uint8Array | undefined;\n      if (this.useCompression) {\n        compressedPayload = await this.compressData(payload);\n        if (compressedPayload.length > MAX_PAYLOAD_SIZE) {\n          const error = `Compressed payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${compressedPayload.length} bytes`;\n          this.handleError(error);\n          return;\n        }\n      }\n\n      const headers: Record<string, string> = {\n        ...this.headers,\n        \"Content-Type\": \"application/json\",\n      };\n\n      if (this.sourceCategory) {\n        headers[\"X-Sumo-Category\"] = this.sourceCategory;\n      }\n      if (this.sourceName) {\n        headers[\"X-Sumo-Name\"] = this.sourceName;\n      }\n      if (this.sourceHost) {\n        headers[\"X-Sumo-Host\"] = this.sourceHost;\n      }\n      if (this.useCompression) {\n        headers[\"Content-Encoding\"] = \"gzip\";\n      }\n      if (Object.keys(this.fields).length > 0) {\n        headers[\"X-Sumo-Fields\"] = Object.entries(this.fields)\n          .map(([key, value]) => `${key}=${value}`)\n          .join(\",\");\n      }\n\n      const response = (await fetch(this.url, {\n        method: \"POST\",\n        headers,\n        body: this.useCompression ? compressedPayload : payload,\n      })) as Response;\n\n      if (!response.ok) {\n        throw new Error(`HTTP error! status: ${response.status}`);\n      }\n    } catch (error) {\n      if (retryCount < this.maxRetries) {\n        const delay = this.initialRetryMs * 2 ** retryCount;\n        await new Promise((resolve) => setTimeout(resolve, delay));\n        return this.sendToSumoLogic(payload, retryCount + 1);\n      }\n      this.handleError(error instanceof Error ? error : String(error));\n    }\n  }\n\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[] {\n    // Only use the string messages for content\n    const stringMessages = messages.filter((msg) => typeof msg === \"string\");\n    const message = stringMessages.join(\" \");\n\n    const payload = {\n      severity: logLevel,\n      timestamp: new Date().toISOString(),\n      ...(data && hasData ? data : {}),\n    };\n\n    if (message) {\n      payload[this.messageField] = message;\n    }\n\n    this.sendToSumoLogic(JSON.stringify(payload));\n\n    return messages;\n  }\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,77 @@
+import { LoggerlessTransport, LogLayerTransportParams, LoggerlessTransportConfig } from '@loglayer/transport';
+
+interface SumoLogicTransportConfig extends LoggerlessTransportConfig {
+    /**
+     * The URL of your HTTP Source endpoint
+     */
+    url: string;
+    /**
+     * Whether to use gzip compression (defaults to true)
+     */
+    useCompression?: boolean;
+    /**
+     * Source category to assign to the logs (optional)
+     */
+    sourceCategory?: string;
+    /**
+     * Source name to assign to the logs (optional)
+     */
+    sourceName?: string;
+    /**
+     * Source host to assign to the logs (optional)
+     */
+    sourceHost?: string;
+    /**
+     * Fields to be added as X-Sumo-Fields header (optional)
+     * Will be formatted as a comma-separated list of key=value pairs
+     */
+    fields?: Record<string, string>;
+    /**
+     * Custom headers to be added to the request (optional)
+     */
+    headers?: Record<string, string>;
+    /**
+     * Retry configuration (optional)
+     */
+    retryConfig?: {
+        maxRetries?: number;
+        initialRetryMs?: number;
+    };
+    /**
+     * Optional callback for error handling
+     */
+    onError?: (error: Error | string) => void;
+    /**
+     * Field name to use for the message (defaults to "message")
+     */
+    messageField?: string;
+}
+declare class SumoLogicTransport extends LoggerlessTransport {
+    private url;
+    private useCompression;
+    private sourceCategory?;
+    private sourceName?;
+    private sourceHost?;
+    private fields;
+    private headers;
+    private maxRetries;
+    private initialRetryMs;
+    private onError?;
+    private messageField;
+    constructor(config: SumoLogicTransportConfig);
+    /**
+     * Compresses data using gzip compression.
+     */
+    private compressData;
+    /**
+     * Handles errors by calling the onError callback if defined
+     */
+    private handleError;
+    /**
+     * Sends logs to SumoLogic with retry logic, compression, and size validation.
+     */
+    private sendToSumoLogic;
+    shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[];
+}
+
+export { SumoLogicTransport };

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+import { LoggerlessTransport, LogLayerTransportParams, LoggerlessTransportConfig } from '@loglayer/transport';
+
+interface SumoLogicTransportConfig extends LoggerlessTransportConfig {
+    /**
+     * The URL of your HTTP Source endpoint
+     */
+    url: string;
+    /**
+     * Whether to use gzip compression (defaults to true)
+     */
+    useCompression?: boolean;
+    /**
+     * Source category to assign to the logs (optional)
+     */
+    sourceCategory?: string;
+    /**
+     * Source name to assign to the logs (optional)
+     */
+    sourceName?: string;
+    /**
+     * Source host to assign to the logs (optional)
+     */
+    sourceHost?: string;
+    /**
+     * Fields to be added as X-Sumo-Fields header (optional)
+     * Will be formatted as a comma-separated list of key=value pairs
+     */
+    fields?: Record<string, string>;
+    /**
+     * Custom headers to be added to the request (optional)
+     */
+    headers?: Record<string, string>;
+    /**
+     * Retry configuration (optional)
+     */
+    retryConfig?: {
+        maxRetries?: number;
+        initialRetryMs?: number;
+    };
+    /**
+     * Optional callback for error handling
+     */
+    onError?: (error: Error | string) => void;
+    /**
+     * Field name to use for the message (defaults to "message")
+     */
+    messageField?: string;
+}
+declare class SumoLogicTransport extends LoggerlessTransport {
+    private url;
+    private useCompression;
+    private sourceCategory?;
+    private sourceName?;
+    private sourceHost?;
+    private fields;
+    private headers;
+    private maxRetries;
+    private initialRetryMs;
+    private onError?;
+    private messageField;
+    constructor(config: SumoLogicTransportConfig);
+    /**
+     * Compresses data using gzip compression.
+     */
+    private compressData;
+    /**
+     * Handles errors by calling the onError callback if defined
+     */
+    private handleError;
+    /**
+     * Sends logs to SumoLogic with retry logic, compression, and size validation.
+     */
+    private sendToSumoLogic;
+    shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[];
+}
+
+export { SumoLogicTransport };

package/dist/index.js

@@ -0,0 +1,137 @@
+// src/SumoLogicTransport.ts
+import { LoggerlessTransport } from "@loglayer/transport";
+var MAX_PAYLOAD_SIZE = 1e6;
+var SumoLogicTransport = class extends LoggerlessTransport {
+  url;
+  useCompression;
+  sourceCategory;
+  sourceName;
+  sourceHost;
+  fields;
+  headers;
+  maxRetries;
+  initialRetryMs;
+  onError;
+  messageField;
+  constructor(config) {
+    super(config);
+    this.url = config.url;
+    this.useCompression = config.useCompression ?? true;
+    this.sourceCategory = config.sourceCategory;
+    this.sourceName = config.sourceName;
+    this.sourceHost = config.sourceHost;
+    this.fields = config.fields ?? {};
+    this.headers = config.headers ?? {};
+    this.maxRetries = config.retryConfig?.maxRetries ?? 3;
+    this.initialRetryMs = config.retryConfig?.initialRetryMs ?? 1e3;
+    this.onError = config.onError;
+    this.messageField = config.messageField ?? "message";
+  }
+  /**
+   * Compresses data using gzip compression.
+   */
+  async compressData(data) {
+    const stream = new CompressionStream("gzip");
+    const writer = stream.writable.getWriter();
+    const textEncoder = new TextEncoder();
+    const chunks = [];
+    await writer.write(textEncoder.encode(data));
+    await writer.close();
+    const reader = stream.readable.getReader();
+    while (true) {
+      const { value, done } = await reader.read();
+      if (done) break;
+      chunks.push(value);
+    }
+    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+    const result = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const chunk of chunks) {
+      result.set(chunk, offset);
+      offset += chunk.length;
+    }
+    return result;
+  }
+  /**
+   * Handles errors by calling the onError callback if defined
+   */
+  handleError(error) {
+    if (this.onError) {
+      this.onError(error);
+    }
+  }
+  /**
+   * Sends logs to SumoLogic with retry logic, compression, and size validation.
+   */
+  async sendToSumoLogic(payload, retryCount = 0) {
+    try {
+      const rawSize = new TextEncoder().encode(payload).length;
+      if (rawSize > MAX_PAYLOAD_SIZE) {
+        const error = `Payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${rawSize} bytes`;
+        this.handleError(error);
+        return;
+      }
+      let compressedPayload;
+      if (this.useCompression) {
+        compressedPayload = await this.compressData(payload);
+        if (compressedPayload.length > MAX_PAYLOAD_SIZE) {
+          const error = `Compressed payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${compressedPayload.length} bytes`;
+          this.handleError(error);
+          return;
+        }
+      }
+      const headers = {
+        ...this.headers,
+        "Content-Type": "application/json"
+      };
+      if (this.sourceCategory) {
+        headers["X-Sumo-Category"] = this.sourceCategory;
+      }
+      if (this.sourceName) {
+        headers["X-Sumo-Name"] = this.sourceName;
+      }
+      if (this.sourceHost) {
+        headers["X-Sumo-Host"] = this.sourceHost;
+      }
+      if (this.useCompression) {
+        headers["Content-Encoding"] = "gzip";
+      }
+      if (Object.keys(this.fields).length > 0) {
+        headers["X-Sumo-Fields"] = Object.entries(this.fields).map(([key, value]) => `${key}=${value}`).join(",");
+      }
+      const response = await fetch(this.url, {
+        method: "POST",
+        headers,
+        body: this.useCompression ? compressedPayload : payload
+      });
+      if (!response.ok) {
+        throw new Error(`HTTP error! status: ${response.status}`);
+      }
+    } catch (error) {
+      if (retryCount < this.maxRetries) {
+        const delay = this.initialRetryMs * 2 ** retryCount;
+        await new Promise((resolve) => setTimeout(resolve, delay));
+        return this.sendToSumoLogic(payload, retryCount + 1);
+      }
+      this.handleError(error instanceof Error ? error : String(error));
+    }
+  }
+  shipToLogger({ logLevel, messages, data, hasData }) {
+    const stringMessages = messages.filter((msg) => typeof msg === "string");
+    const message = stringMessages.join(" ");
+    const payload = {
+      severity: logLevel,
+      timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+      ...data && hasData ? data : {}
+    };
+    if (message) {
+      payload[this.messageField] = message;
+    }
+    this.sendToSumoLogic(JSON.stringify(payload));
+    return messages;
+  }
+};
+export {
+  SumoLogicTransport
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/SumoLogicTransport.ts"],"sourcesContent":["import { type LogLayerTransportParams, LoggerlessTransport, type LoggerlessTransportConfig } from \"@loglayer/transport\";\n\ninterface SumoLogicTransportConfig extends LoggerlessTransportConfig {\n  /**\n   * The URL of your HTTP Source endpoint\n   */\n  url: string;\n\n  /**\n   * Whether to use gzip compression (defaults to true)\n   */\n  useCompression?: boolean;\n\n  /**\n   * Source category to assign to the logs (optional)\n   */\n  sourceCategory?: string;\n\n  /**\n   * Source name to assign to the logs (optional)\n   */\n  sourceName?: string;\n\n  /**\n   * Source host to assign to the logs (optional)\n   */\n  sourceHost?: string;\n\n  /**\n   * Fields to be added as X-Sumo-Fields header (optional)\n   * Will be formatted as a comma-separated list of key=value pairs\n   */\n  fields?: Record<string, string>;\n\n  /**\n   * Custom headers to be added to the request (optional)\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * Retry configuration (optional)\n   */\n  retryConfig?: {\n    maxRetries?: number;\n    initialRetryMs?: number;\n  };\n\n  /**\n   * Optional callback for error handling\n   */\n  onError?: (error: Error | string) => void;\n\n  /**\n   * Field name to use for the message (defaults to \"message\")\n   */\n  messageField?: string;\n}\n\nconst MAX_PAYLOAD_SIZE = 1000000; // 1MB limit as per SumoLogic docs\n\nexport class SumoLogicTransport extends LoggerlessTransport {\n  private url: string;\n  private useCompression: boolean;\n  private sourceCategory?: string;\n  private sourceName?: string;\n  private sourceHost?: string;\n  private fields: Record<string, string>;\n  private headers: Record<string, string>;\n  private maxRetries: number;\n  private initialRetryMs: number;\n  private onError?: (error: Error | string) => void;\n  private messageField: string;\n\n  constructor(config: SumoLogicTransportConfig) {\n    super(config);\n    this.url = config.url;\n    this.useCompression = config.useCompression ?? true;\n    this.sourceCategory = config.sourceCategory;\n    this.sourceName = config.sourceName;\n    this.sourceHost = config.sourceHost;\n    this.fields = config.fields ?? {};\n    this.headers = config.headers ?? {};\n    this.maxRetries = config.retryConfig?.maxRetries ?? 3;\n    this.initialRetryMs = config.retryConfig?.initialRetryMs ?? 1000;\n    this.onError = config.onError;\n    this.messageField = config.messageField ?? \"message\";\n  }\n\n  /**\n   * Compresses data using gzip compression.\n   */\n  private async compressData(data: string): Promise<Uint8Array> {\n    const stream = new CompressionStream(\"gzip\");\n    const writer = stream.writable.getWriter();\n    const textEncoder = new TextEncoder();\n    const chunks: Uint8Array[] = [];\n\n    await writer.write(textEncoder.encode(data));\n    await writer.close();\n\n    const reader = stream.readable.getReader();\n\n    while (true) {\n      const { value, done } = await reader.read();\n      if (done) break;\n      chunks.push(value);\n    }\n\n    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);\n    const result = new Uint8Array(totalLength);\n    let offset = 0;\n\n    for (const chunk of chunks) {\n      result.set(chunk, offset);\n      offset += chunk.length;\n    }\n\n    return result;\n  }\n\n  /**\n   * Handles errors by calling the onError callback if defined\n   */\n  private handleError(error: Error | string): void {\n    if (this.onError) {\n      this.onError(error);\n    }\n  }\n\n  /**\n   * Sends logs to SumoLogic with retry logic, compression, and size validation.\n   */\n  private async sendToSumoLogic(payload: string, retryCount = 0): Promise<void> {\n    try {\n      // Check payload size before compression\n      const rawSize = new TextEncoder().encode(payload).length;\n      if (rawSize > MAX_PAYLOAD_SIZE) {\n        const error = `Payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${rawSize} bytes`;\n        this.handleError(error);\n        return;\n      }\n\n      let compressedPayload: Uint8Array | undefined;\n      if (this.useCompression) {\n        compressedPayload = await this.compressData(payload);\n        if (compressedPayload.length > MAX_PAYLOAD_SIZE) {\n          const error = `Compressed payload size exceeds maximum of ${MAX_PAYLOAD_SIZE} bytes. Size: ${compressedPayload.length} bytes`;\n          this.handleError(error);\n          return;\n        }\n      }\n\n      const headers: Record<string, string> = {\n        ...this.headers,\n        \"Content-Type\": \"application/json\",\n      };\n\n      if (this.sourceCategory) {\n        headers[\"X-Sumo-Category\"] = this.sourceCategory;\n      }\n      if (this.sourceName) {\n        headers[\"X-Sumo-Name\"] = this.sourceName;\n      }\n      if (this.sourceHost) {\n        headers[\"X-Sumo-Host\"] = this.sourceHost;\n      }\n      if (this.useCompression) {\n        headers[\"Content-Encoding\"] = \"gzip\";\n      }\n      if (Object.keys(this.fields).length > 0) {\n        headers[\"X-Sumo-Fields\"] = Object.entries(this.fields)\n          .map(([key, value]) => `${key}=${value}`)\n          .join(\",\");\n      }\n\n      const response = (await fetch(this.url, {\n        method: \"POST\",\n        headers,\n        body: this.useCompression ? compressedPayload : payload,\n      })) as Response;\n\n      if (!response.ok) {\n        throw new Error(`HTTP error! status: ${response.status}`);\n      }\n    } catch (error) {\n      if (retryCount < this.maxRetries) {\n        const delay = this.initialRetryMs * 2 ** retryCount;\n        await new Promise((resolve) => setTimeout(resolve, delay));\n        return this.sendToSumoLogic(payload, retryCount + 1);\n      }\n      this.handleError(error instanceof Error ? error : String(error));\n    }\n  }\n\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[] {\n    // Only use the string messages for content\n    const stringMessages = messages.filter((msg) => typeof msg === \"string\");\n    const message = stringMessages.join(\" \");\n\n    const payload = {\n      severity: logLevel,\n      timestamp: new Date().toISOString(),\n      ...(data && hasData ? data : {}),\n    };\n\n    if (message) {\n      payload[this.messageField] = message;\n    }\n\n    this.sendToSumoLogic(JSON.stringify(payload));\n\n    return messages;\n  }\n}\n"],"mappings":";AAAA,SAAuC,2BAA2D;AA0DlG,IAAM,mBAAmB;AAElB,IAAM,qBAAN,cAAiC,oBAAoB;AAAA,EAClD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAER,YAAY,QAAkC;AAC5C,UAAM,MAAM;AACZ,SAAK,MAAM,OAAO;AAClB,SAAK,iBAAiB,OAAO,kBAAkB;AAC/C,SAAK,iBAAiB,OAAO;AAC7B,SAAK,aAAa,OAAO;AACzB,SAAK,aAAa,OAAO;AACzB,SAAK,SAAS,OAAO,UAAU,CAAC;AAChC,SAAK,UAAU,OAAO,WAAW,CAAC;AAClC,SAAK,aAAa,OAAO,aAAa,cAAc;AACpD,SAAK,iBAAiB,OAAO,aAAa,kBAAkB;AAC5D,SAAK,UAAU,OAAO;AACtB,SAAK,eAAe,OAAO,gBAAgB;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,aAAa,MAAmC;AAC5D,UAAM,SAAS,IAAI,kBAAkB,MAAM;AAC3C,UAAM,SAAS,OAAO,SAAS,UAAU;AACzC,UAAM,cAAc,IAAI,YAAY;AACpC,UAAM,SAAuB,CAAC;AAE9B,UAAM,OAAO,MAAM,YAAY,OAAO,IAAI,CAAC;AAC3C,UAAM,OAAO,MAAM;AAEnB,UAAM,SAAS,OAAO,SAAS,UAAU;AAEzC,WAAO,MAAM;AACX,YAAM,EAAE,OAAO,KAAK,IAAI,MAAM,OAAO,KAAK;AAC1C,UAAI,KAAM;AACV,aAAO,KAAK,KAAK;AAAA,IACnB;AAEA,UAAM,cAAc,OAAO,OAAO,CAAC,KAAK,UAAU,MAAM,MAAM,QAAQ,CAAC;AACvE,UAAM,SAAS,IAAI,WAAW,WAAW;AACzC,QAAI,SAAS;AAEb,eAAW,SAAS,QAAQ;AAC1B,aAAO,IAAI,OAAO,MAAM;AACxB,gBAAU,MAAM;AAAA,IAClB;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKQ,YAAY,OAA6B;AAC/C,QAAI,KAAK,SAAS;AAChB,WAAK,QAAQ,KAAK;AAAA,IACpB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,gBAAgB,SAAiB,aAAa,GAAkB;AAC5E,QAAI;AAEF,YAAM,UAAU,IAAI,YAAY,EAAE,OAAO,OAAO,EAAE;AAClD,UAAI,UAAU,kBAAkB;AAC9B,cAAM,QAAQ,mCAAmC,gBAAgB,iBAAiB,OAAO;AACzF,aAAK,YAAY,KAAK;AACtB;AAAA,MACF;AAEA,UAAI;AACJ,UAAI,KAAK,gBAAgB;AACvB,4BAAoB,MAAM,KAAK,aAAa,OAAO;AACnD,YAAI,kBAAkB,SAAS,kBAAkB;AAC/C,gBAAM,QAAQ,8CAA8C,gBAAgB,iBAAiB,kBAAkB,MAAM;AACrH,eAAK,YAAY,KAAK;AACtB;AAAA,QACF;AAAA,MACF;AAEA,YAAM,UAAkC;AAAA,QACtC,GAAG,KAAK;AAAA,QACR,gBAAgB;AAAA,MAClB;AAEA,UAAI,KAAK,gBAAgB;AACvB,gBAAQ,iBAAiB,IAAI,KAAK;AAAA,MACpC;AACA,UAAI,KAAK,YAAY;AACnB,gBAAQ,aAAa,IAAI,KAAK;AAAA,MAChC;AACA,UAAI,KAAK,YAAY;AACnB,gBAAQ,aAAa,IAAI,KAAK;AAAA,MAChC;AACA,UAAI,KAAK,gBAAgB;AACvB,gBAAQ,kBAAkB,IAAI;AAAA,MAChC;AACA,UAAI,OAAO,KAAK,KAAK,MAAM,EAAE,SAAS,GAAG;AACvC,gBAAQ,eAAe,IAAI,OAAO,QAAQ,KAAK,MAAM,EAClD,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,EACvC,KAAK,GAAG;AAAA,MACb;AAEA,YAAM,WAAY,MAAM,MAAM,KAAK,KAAK;AAAA,QACtC,QAAQ;AAAA,QACR;AAAA,QACA,MAAM,KAAK,iBAAiB,oBAAoB;AAAA,MAClD,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AAChB,cAAM,IAAI,MAAM,uBAAuB,SAAS,MAAM,EAAE;AAAA,MAC1D;AAAA,IACF,SAAS,OAAO;AACd,UAAI,aAAa,KAAK,YAAY;AAChC,cAAM,QAAQ,KAAK,iBAAiB,KAAK;AACzC,cAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AACzD,eAAO,KAAK,gBAAgB,SAAS,aAAa,CAAC;AAAA,MACrD;AACA,WAAK,YAAY,iBAAiB,QAAQ,QAAQ,OAAO,KAAK,CAAC;AAAA,IACjE;AAAA,EACF;AAAA,EAEA,aAAa,EAAE,UAAU,UAAU,MAAM,QAAQ,GAAmC;AAElF,UAAM,iBAAiB,SAAS,OAAO,CAAC,QAAQ,OAAO,QAAQ,QAAQ;AACvE,UAAM,UAAU,eAAe,KAAK,GAAG;AAEvC,UAAM,UAAU;AAAA,MACd,UAAU;AAAA,MACV,YAAW,oBAAI,KAAK,GAAE,YAAY;AAAA,MAClC,GAAI,QAAQ,UAAU,OAAO,CAAC;AAAA,IAChC;AAEA,QAAI,SAAS;AACX,cAAQ,KAAK,YAAY,IAAI;AAAA,IAC/B;AAEA,SAAK,gBAAgB,KAAK,UAAU,OAAO,CAAC;AAE5C,WAAO;AAAA,EACT;AACF;","names":[]}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@loglayer/transport-sumo-logic",
+  "description": "Sumo Logic transport for LogLayer.",
+  "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": "loglayer/loglayer.git",
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "sumologic",
+    "transport"
+  ],
+  "dependencies": {
+    "@loglayer/transport": "1.1.5"
+  },
+  "devDependencies": {
+    "hash-runner": "2.0.1",
+    "@types/node": "22.10.4",
+    "serialize-error": "11.0.3",
+    "tsup": "8.3.5",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8",
+    "tsx": "4.19.2",
+    "@internal/tsconfig": "1.0.0",
+    "loglayer": "5.1.1"
+  },
+  "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",
+    "livetest": "tsx src/__tests__/livetest.ts"
+  }
+}