widelogger 0.5.0 → 0.7.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import type { DottedKey, FieldValue } from "./types";
+import type { TransportMultiOptions, TransportSingleOptions } from "pino";
+import type { DottedKey, ErrorParser, FieldValue } from "./types";
 export interface WideloggerOptions {
     service: string;
     defaultEventName: string;
@@ -7,6 +8,7 @@ export interface WideloggerOptions {
     instanceId?: string;
     environment?: string;
     level?: string;
+    transport?: TransportSingleOptions | TransportMultiOptions;
 }
 export interface ErrorFieldsOptions {
     prefix?: string;
@@ -32,6 +34,8 @@ export declare const widelog: {
         stop: <K extends string>(key: DottedKey<K>) => void;
         measure: typeof measure;
     };
+    errors: (parser: ErrorParser) => void;
+    error: <K extends string>(key: DottedKey<K>, error: unknown) => void;
     errorFields: (error: unknown, options?: ErrorFieldsOptions) => void;
     flush: () => void;
 };
@@ -43,4 +47,4 @@ export declare const widelogger: (options: WideloggerOptions) => {
     destroy: () => Promise<void>;
 };
 export type Widelog = typeof widelog;
-export {};
+export type { TransportMultiOptions, TransportSingleOptions } from "pino";

package/dist/index.js

@@ -32,9 +32,29 @@ var createAggregators = () => ({
   arrays: Object.create(null),
   maxValues: Object.create(null),
   minValues: Object.create(null),
-  timers: Object.create(null)
+  timers: Object.create(null),
+  errors: Object.create(null)
 });
-var processOperation = (agg, entry) => {
+var aggregateError = (agg, key, slug) => {
+  const existing = agg.errors[key];
+  if (existing) {
+    existing.total += 1;
+    const previousCount = existing.counts[slug];
+    if (typeof previousCount === "number") {
+      existing.counts[slug] = previousCount + 1;
+    } else {
+      existing.counts[slug] = 1;
+      existing.slugs.push(slug);
+    }
+  } else {
+    agg.errors[key] = {
+      slugs: [slug],
+      counts: { [slug]: 1 },
+      total: 1
+    };
+  }
+};
+var processOperation = (agg, entry, errorParser) => {
   switch (entry.operation) {
     case "set":
       setNested(agg.event, entry.key, entry.value);
@@ -66,9 +86,9 @@ var processOperation = (agg, entry) => {
       break;
     }
     case "time.start": {
-      const existing = agg.timers[entry.key];
-      if (existing) {
-        existing.start = entry.time;
+      const existingTimer = agg.timers[entry.key];
+      if (existingTimer) {
+        existingTimer.start = entry.time;
       } else {
         agg.timers[entry.key] = { start: entry.time, accumulated: 0 };
       }
@@ -82,6 +102,13 @@ var processOperation = (agg, entry) => {
       }
       break;
     }
+    case "error": {
+      if (errorParser) {
+        const slug = errorParser(entry.error);
+        aggregateError(agg, entry.key, slug);
+      }
+      break;
+    }
     default:
   }
 };
@@ -90,7 +117,8 @@ var mergeAggregators = (agg) => {
     agg.counters,
     agg.arrays,
     agg.maxValues,
-    agg.minValues
+    agg.minValues,
+    agg.errors
   ];
   for (const source of sources) {
     for (const key of Object.keys(source)) {
@@ -112,10 +140,10 @@ var flush = (context) => {
   }
   const agg = createAggregators();
   for (const entry of context.stickyOperations) {
-    processOperation(agg, entry);
+    processOperation(agg, entry, context.errorParser);
   }
   for (const entry of context.operations) {
-    processOperation(agg, entry);
+    processOperation(agg, entry, context.errorParser);
   }
   mergeAggregators(agg);
   context.operations = [];
@@ -252,6 +280,16 @@ var widelog = {
     },
     measure
   },
+  errors: (parser) => {
+    const store = storage.getStore();
+    if (!store) {
+      return;
+    }
+    store.errorParser = parser;
+  },
+  error: (key, error) => {
+    pushOp({ operation: "error", key, error });
+  },
   errorFields: (error, options = {}) => {
     const context = storage.getStore();
     if (!context) {
@@ -312,19 +350,28 @@ var widelog = {
     store.transport(event);
   }
 };
+function resolveTransport(custom, isDevelopment) {
+  if (custom) {
+    return pino.transport(custom);
+  }
+  if (isDevelopment) {
+    return pino.transport({
+      target: "pino-pretty",
+      options: {
+        colorize: true,
+        singleLine: true,
+        translateTime: "SYS:standard",
+        ignore: "pid,hostname"
+      }
+    });
+  }
+  return;
+}
 var widelogger = (options) => {
   const nodeEnvironment = typeof process.env === "object" ? "development" : undefined;
   const environment = options.environment ?? nodeEnvironment ?? "development";
   const isDevelopment = environment !== "production";
-  const pinoTransport = isDevelopment ? pino.transport({
-    target: "pino-pretty",
-    options: {
-      colorize: true,
-      singleLine: true,
-      translateTime: "SYS:standard",
-      ignore: "pid,hostname"
-    }
-  }) : undefined;
+  const pinoTransport = resolveTransport(options.transport, isDevelopment);
   const logger = pino({
     level: options.level ?? process.env.LOG_LEVEL ?? "info",
     timestamp: pino.stdTimeFunctions.isoTime,
@@ -355,7 +402,12 @@ var widelogger = (options) => {
     }
   };
   function context(callback) {
-    return storage.run({ operations: [], stickyOperations: [], transport }, () => {
+    return storage.run({
+      operations: [],
+      stickyOperations: [],
+      errorParser: null,
+      transport
+    }, () => {
       let result;
       try {
         result = callback();

package/dist/types.d.ts

@@ -5,6 +5,7 @@ interface KeyErrorBrand {
 }
 type ValidateKey<T extends string> = T extends "" ? "widelog keys cannot be empty" & KeyErrorBrand : T extends `.${string}` ? "widelog keys cannot start with a dot" & KeyErrorBrand : T extends `${string}.` ? "widelog keys cannot end with a dot" & KeyErrorBrand : T extends `${string}..${string}` ? "widelog keys cannot contain empty segments" & KeyErrorBrand : T;
 export type DottedKey<T extends string> = ValidateKey<T>;
+export type ErrorParser = (error: unknown) => string;
 export type Operation = {
     operation: "set";
     key: string;
@@ -33,10 +34,15 @@ export type Operation = {
     operation: "time.stop";
     key: string;
     time: number;
+} | {
+    operation: "error";
+    key: string;
+    error: unknown;
 };
 export interface Context {
     operations: Operation[];
     stickyOperations: Operation[];
+    errorParser: ErrorParser | null;
     transport: (event: Record<string, unknown>) => void;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "widelogger",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",