@leaflink/snitch 1.0.0 → 1.1.0

package/README.md

@@ -25,12 +25,25 @@ The level a log was called at is passed to transports to help determine how a me
 
 ## Usage
 
+### Singleton Logger
+
 The default export exposed by `@leaflink/snitch` is a singleton logger instance with no initial transports, which can be shared between modules easily. It does not include any transports by default to allow flexibility in per-environment transports.
 
 ```typescript
 import logger from '@leaflink/snitch';
+import { ConsoleTransport } from '@leaflink/snitch/transports/console';
+
+if (config.debug) {
+  logger.addTransport(new ConsoleTransport());
+}
 ```
 
+### New Logger
+
+| Name | Default | Description |
+| --- | --- | --- |
+| `transports` | `[]` | Define transports when creating new logger instead of adding with `.addTransport` |
+
 In other situations, you may want to have a logger instance (or multiple instances) created and managed inside your application. To support this, `@leaflink/snitch` also exports a `Logger` class that can be used to create logger instances, optionally with predefined transports.
 
 ```typescript
@@ -45,9 +58,14 @@ const loggerInstance = new Logger({
 loggerInstance.log('Example log message');
 ```
 
-
 ### Console Transport
 
+Parameters:
+
+| Name | Default | Description |
+| --- | --- | --- |
+| `level` | `debug` | Minimum log level to handle. |
+
 `main.ts`
 ```typescript
 import logger from '@leaflink/snitch';
@@ -69,6 +87,13 @@ try {
 
 ### Sentry Transport
 
+Parameters:
+
+| Name | Default | Description |
+| --- | --- | --- |
+| `level` | `debug` | Minimum log level to handle. |
+| `sentryInstance` | N/A, required | Initialized Sentry logger instance. |
+
 `main.ts`
 ```typescript
 import * as Sentry from '@sentry/vue';
@@ -98,6 +123,46 @@ try {
 }
 ```
 
+### Datadog Logs Transport
+
+Parameters:
+
+| Name | Default | Description |
+| --- | --- | --- |
+| `level` | `info` | Minimum log level to handle. |
+| `datadogLogsInstance` | N/A, required | Initialized Datadog Logs instance. |
+
+See [Datadog Logs documentation](https://docs.datadoghq.com/logs/log_collection/javascript/#custom-logs) for more on custom logging with Datadog.
+
+`main.ts`
+```typescript
+import { datadogLogs } from '@datadog/browser-logs';
+import logger from '@leaflink/snitch';
+import { DatadogTransport } from '@leaflink/snitch/transports/datadog';
+
+// Important: init Datadog logs instance before creating transport
+datadogLogs.init({
+  // ...
+});
+logger.addTransport(new DatadogTransport({
+  datadogLogsInstance: datadogLogs,
+}));
+```
+
+call in component file
+```typescript
+import logger from '@leaflink/snitch';
+
+logger.info('File loaded!');
+
+try {
+  await someErroringMethod()
+} catch (err) {
+  // If an Error is passed as the message, this is captured as an exception in Datadog
+  logger.error(err, { id: 123 });
+}
+```
+
 ### With Log Level
 
 `main.ts`

package/dist/transports/datadog.d.ts

@@ -0,0 +1,11 @@
+import { LogLevel, Transport } from '../index.js';
+import type { datadogLogs } from '@datadog/browser-logs';
+export interface DatadogTransportOptions {
+    level?: LogLevel;
+    datadogLogsInstance: typeof datadogLogs;
+}
+export declare class DatadogTransport implements Transport {
+    level: LogLevel;
+    log: (message: string | object, meta: Record<string, unknown> | undefined, level: LogLevel) => void;
+    constructor(opts: DatadogTransportOptions);
+}

package/dist/transports/datadog.js

@@ -0,0 +1,23 @@
+export class DatadogTransport {
+    level;
+    log;
+    constructor(opts) {
+        this.level = opts.level || 'info';
+        this.log = (message, meta = {}, level) => {
+            // LogLevel maps directly to datadogLogsInstance logger methods
+            if (message instanceof Error) {
+                // Datadog logger has an optional third error param for exception handling
+                opts.datadogLogsInstance.logger[level](message.message, meta, message);
+            }
+            else if (typeof message === 'string') {
+                opts.datadogLogsInstance.logger[level](message, meta);
+            }
+            else {
+                // Datadog requires a string for the message param. Our downstream usage currently provides
+                // either a string or an Error, but for future-proofing this just stringify the unknown object as message.
+                opts.datadogLogsInstance.logger[level](JSON.stringify(message), meta);
+            }
+        };
+    }
+}
+//# sourceMappingURL=datadog.js.map

package/dist/transports/datadog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datadog.js","sourceRoot":"","sources":["../../src/transports/datadog.ts"],"names":[],"mappings":"AAQA,MAAM,OAAO,gBAAgB;IAC3B,KAAK,CAAW;IAChB,GAAG,CAAiG;IAEpG,YAAY,IAA6B;QACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;QAClC,IAAI,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE;YACvC,+DAA+D;YAC/D,IAAI,OAAO,YAAY,KAAK,EAAE;gBAC5B,0EAA0E;gBAC1E,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;aACxE;iBAAM,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBACtC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;aACvD;iBAAM;gBACL,2FAA2F;gBAC3F,0GAA0G;gBAC1G,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;aACvE;QACH,CAAC,CAAA;IACH,CAAC;CACF"}

package/package.json

@@ -1,13 +1,23 @@
 {
   "name": "@leaflink/snitch",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Front end logging inspired by winston.",
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./transports/console.js": {
+      "types": "./dist/transports/console.d.ts",
+      "import": "./dist/transports/console.js",
+      "default": "./dist/transports/console.js"
+    },
+    "./transports/sentry.js": {
+      "types": "./dist/transports/sentry.d.ts",
+      "import": "./dist/transports/sentry.js",
+      "default": "./dist/transports/sentry.js"
     }
   },
   "engines": {
@@ -17,6 +27,7 @@
   "files": [
     "dist"
   ],
+  "types": "./dist/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -38,6 +49,7 @@
   "devDependencies": {
     "@commitlint/cli": "^17.4.4",
     "@commitlint/config-conventional": "^17.4.4",
+    "@datadog/browser-logs": "^4.39.0",
     "@vitest/coverage-c8": "^0.29.2",
     "typescript": "^4.9.5",
     "vite": "^4.1.4",