@loglayer/transport-sentry 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,63 @@
+# @loglayer/transport-sentry
+
+[![npm version](https://img.shields.io/npm/v/@loglayer/transport-sentry.svg)](https://www.npmjs.com/package/@loglayer/transport-sentry)
+[![npm downloads](https://img.shields.io/npm/dm/@loglayer/transport-sentry.svg)](https://www.npmjs.com/package/@loglayer/transport-sentry)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+
+Sentry transport for the LogLayer logging library. This transport sends structured logs to Sentry using any Sentry logger instance.
+
+## Installation
+
+```bash
+npm install @loglayer/transport-sentry serialize-error <sentry-sdk>
+```
+
+```bash
+yarn add @loglayer/transport-sentry serialize-error <sentry-sdk>
+```
+
+```bash
+pnpm add @loglayer/transport-sentry serialize-error <sentry-sdk>
+```
+
+Replace `<sentry-sdk>` with the appropriate Sentry SDK for your platform:
+
+- **Browser**: [@sentry/browser](https://docs.sentry.io/platforms/javascript/logs/)
+- **Next.js**: [@sentry/nextjs](https://docs.sentry.io/platforms/javascript/guides/nextjs/logs/)
+- **Bun**: [@sentry/bun](https://docs.sentry.io/platforms/javascript/guides/bun/logs/)
+- **Deno**: [@sentry/deno](https://docs.sentry.io/platforms/javascript/guides/deno/)
+- **Node.js**: [@sentry/node](https://docs.sentry.io/platforms/javascript/guides/node/)
+
+## Usage
+
+```typescript
+import { LogLayer } from "loglayer";
+import { SentryTransport } from "@loglayer/transport-sentry";
+import { serializeError } from "serialize-error";
+// node.js example, but most of the JS-based SDKs follow this pattern
+import * as Sentry from "@sentry/node";
+
+// In most cases, you'll want to initialize at the top-most entrypoint
+// to your app so Sentry can instrument your code, such as the index.ts file
+Sentry.init({
+  dsn: "YOUR_SENTRY_DSN",
+  enableLogs: true,
+});
+
+const log = new LogLayer({
+  errorSerializer: serializeError,
+  transport: [
+    new SentryTransport({
+      logger: Sentry.logger,
+    }),
+  ],
+});
+
+// Use LogLayer as normal
+log.withMetadata({ userId: 123 }).info("User logged in");
+log.withError(new Error("Something went wrong")).error("Operation failed");
+```
+
+## Documentation
+
+For more detailed documentation, visit the [LogLayer website](https://loglayer.dev/transports/sentry).

package/dist/index.cjs

@@ -0,0 +1,75 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let __loglayer_transport = require("@loglayer/transport");
+__loglayer_transport = __toESM(__loglayer_transport);
+
+//#region src/SentryTransport.ts
+/**
+* SentryTransport is responsible for sending logs to Sentry using the Sentry SDK.
+* It uses the Sentry logger API to send structured logs to Sentry.
+*
+* Features:
+* - Uses Sentry logger for structured logging
+* - Supports all Sentry log levels (trace, debug, info, warn, error, fatal)
+* - Automatic error and debug callbacks
+* - Integrates with Sentry's structured logging features
+*/
+var SentryTransport = class extends __loglayer_transport.BaseTransport {
+	/**
+	* Processes and ships log entries to Sentry using the Sentry logger.
+	*
+	* @param params - Log parameters including level, messages, and metadata
+	* @returns The original messages array
+	*/
+	shipToLogger({ logLevel, messages, data, hasData }) {
+		const args = [messages.join(" ")];
+		if (data && hasData) args.push(data);
+		switch (logLevel) {
+			case "trace":
+				this.logger.trace(...args);
+				break;
+			case "debug":
+				this.logger.debug(...args);
+				break;
+			case "info":
+				this.logger.info(...args);
+				break;
+			case "warn":
+				this.logger.warn(...args);
+				break;
+			case "error":
+				this.logger.error(...args);
+				break;
+			case "fatal":
+				this.logger.fatal(...args);
+				break;
+			default: this.logger.info(...args);
+		}
+		return messages;
+	}
+};
+
+//#endregion
+exports.SentryTransport = SentryTransport;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["BaseTransport"],"sources":["../src/SentryTransport.ts"],"sourcesContent":["import type { LogLayerTransportConfig, LogLayerTransportParams } from \"@loglayer/transport\";\nimport { BaseTransport } from \"@loglayer/transport\";\n\n/**\n * Sentry logger interface\n */\nexport interface SentryLogger {\n  trace: (...args: any[]) => void;\n  debug: (...args: any[]) => void;\n  info: (...args: any[]) => void;\n  warn: (...args: any[]) => void;\n  error: (...args: any[]) => void;\n  fatal: (...args: any[]) => void;\n}\n\n/**\n * Configuration options for the Sentry transport.\n */\nexport interface SentryTransportConfig extends LogLayerTransportConfig<SentryLogger> {\n  // No additional configuration needed beyond the base transport config\n}\n\n/**\n * SentryTransport is responsible for sending logs to Sentry using the Sentry SDK.\n * It uses the Sentry logger API to send structured logs to Sentry.\n *\n * Features:\n * - Uses Sentry logger for structured logging\n * - Supports all Sentry log levels (trace, debug, info, warn, error, fatal)\n * - Automatic error and debug callbacks\n * - Integrates with Sentry's structured logging features\n */\nexport class SentryTransport extends BaseTransport<SentryLogger> {\n  /**\n   * Processes and ships log entries to Sentry using the Sentry logger.\n   *\n   * @param params - Log parameters including level, messages, and metadata\n   * @returns The original messages array\n   */\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[] {\n    // Create a new array with joined message and optional data\n    const args = [messages.join(\" \")];\n\n    if (data && hasData) {\n      // Add data object as a separate parameter\n      // @ts-expect-error\n      args.push(data);\n    }\n\n    // Map LogLayer log levels to Sentry logger methods\n    switch (logLevel) {\n      case \"trace\":\n        this.logger.trace(...args);\n        break;\n      case \"debug\":\n        this.logger.debug(...args);\n        break;\n      case \"info\":\n        this.logger.info(...args);\n        break;\n      case \"warn\":\n        this.logger.warn(...args);\n        break;\n      case \"error\":\n        this.logger.error(...args);\n        break;\n      case \"fatal\":\n        this.logger.fatal(...args);\n        break;\n      default:\n        // Fallback to info level for unknown log levels\n        this.logger.info(...args);\n    }\n\n    return messages;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,IAAa,kBAAb,cAAqCA,mCAA4B;;;;;;;CAO/D,aAAa,EAAE,UAAU,UAAU,MAAM,WAA2C;EAElF,MAAM,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC;AAEjC,MAAI,QAAQ,QAGV,MAAK,KAAK,KAAK;AAIjB,UAAQ,UAAR;GACE,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,KAAK;AACH,SAAK,OAAO,KAAK,GAAG,KAAK;AACzB;GACF,KAAK;AACH,SAAK,OAAO,KAAK,GAAG,KAAK;AACzB;GACF,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,QAEE,MAAK,OAAO,KAAK,GAAG,KAAK;;AAG7B,SAAO"}

package/dist/index.d.cts

@@ -0,0 +1,46 @@
+import { BaseTransport, LogLayerTransportConfig, LogLayerTransportParams } from "@loglayer/transport";
+
+//#region src/SentryTransport.d.ts
+
+/**
+ * Sentry logger interface
+ */
+interface SentryLogger {
+  trace: (...args: any[]) => void;
+  debug: (...args: any[]) => void;
+  info: (...args: any[]) => void;
+  warn: (...args: any[]) => void;
+  error: (...args: any[]) => void;
+  fatal: (...args: any[]) => void;
+}
+/**
+ * Configuration options for the Sentry transport.
+ */
+interface SentryTransportConfig extends LogLayerTransportConfig<SentryLogger> {}
+/**
+ * SentryTransport is responsible for sending logs to Sentry using the Sentry SDK.
+ * It uses the Sentry logger API to send structured logs to Sentry.
+ *
+ * Features:
+ * - Uses Sentry logger for structured logging
+ * - Supports all Sentry log levels (trace, debug, info, warn, error, fatal)
+ * - Automatic error and debug callbacks
+ * - Integrates with Sentry's structured logging features
+ */
+declare class SentryTransport extends BaseTransport<SentryLogger> {
+  /**
+   * Processes and ships log entries to Sentry using the Sentry logger.
+   *
+   * @param params - Log parameters including level, messages, and metadata
+   * @returns The original messages array
+   */
+  shipToLogger({
+    logLevel,
+    messages,
+    data,
+    hasData
+  }: LogLayerTransportParams): any[];
+}
+//#endregion
+export { type SentryLogger, SentryTransport, type SentryTransportConfig };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { BaseTransport, LogLayerTransportConfig, LogLayerTransportParams } from "@loglayer/transport";
+
+//#region src/SentryTransport.d.ts
+
+/**
+ * Sentry logger interface
+ */
+interface SentryLogger {
+  trace: (...args: any[]) => void;
+  debug: (...args: any[]) => void;
+  info: (...args: any[]) => void;
+  warn: (...args: any[]) => void;
+  error: (...args: any[]) => void;
+  fatal: (...args: any[]) => void;
+}
+/**
+ * Configuration options for the Sentry transport.
+ */
+interface SentryTransportConfig extends LogLayerTransportConfig<SentryLogger> {}
+/**
+ * SentryTransport is responsible for sending logs to Sentry using the Sentry SDK.
+ * It uses the Sentry logger API to send structured logs to Sentry.
+ *
+ * Features:
+ * - Uses Sentry logger for structured logging
+ * - Supports all Sentry log levels (trace, debug, info, warn, error, fatal)
+ * - Automatic error and debug callbacks
+ * - Integrates with Sentry's structured logging features
+ */
+declare class SentryTransport extends BaseTransport<SentryLogger> {
+  /**
+   * Processes and ships log entries to Sentry using the Sentry logger.
+   *
+   * @param params - Log parameters including level, messages, and metadata
+   * @returns The original messages array
+   */
+  shipToLogger({
+    logLevel,
+    messages,
+    data,
+    hasData
+  }: LogLayerTransportParams): any[];
+}
+//#endregion
+export { type SentryLogger, SentryTransport, type SentryTransportConfig };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,51 @@
+import { BaseTransport } from "@loglayer/transport";
+
+//#region src/SentryTransport.ts
+/**
+* SentryTransport is responsible for sending logs to Sentry using the Sentry SDK.
+* It uses the Sentry logger API to send structured logs to Sentry.
+*
+* Features:
+* - Uses Sentry logger for structured logging
+* - Supports all Sentry log levels (trace, debug, info, warn, error, fatal)
+* - Automatic error and debug callbacks
+* - Integrates with Sentry's structured logging features
+*/
+var SentryTransport = class extends BaseTransport {
+	/**
+	* Processes and ships log entries to Sentry using the Sentry logger.
+	*
+	* @param params - Log parameters including level, messages, and metadata
+	* @returns The original messages array
+	*/
+	shipToLogger({ logLevel, messages, data, hasData }) {
+		const args = [messages.join(" ")];
+		if (data && hasData) args.push(data);
+		switch (logLevel) {
+			case "trace":
+				this.logger.trace(...args);
+				break;
+			case "debug":
+				this.logger.debug(...args);
+				break;
+			case "info":
+				this.logger.info(...args);
+				break;
+			case "warn":
+				this.logger.warn(...args);
+				break;
+			case "error":
+				this.logger.error(...args);
+				break;
+			case "fatal":
+				this.logger.fatal(...args);
+				break;
+			default: this.logger.info(...args);
+		}
+		return messages;
+	}
+};
+
+//#endregion
+export { SentryTransport };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/SentryTransport.ts"],"sourcesContent":["import type { LogLayerTransportConfig, LogLayerTransportParams } from \"@loglayer/transport\";\nimport { BaseTransport } from \"@loglayer/transport\";\n\n/**\n * Sentry logger interface\n */\nexport interface SentryLogger {\n  trace: (...args: any[]) => void;\n  debug: (...args: any[]) => void;\n  info: (...args: any[]) => void;\n  warn: (...args: any[]) => void;\n  error: (...args: any[]) => void;\n  fatal: (...args: any[]) => void;\n}\n\n/**\n * Configuration options for the Sentry transport.\n */\nexport interface SentryTransportConfig extends LogLayerTransportConfig<SentryLogger> {\n  // No additional configuration needed beyond the base transport config\n}\n\n/**\n * SentryTransport is responsible for sending logs to Sentry using the Sentry SDK.\n * It uses the Sentry logger API to send structured logs to Sentry.\n *\n * Features:\n * - Uses Sentry logger for structured logging\n * - Supports all Sentry log levels (trace, debug, info, warn, error, fatal)\n * - Automatic error and debug callbacks\n * - Integrates with Sentry's structured logging features\n */\nexport class SentryTransport extends BaseTransport<SentryLogger> {\n  /**\n   * Processes and ships log entries to Sentry using the Sentry logger.\n   *\n   * @param params - Log parameters including level, messages, and metadata\n   * @returns The original messages array\n   */\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[] {\n    // Create a new array with joined message and optional data\n    const args = [messages.join(\" \")];\n\n    if (data && hasData) {\n      // Add data object as a separate parameter\n      // @ts-expect-error\n      args.push(data);\n    }\n\n    // Map LogLayer log levels to Sentry logger methods\n    switch (logLevel) {\n      case \"trace\":\n        this.logger.trace(...args);\n        break;\n      case \"debug\":\n        this.logger.debug(...args);\n        break;\n      case \"info\":\n        this.logger.info(...args);\n        break;\n      case \"warn\":\n        this.logger.warn(...args);\n        break;\n      case \"error\":\n        this.logger.error(...args);\n        break;\n      case \"fatal\":\n        this.logger.fatal(...args);\n        break;\n      default:\n        // Fallback to info level for unknown log levels\n        this.logger.info(...args);\n    }\n\n    return messages;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAgCA,IAAa,kBAAb,cAAqC,cAA4B;;;;;;;CAO/D,aAAa,EAAE,UAAU,UAAU,MAAM,WAA2C;EAElF,MAAM,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC;AAEjC,MAAI,QAAQ,QAGV,MAAK,KAAK,KAAK;AAIjB,UAAQ,UAAR;GACE,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,KAAK;AACH,SAAK,OAAO,KAAK,GAAG,KAAK;AACzB;GACF,KAAK;AACH,SAAK,OAAO,KAAK,GAAG,KAAK;AACzB;GACF,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,KAAK;AACH,SAAK,OAAO,MAAM,GAAG,KAAK;AAC1B;GACF,QAEE,MAAK,OAAO,KAAK,GAAG,KAAK;;AAG7B,SAAO"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@loglayer/transport-sentry",
+  "description": "Sentry 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/sentry"
+  },
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "sentry",
+    "transport"
+  ],
+  "dependencies": {
+    "@loglayer/transport": "2.3.4"
+  },
+  "devDependencies": {
+    "@sentry/node": "10.19.0",
+    "@types/node": "24.7.2",
+    "dotenv": "17.2.3",
+    "serialize-error": "12.0.0",
+    "tsdown": "0.15.7",
+    "tsx": "4.20.6",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4",
+    "loglayer": "6.9.1",
+    "@internal/tsconfig": "2.1.0"
+  },
+  "bugs": "https://github.com/loglayer/loglayer/issues",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://loglayer.dev",
+  "scripts": {
+    "build": "tsdown 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"
+  }
+}