@n8io/baseline-logger 2.1.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/index.d.ts +18 -2
- package/dist/index.js +30 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,9 @@ pnpm add @n8io/baseline-logger
|
|
|
8
8
|
|
|
9
9
|
## Exports
|
|
10
10
|
|
|
11
|
-
- `logger`: the
|
|
11
|
+
- `logger`: the one logger, typed as the package's own `Logger` (`fatal`, `error`, `warn`, `info`, `debug`, `trace` and `level`), so the library behind it can change without touching a caller. Fields named like credentials (`authorization`, `cookie`, `password`, `token` and others) are logged as `[Redacted]`, also one level down and in headers.
|
|
12
|
+
- `Logger` and `LoggerMethod`: the types of `logger` and of one level's call, `(fields, message?)` or `(message)`. There is no `child`, no printf-style arguments and no way to set `level`; the level comes from `LOG_LEVEL`.
|
|
13
|
+
- `loggerErrorListen(listener)` and `LoggerErrorListener`: calls `listener` with each error logged at error or fatal (an `err` field, or an Error passed first), inside the log call, so it sees the caller's active trace; returns a function that stops it. A listener that throws is skipped and the log line still goes out, and an error a listener logs is not heard again. Listeners live on `globalThis`, so two copies of this Package share them. A level that `LOG_LEVEL` turns off reaches no listener. `@n8io/baseline-error-tracking` reports errors this way.
|
|
12
14
|
- `@n8io/baseline-logger/err-serialize`: `loggerErrSerialize(value)` and `LoggerErr`. An error leaves the process only as its class name, `code`, `constraint` and stack, down the `cause` chain; never its message, which can hold input text. `logger` uses it for every `err`.
|
|
13
15
|
|
|
14
16
|
## Example
|
package/dist/index.d.ts
CHANGED
|
@@ -1,2 +1,18 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
type LoggerErrorListener = (error: unknown) => void;
|
|
2
|
+
/** Calls `listener` with every error logged at error or fatal; the returned function stops it. */
|
|
3
|
+
export declare const loggerErrorListen: (listener: LoggerErrorListener) => (() => void);
|
|
4
|
+
export type LoggerMethod = {
|
|
5
|
+
(fields: unknown, message?: string): void;
|
|
6
|
+
(message: string): void;
|
|
7
|
+
};
|
|
8
|
+
export type Logger = {
|
|
9
|
+
readonly level: string;
|
|
10
|
+
fatal: LoggerMethod;
|
|
11
|
+
error: LoggerMethod;
|
|
12
|
+
warn: LoggerMethod;
|
|
13
|
+
info: LoggerMethod;
|
|
14
|
+
debug: LoggerMethod;
|
|
15
|
+
trace: LoggerMethod;
|
|
16
|
+
};
|
|
17
|
+
export declare const logger: Logger;
|
|
18
|
+
export type { LoggerErrorListener };
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
import { loggerErrSerialize } from "./logger-err-serialize.js";
|
|
2
2
|
import { pino } from "pino";
|
|
3
|
+
// src/logger-error-listen.ts
|
|
4
|
+
const listenersKey = Symbol.for("@n8io/baseline-logger.errorListeners");
|
|
5
|
+
const registry = globalThis;
|
|
6
|
+
registry[listenersKey] ??= /* @__PURE__ */ new Set();
|
|
7
|
+
const listeners = registry[listenersKey];
|
|
8
|
+
let emitting = false;
|
|
9
|
+
/** Calls `listener` with every error logged at error or fatal; the returned function stops it. */
|
|
10
|
+
const loggerErrorListen = (listener) => {
|
|
11
|
+
listeners.add(listener);
|
|
12
|
+
return () => {
|
|
13
|
+
listeners.delete(listener);
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
const loggerErrorEmit = (error) => {
|
|
17
|
+
if (emitting) return;
|
|
18
|
+
emitting = true;
|
|
19
|
+
try {
|
|
20
|
+
for (const listener of listeners) try {
|
|
21
|
+
listener(error);
|
|
22
|
+
} catch {}
|
|
23
|
+
} finally {
|
|
24
|
+
emitting = false;
|
|
25
|
+
}
|
|
26
|
+
};
|
|
3
27
|
// src/logger-options.ts
|
|
4
28
|
const fieldsSecret = [
|
|
5
29
|
"accessToken",
|
|
@@ -26,10 +50,12 @@ const errFind = (first) => {
|
|
|
26
50
|
if (first instanceof Error) return first;
|
|
27
51
|
if (typeof first === "object" && first !== null && "err" in first && !("msg" in first)) return first.err;
|
|
28
52
|
};
|
|
29
|
-
const
|
|
30
|
-
|
|
53
|
+
const levelError = 50;
|
|
54
|
+
const loggerOptionsCreate = (level) => ({
|
|
55
|
+
hooks: { logMethod(args, method, level) {
|
|
31
56
|
const [first, second] = args;
|
|
32
57
|
const err = errFind(first);
|
|
58
|
+
if (err !== void 0 && level >= levelError) loggerErrorEmit(err);
|
|
33
59
|
if (err !== void 0 && typeof second !== "string") {
|
|
34
60
|
const type = loggerErrSerialize(err).type;
|
|
35
61
|
return method.apply(this, [first, type]);
|
|
@@ -44,5 +70,5 @@ const loggerOptions = (level) => ({
|
|
|
44
70
|
serializers: { err: loggerErrSerialize }
|
|
45
71
|
});
|
|
46
72
|
// src/index.ts
|
|
47
|
-
const logger = pino(
|
|
48
|
-
export { logger };
|
|
73
|
+
const logger = pino(loggerOptionsCreate(process.env.LOG_LEVEL || "info"));
|
|
74
|
+
export { logger, loggerErrorListen };
|