@rf-logger/logger-sentry 0.0.9

package/dist/formats/sentry.format.d.ts

@@ -0,0 +1,6 @@
+import winston from "winston";
+/**
+ * This format only role is to intercept logs and populate Sentry breadcrumbs.
+ * This data is only sent to Sentry when an error is thrown.
+ */
+export declare const sentryFormat: winston.Logform.FormatWrap;

package/dist/formats/sentry.format.js

@@ -0,0 +1,53 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sentryFormat = void 0;
+const Sentry = __importStar(require("@sentry/node"));
+const winston_1 = __importDefault(require("winston"));
+const sentry_utils_1 = require("../sentry.utils");
+/**
+ * This format only role is to intercept logs and populate Sentry breadcrumbs.
+ * This data is only sent to Sentry when an error is thrown.
+ */
+exports.sentryFormat = winston_1.default.format((info) => {
+    if (
+    // filter out logs that are not needed
+    ![
+        "audit",
+        "axios", // HTTP calls are already intercepted by Sentry's HTTP integration
+    ].includes(info.channel)) {
+        Sentry.addBreadcrumb({
+            category: info.channel,
+            level: sentry_utils_1.SentryLevelMap[info.level] || "debug",
+            message: info.message,
+            timestamp: new Date().getTime() / 1000,
+            data: Object.assign(Object.assign({}, info), { level: undefined, message: undefined, channel: undefined }),
+        });
+    }
+    return info;
+});

package/dist/forwarders/sentry.forwarder.d.ts

@@ -0,0 +1,2 @@
+import { ErrorForwarder } from "@rf-logger/logger/src";
+export declare const sentryForwarder: ErrorForwarder;

package/dist/forwarders/sentry.forwarder.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sentryForwarder = void 0;
+const sentry_utils_1 = require("../sentry.utils");
+const Sentry = __importStar(require("@sentry/node"));
+const deepmerge_1 = __importDefault(require("deepmerge"));
+const sentryForwarder = (error, info, meta) => {
+    Sentry.captureException(error, (0, deepmerge_1.default)(meta, {
+        level: sentry_utils_1.SentryLevelMap[info.level] || "error",
+        tags: {
+            handled: /^(:?uncaughtException)|(:?unhandledRejection)|(:?Unhandled error):/.test(info.message)
+                ? "no"
+                : "yes",
+            traceId: error.traceId,
+        },
+    }));
+};
+exports.sentryForwarder = sentryForwarder;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { LoggerPlugin } from "@rf-logger/logger";
+declare const plugin: LoggerPlugin;
+export default plugin;

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sentry_format_1 = require("./formats/sentry.format");
+const sentry_forwarder_1 = require("./forwarders/sentry.forwarder");
+const plugin = {
+    registerFormats: () => [(0, sentry_format_1.sentryFormat)()],
+    registerErrorForwarders: () => {
+        return [sentry_forwarder_1.sentryForwarder];
+    },
+};
+exports.default = plugin;

package/dist/sentry.utils.d.ts

@@ -0,0 +1,3 @@
+import * as Sentry from "@sentry/node";
+import type { LogLevel } from "@rf-logger/logger";
+export declare const SentryLevelMap: Record<LogLevel, Sentry.SeverityLevel>;

package/dist/sentry.utils.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentryLevelMap = void 0;
+exports.SentryLevelMap = {
+    error: "error",
+    warn: "warning",
+    info: "info",
+    http: "log",
+    verbose: "log",
+    debug: "debug",
+    silly: "debug",
+};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@rf-logger/logger-sentry",
+  "files": [
+    "dist/**"
+  ],
+  "main": "dist/index.js",
+  "peerDependencies": {
+    "@sentry/node": "^7.47.0",
+    "winston": "^3.8.2",
+    "@rf-logger/logger": "0.0.9"
+  },
+  "dependencies": {
+    "deepmerge": "^4.2.2"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "devDependencies": {
+    "sentry-testkit": "^5.0.5"
+  },
+  "version": "0.0.9",
+  "scripts": {
+    "test": "jest",
+    "version": "pnpm version --no-git-tag-version"
+  }
+}