hierarchical-area-logger 0.2.1 → 0.2.2
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/dist/index.cjs +22 -21
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -2
- package/dist/index.d.ts +10 -2
- package/dist/index.js +20 -20
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/Logger.ts +26 -20
- package/src/index.ts +2 -1
- package/src/types.ts +3 -1
package/dist/index.cjs
CHANGED
|
@@ -21,7 +21,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
21
21
|
var index_exports = {};
|
|
22
22
|
__export(index_exports, {
|
|
23
23
|
Logger: () => Logger,
|
|
24
|
-
createLogger: () => createLogger
|
|
24
|
+
createLogger: () => createLogger,
|
|
25
|
+
prettyError: () => prettyError
|
|
25
26
|
});
|
|
26
27
|
module.exports = __toCommonJS(index_exports);
|
|
27
28
|
|
|
@@ -84,7 +85,7 @@ var Logger = class {
|
|
|
84
85
|
constructor(options) {
|
|
85
86
|
this.parentEventId = options.parentEventId;
|
|
86
87
|
this.eventId = (0, import_cuid2.init)({ fingerprint: options.details.service })();
|
|
87
|
-
this.defaultArea = options.defaultArea || "
|
|
88
|
+
this.defaultArea = options.defaultArea || "defaultArea";
|
|
88
89
|
this.log = createRootLogEntry({
|
|
89
90
|
path: options.path || "/",
|
|
90
91
|
method: options.method,
|
|
@@ -94,6 +95,19 @@ var Logger = class {
|
|
|
94
95
|
withParentEventId: options.withParentEventId
|
|
95
96
|
});
|
|
96
97
|
}
|
|
98
|
+
finalizeRootMessage() {
|
|
99
|
+
this.addMessage("root", "info", "Request completed", {
|
|
100
|
+
totalDuration: Date.now() - this.log.root[0].timestamp
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
addMessage(name, type, message, payload) {
|
|
104
|
+
this.log[name].push({
|
|
105
|
+
type,
|
|
106
|
+
message,
|
|
107
|
+
payload: payload instanceof Error ? prettyError(payload) : payload,
|
|
108
|
+
timestamp: Date.now()
|
|
109
|
+
});
|
|
110
|
+
}
|
|
97
111
|
// Area function that returns area-specific logger methods
|
|
98
112
|
getArea(name = this.defaultArea) {
|
|
99
113
|
if (!this.log[name]) {
|
|
@@ -101,33 +115,19 @@ var Logger = class {
|
|
|
101
115
|
}
|
|
102
116
|
return {
|
|
103
117
|
info: (message, payload) => {
|
|
104
|
-
this.
|
|
105
|
-
type: "info",
|
|
106
|
-
message,
|
|
107
|
-
payload,
|
|
108
|
-
timestamp: Date.now()
|
|
109
|
-
});
|
|
118
|
+
this.addMessage(name, "info", message, payload);
|
|
110
119
|
},
|
|
111
120
|
warn: (message, payload) => {
|
|
112
|
-
this.
|
|
113
|
-
type: "warn",
|
|
114
|
-
message,
|
|
115
|
-
payload,
|
|
116
|
-
timestamp: Date.now()
|
|
117
|
-
});
|
|
121
|
+
this.addMessage(name, "warn", message, payload);
|
|
118
122
|
},
|
|
119
123
|
error: (message, payload) => {
|
|
120
|
-
this.
|
|
121
|
-
type: "error",
|
|
122
|
-
message,
|
|
123
|
-
payload: payload instanceof Error ? prettyError(payload) : payload,
|
|
124
|
-
timestamp: Date.now()
|
|
125
|
-
});
|
|
124
|
+
this.addMessage(name, "error", message, payload);
|
|
126
125
|
}
|
|
127
126
|
};
|
|
128
127
|
}
|
|
129
128
|
// Public methods on main instance
|
|
130
129
|
dump() {
|
|
130
|
+
this.finalizeRootMessage();
|
|
131
131
|
return this.log;
|
|
132
132
|
}
|
|
133
133
|
appendLogData(logData) {
|
|
@@ -141,6 +141,7 @@ var createLogger = (options) => {
|
|
|
141
141
|
// Annotate the CommonJS export names for ESM import in node:
|
|
142
142
|
0 && (module.exports = {
|
|
143
143
|
Logger,
|
|
144
|
-
createLogger
|
|
144
|
+
createLogger,
|
|
145
|
+
prettyError
|
|
145
146
|
});
|
|
146
147
|
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/Logger.ts","../src/utils.ts"],"sourcesContent":["export { Logger, createLogger } from './Logger';\nexport { LogData, LogEntry, Details, RootPayload } from './types';\n","import { init } from '@paralleldrive/cuid2';\nimport { createRootLogEntry, prettyError } from './utils';\nimport { LogData, LoggerOptions, LogEntry } from './types';\n\nexport class Logger {\n public eventId: string;\n private log: LogData;\n public parentEventId?: string;\n private defaultArea: string;\n\n constructor(options: LoggerOptions) {\n this.parentEventId = options.parentEventId;\n this.eventId = init({ fingerprint: options.details.service })();\n this.defaultArea = options.defaultArea || '
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/Logger.ts","../src/utils.ts"],"sourcesContent":["export { Logger, createLogger } from './Logger';\nexport type { LogData, LogEntry, LogEntryType, Details, RootPayload } from './types';\nexport { prettyError } from './utils';\n","import { init } from '@paralleldrive/cuid2';\nimport { createRootLogEntry, prettyError } from './utils';\nimport type { LogData, LoggerOptions, LogEntry, LogEntryType } from './types';\n\nexport class Logger {\n public eventId: string;\n private log: LogData;\n public parentEventId?: string;\n private defaultArea: string;\n\n constructor(options: LoggerOptions) {\n this.parentEventId = options.parentEventId;\n this.eventId = init({ fingerprint: options.details.service })();\n this.defaultArea = options.defaultArea || 'defaultArea';\n\n this.log = createRootLogEntry({\n path: options.path || '/',\n method: options.method,\n details: options.details,\n eventId: this.eventId,\n parentEventId: options.parentEventId,\n withParentEventId: options.withParentEventId,\n });\n }\n\n private finalizeRootMessage() {\n this.addMessage('root', 'info', 'Request completed', {\n totalDuration: Date.now() - this.log.root[0].timestamp,\n });\n }\n\n private addMessage(\n name: string,\n type: LogEntryType,\n message: string,\n payload?: LogEntry['payload'] | Error\n ) {\n this.log[name]!.push({\n type,\n message,\n payload: payload instanceof Error ? prettyError(payload) : payload,\n timestamp: Date.now(),\n });\n }\n\n // Area function that returns area-specific logger methods\n public getArea(name = this.defaultArea) {\n if (!this.log[name]) {\n this.log[name] = [];\n }\n\n return {\n info: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'info', message, payload);\n },\n warn: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'warn', message, payload);\n },\n error: (message: string, payload?: LogEntry['payload'] | Error) => {\n this.addMessage(name, 'error', message, payload);\n },\n };\n }\n\n // Public methods on main instance\n public dump(): LogData {\n this.finalizeRootMessage();\n return this.log;\n }\n\n public appendLogData(logData: LogData): void {\n delete logData.root;\n this.log = { ...logData, ...this.log };\n }\n}\n\n// Factory function for convenience\nexport const createLogger = (options: LoggerOptions): Logger => {\n return new Logger(options);\n};\n","import { CreateRootLogEntryOptions, LogData, RootPayload } from './types';\n\nexport const prettyStack = (stack?: string): string[] => {\n if (!stack) return [];\n let toReplace = '';\n\n const regex = /file:\\/\\/\\/(.*)(\\.wrangler|node_modules)\\/.*\\)/gm;\n const m = regex.exec(stack);\n\n if (m && m.length > 1) {\n toReplace = m[1];\n }\n\n return stack\n .split('\\n')\n .map((line) => line.trim())\n .filter((line) => !line.startsWith('Error: '))\n .map((line) => line.replace(toReplace, ''))\n .map((line) => line.replace('file://', ''));\n};\n\nexport const prettyError = (err: Error) => {\n const stack = prettyStack(err.stack);\n const message = err.message;\n return { message, stack };\n};\n\nexport const createRootLogEntry = ({\n path,\n method,\n details,\n eventId,\n parentEventId,\n withParentEventId,\n}: CreateRootLogEntryOptions): LogData => {\n const url = new URL(`http://example.com${path ?? '/'}`);\n\n const rootLogEntry: LogData = {\n root: [\n {\n type: 'info',\n message: 'Request received',\n payload: {\n path: `${url.pathname}${url.search}`,\n method,\n details,\n eventId,\n ...(parentEventId && { parentEventId }),\n } as RootPayload,\n timestamp: Date.now(),\n },\n ],\n };\n\n if (withParentEventId && !parentEventId) {\n rootLogEntry.root.push({\n type: 'error',\n message: 'Parent event ID expected but not found',\n timestamp: Date.now(),\n });\n }\n\n return rootLogEntry;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAqB;;;ACEd,IAAM,cAAc,CAAC,UAA6B;AACvD,MAAI,CAAC,MAAO,QAAO,CAAC;AACpB,MAAI,YAAY;AAEhB,QAAM,QAAQ;AACd,QAAM,IAAI,MAAM,KAAK,KAAK;AAE1B,MAAI,KAAK,EAAE,SAAS,GAAG;AACrB,gBAAY,EAAE,CAAC;AAAA,EACjB;AAEA,SAAO,MACJ,MAAM,IAAI,EACV,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,EACzB,OAAO,CAAC,SAAS,CAAC,KAAK,WAAW,SAAS,CAAC,EAC5C,IAAI,CAAC,SAAS,KAAK,QAAQ,WAAW,EAAE,CAAC,EACzC,IAAI,CAAC,SAAS,KAAK,QAAQ,WAAW,EAAE,CAAC;AAC9C;AAEO,IAAM,cAAc,CAAC,QAAe;AACzC,QAAM,QAAQ,YAAY,IAAI,KAAK;AACnC,QAAM,UAAU,IAAI;AACpB,SAAO,EAAE,SAAS,MAAM;AAC1B;AAEO,IAAM,qBAAqB,CAAC;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA0C;AACxC,QAAM,MAAM,IAAI,IAAI,qBAAqB,QAAQ,GAAG,EAAE;AAEtD,QAAM,eAAwB;AAAA,IAC5B,MAAM;AAAA,MACJ;AAAA,QACE,MAAM;AAAA,QACN,SAAS;AAAA,QACT,SAAS;AAAA,UACP,MAAM,GAAG,IAAI,QAAQ,GAAG,IAAI,MAAM;AAAA,UAClC;AAAA,UACA;AAAA,UACA;AAAA,UACA,GAAI,iBAAiB,EAAE,cAAc;AAAA,QACvC;AAAA,QACA,WAAW,KAAK,IAAI;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AAEA,MAAI,qBAAqB,CAAC,eAAe;AACvC,iBAAa,KAAK,KAAK;AAAA,MACrB,MAAM;AAAA,MACN,SAAS;AAAA,MACT,WAAW,KAAK,IAAI;AAAA,IACtB,CAAC;AAAA,EACH;AAEA,SAAO;AACT;;;AD3DO,IAAM,SAAN,MAAa;AAAA,EAMlB,YAAY,SAAwB;AAClC,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,cAAU,mBAAK,EAAE,aAAa,QAAQ,QAAQ,QAAQ,CAAC,EAAE;AAC9D,SAAK,cAAc,QAAQ,eAAe;AAE1C,SAAK,MAAM,mBAAmB;AAAA,MAC5B,MAAM,QAAQ,QAAQ;AAAA,MACtB,QAAQ,QAAQ;AAAA,MAChB,SAAS,QAAQ;AAAA,MACjB,SAAS,KAAK;AAAA,MACd,eAAe,QAAQ;AAAA,MACvB,mBAAmB,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,sBAAsB;AAC5B,SAAK,WAAW,QAAQ,QAAQ,qBAAqB;AAAA,MACnD,eAAe,KAAK,IAAI,IAAI,KAAK,IAAI,KAAK,CAAC,EAAE;AAAA,IAC/C,CAAC;AAAA,EACH;AAAA,EAEQ,WACN,MACA,MACA,SACA,SACA;AACA,SAAK,IAAI,IAAI,EAAG,KAAK;AAAA,MACnB;AAAA,MACA;AAAA,MACA,SAAS,mBAAmB,QAAQ,YAAY,OAAO,IAAI;AAAA,MAC3D,WAAW,KAAK,IAAI;AAAA,IACtB,CAAC;AAAA,EACH;AAAA;AAAA,EAGO,QAAQ,OAAO,KAAK,aAAa;AACtC,QAAI,CAAC,KAAK,IAAI,IAAI,GAAG;AACnB,WAAK,IAAI,IAAI,IAAI,CAAC;AAAA,IACpB;AAEA,WAAO;AAAA,MACL,MAAM,CAAC,SAAiB,YAAkC;AACxD,aAAK,WAAW,MAAM,QAAQ,SAAS,OAAO;AAAA,MAChD;AAAA,MACA,MAAM,CAAC,SAAiB,YAAkC;AACxD,aAAK,WAAW,MAAM,QAAQ,SAAS,OAAO;AAAA,MAChD;AAAA,MACA,OAAO,CAAC,SAAiB,YAA0C;AACjE,aAAK,WAAW,MAAM,SAAS,SAAS,OAAO;AAAA,MACjD;AAAA,IACF;AAAA,EACF;AAAA;AAAA,EAGO,OAAgB;AACrB,SAAK,oBAAoB;AACzB,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,cAAc,SAAwB;AAC3C,WAAO,QAAQ;AACf,SAAK,MAAM,EAAE,GAAG,SAAS,GAAG,KAAK,IAAI;AAAA,EACvC;AACF;AAGO,IAAM,eAAe,CAAC,YAAmC;AAC9D,SAAO,IAAI,OAAO,OAAO;AAC3B;","names":[]}
|
package/dist/index.d.cts
CHANGED
|
@@ -2,8 +2,9 @@ type Details = {
|
|
|
2
2
|
service: string;
|
|
3
3
|
} & Record<string, unknown>;
|
|
4
4
|
type Method = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace' | 'connect';
|
|
5
|
+
type LogEntryType = 'info' | 'warn' | 'error';
|
|
5
6
|
type LogEntry = {
|
|
6
|
-
type:
|
|
7
|
+
type: LogEntryType;
|
|
7
8
|
message: string;
|
|
8
9
|
payload?: object;
|
|
9
10
|
timestamp: number;
|
|
@@ -31,6 +32,8 @@ declare class Logger {
|
|
|
31
32
|
parentEventId?: string;
|
|
32
33
|
private defaultArea;
|
|
33
34
|
constructor(options: LoggerOptions);
|
|
35
|
+
private finalizeRootMessage;
|
|
36
|
+
private addMessage;
|
|
34
37
|
getArea(name?: string): {
|
|
35
38
|
info: (message: string, payload?: LogEntry["payload"]) => void;
|
|
36
39
|
warn: (message: string, payload?: LogEntry["payload"]) => void;
|
|
@@ -41,4 +44,9 @@ declare class Logger {
|
|
|
41
44
|
}
|
|
42
45
|
declare const createLogger: (options: LoggerOptions) => Logger;
|
|
43
46
|
|
|
44
|
-
|
|
47
|
+
declare const prettyError: (err: Error) => {
|
|
48
|
+
message: string;
|
|
49
|
+
stack: string[];
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
export { type Details, type LogData, type LogEntry, type LogEntryType, Logger, type RootPayload, createLogger, prettyError };
|
package/dist/index.d.ts
CHANGED
|
@@ -2,8 +2,9 @@ type Details = {
|
|
|
2
2
|
service: string;
|
|
3
3
|
} & Record<string, unknown>;
|
|
4
4
|
type Method = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace' | 'connect';
|
|
5
|
+
type LogEntryType = 'info' | 'warn' | 'error';
|
|
5
6
|
type LogEntry = {
|
|
6
|
-
type:
|
|
7
|
+
type: LogEntryType;
|
|
7
8
|
message: string;
|
|
8
9
|
payload?: object;
|
|
9
10
|
timestamp: number;
|
|
@@ -31,6 +32,8 @@ declare class Logger {
|
|
|
31
32
|
parentEventId?: string;
|
|
32
33
|
private defaultArea;
|
|
33
34
|
constructor(options: LoggerOptions);
|
|
35
|
+
private finalizeRootMessage;
|
|
36
|
+
private addMessage;
|
|
34
37
|
getArea(name?: string): {
|
|
35
38
|
info: (message: string, payload?: LogEntry["payload"]) => void;
|
|
36
39
|
warn: (message: string, payload?: LogEntry["payload"]) => void;
|
|
@@ -41,4 +44,9 @@ declare class Logger {
|
|
|
41
44
|
}
|
|
42
45
|
declare const createLogger: (options: LoggerOptions) => Logger;
|
|
43
46
|
|
|
44
|
-
|
|
47
|
+
declare const prettyError: (err: Error) => {
|
|
48
|
+
message: string;
|
|
49
|
+
stack: string[];
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
export { type Details, type LogData, type LogEntry, type LogEntryType, Logger, type RootPayload, createLogger, prettyError };
|
package/dist/index.js
CHANGED
|
@@ -57,7 +57,7 @@ var Logger = class {
|
|
|
57
57
|
constructor(options) {
|
|
58
58
|
this.parentEventId = options.parentEventId;
|
|
59
59
|
this.eventId = init({ fingerprint: options.details.service })();
|
|
60
|
-
this.defaultArea = options.defaultArea || "
|
|
60
|
+
this.defaultArea = options.defaultArea || "defaultArea";
|
|
61
61
|
this.log = createRootLogEntry({
|
|
62
62
|
path: options.path || "/",
|
|
63
63
|
method: options.method,
|
|
@@ -67,6 +67,19 @@ var Logger = class {
|
|
|
67
67
|
withParentEventId: options.withParentEventId
|
|
68
68
|
});
|
|
69
69
|
}
|
|
70
|
+
finalizeRootMessage() {
|
|
71
|
+
this.addMessage("root", "info", "Request completed", {
|
|
72
|
+
totalDuration: Date.now() - this.log.root[0].timestamp
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
addMessage(name, type, message, payload) {
|
|
76
|
+
this.log[name].push({
|
|
77
|
+
type,
|
|
78
|
+
message,
|
|
79
|
+
payload: payload instanceof Error ? prettyError(payload) : payload,
|
|
80
|
+
timestamp: Date.now()
|
|
81
|
+
});
|
|
82
|
+
}
|
|
70
83
|
// Area function that returns area-specific logger methods
|
|
71
84
|
getArea(name = this.defaultArea) {
|
|
72
85
|
if (!this.log[name]) {
|
|
@@ -74,33 +87,19 @@ var Logger = class {
|
|
|
74
87
|
}
|
|
75
88
|
return {
|
|
76
89
|
info: (message, payload) => {
|
|
77
|
-
this.
|
|
78
|
-
type: "info",
|
|
79
|
-
message,
|
|
80
|
-
payload,
|
|
81
|
-
timestamp: Date.now()
|
|
82
|
-
});
|
|
90
|
+
this.addMessage(name, "info", message, payload);
|
|
83
91
|
},
|
|
84
92
|
warn: (message, payload) => {
|
|
85
|
-
this.
|
|
86
|
-
type: "warn",
|
|
87
|
-
message,
|
|
88
|
-
payload,
|
|
89
|
-
timestamp: Date.now()
|
|
90
|
-
});
|
|
93
|
+
this.addMessage(name, "warn", message, payload);
|
|
91
94
|
},
|
|
92
95
|
error: (message, payload) => {
|
|
93
|
-
this.
|
|
94
|
-
type: "error",
|
|
95
|
-
message,
|
|
96
|
-
payload: payload instanceof Error ? prettyError(payload) : payload,
|
|
97
|
-
timestamp: Date.now()
|
|
98
|
-
});
|
|
96
|
+
this.addMessage(name, "error", message, payload);
|
|
99
97
|
}
|
|
100
98
|
};
|
|
101
99
|
}
|
|
102
100
|
// Public methods on main instance
|
|
103
101
|
dump() {
|
|
102
|
+
this.finalizeRootMessage();
|
|
104
103
|
return this.log;
|
|
105
104
|
}
|
|
106
105
|
appendLogData(logData) {
|
|
@@ -113,6 +112,7 @@ var createLogger = (options) => {
|
|
|
113
112
|
};
|
|
114
113
|
export {
|
|
115
114
|
Logger,
|
|
116
|
-
createLogger
|
|
115
|
+
createLogger,
|
|
116
|
+
prettyError
|
|
117
117
|
};
|
|
118
118
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/Logger.ts","../src/utils.ts"],"sourcesContent":["import { init } from '@paralleldrive/cuid2';\nimport { createRootLogEntry, prettyError } from './utils';\nimport { LogData, LoggerOptions, LogEntry } from './types';\n\nexport class Logger {\n public eventId: string;\n private log: LogData;\n public parentEventId?: string;\n private defaultArea: string;\n\n constructor(options: LoggerOptions) {\n this.parentEventId = options.parentEventId;\n this.eventId = init({ fingerprint: options.details.service })();\n this.defaultArea = options.defaultArea || '
|
|
1
|
+
{"version":3,"sources":["../src/Logger.ts","../src/utils.ts"],"sourcesContent":["import { init } from '@paralleldrive/cuid2';\nimport { createRootLogEntry, prettyError } from './utils';\nimport type { LogData, LoggerOptions, LogEntry, LogEntryType } from './types';\n\nexport class Logger {\n public eventId: string;\n private log: LogData;\n public parentEventId?: string;\n private defaultArea: string;\n\n constructor(options: LoggerOptions) {\n this.parentEventId = options.parentEventId;\n this.eventId = init({ fingerprint: options.details.service })();\n this.defaultArea = options.defaultArea || 'defaultArea';\n\n this.log = createRootLogEntry({\n path: options.path || '/',\n method: options.method,\n details: options.details,\n eventId: this.eventId,\n parentEventId: options.parentEventId,\n withParentEventId: options.withParentEventId,\n });\n }\n\n private finalizeRootMessage() {\n this.addMessage('root', 'info', 'Request completed', {\n totalDuration: Date.now() - this.log.root[0].timestamp,\n });\n }\n\n private addMessage(\n name: string,\n type: LogEntryType,\n message: string,\n payload?: LogEntry['payload'] | Error\n ) {\n this.log[name]!.push({\n type,\n message,\n payload: payload instanceof Error ? prettyError(payload) : payload,\n timestamp: Date.now(),\n });\n }\n\n // Area function that returns area-specific logger methods\n public getArea(name = this.defaultArea) {\n if (!this.log[name]) {\n this.log[name] = [];\n }\n\n return {\n info: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'info', message, payload);\n },\n warn: (message: string, payload?: LogEntry['payload']) => {\n this.addMessage(name, 'warn', message, payload);\n },\n error: (message: string, payload?: LogEntry['payload'] | Error) => {\n this.addMessage(name, 'error', message, payload);\n },\n };\n }\n\n // Public methods on main instance\n public dump(): LogData {\n this.finalizeRootMessage();\n return this.log;\n }\n\n public appendLogData(logData: LogData): void {\n delete logData.root;\n this.log = { ...logData, ...this.log };\n }\n}\n\n// Factory function for convenience\nexport const createLogger = (options: LoggerOptions): Logger => {\n return new Logger(options);\n};\n","import { CreateRootLogEntryOptions, LogData, RootPayload } from './types';\n\nexport const prettyStack = (stack?: string): string[] => {\n if (!stack) return [];\n let toReplace = '';\n\n const regex = /file:\\/\\/\\/(.*)(\\.wrangler|node_modules)\\/.*\\)/gm;\n const m = regex.exec(stack);\n\n if (m && m.length > 1) {\n toReplace = m[1];\n }\n\n return stack\n .split('\\n')\n .map((line) => line.trim())\n .filter((line) => !line.startsWith('Error: '))\n .map((line) => line.replace(toReplace, ''))\n .map((line) => line.replace('file://', ''));\n};\n\nexport const prettyError = (err: Error) => {\n const stack = prettyStack(err.stack);\n const message = err.message;\n return { message, stack };\n};\n\nexport const createRootLogEntry = ({\n path,\n method,\n details,\n eventId,\n parentEventId,\n withParentEventId,\n}: CreateRootLogEntryOptions): LogData => {\n const url = new URL(`http://example.com${path ?? '/'}`);\n\n const rootLogEntry: LogData = {\n root: [\n {\n type: 'info',\n message: 'Request received',\n payload: {\n path: `${url.pathname}${url.search}`,\n method,\n details,\n eventId,\n ...(parentEventId && { parentEventId }),\n } as RootPayload,\n timestamp: Date.now(),\n },\n ],\n };\n\n if (withParentEventId && !parentEventId) {\n rootLogEntry.root.push({\n type: 'error',\n message: 'Parent event ID expected but not found',\n timestamp: Date.now(),\n });\n }\n\n return rootLogEntry;\n};\n"],"mappings":";AAAA,SAAS,YAAY;;;ACEd,IAAM,cAAc,CAAC,UAA6B;AACvD,MAAI,CAAC,MAAO,QAAO,CAAC;AACpB,MAAI,YAAY;AAEhB,QAAM,QAAQ;AACd,QAAM,IAAI,MAAM,KAAK,KAAK;AAE1B,MAAI,KAAK,EAAE,SAAS,GAAG;AACrB,gBAAY,EAAE,CAAC;AAAA,EACjB;AAEA,SAAO,MACJ,MAAM,IAAI,EACV,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,EACzB,OAAO,CAAC,SAAS,CAAC,KAAK,WAAW,SAAS,CAAC,EAC5C,IAAI,CAAC,SAAS,KAAK,QAAQ,WAAW,EAAE,CAAC,EACzC,IAAI,CAAC,SAAS,KAAK,QAAQ,WAAW,EAAE,CAAC;AAC9C;AAEO,IAAM,cAAc,CAAC,QAAe;AACzC,QAAM,QAAQ,YAAY,IAAI,KAAK;AACnC,QAAM,UAAU,IAAI;AACpB,SAAO,EAAE,SAAS,MAAM;AAC1B;AAEO,IAAM,qBAAqB,CAAC;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA0C;AACxC,QAAM,MAAM,IAAI,IAAI,qBAAqB,QAAQ,GAAG,EAAE;AAEtD,QAAM,eAAwB;AAAA,IAC5B,MAAM;AAAA,MACJ;AAAA,QACE,MAAM;AAAA,QACN,SAAS;AAAA,QACT,SAAS;AAAA,UACP,MAAM,GAAG,IAAI,QAAQ,GAAG,IAAI,MAAM;AAAA,UAClC;AAAA,UACA;AAAA,UACA;AAAA,UACA,GAAI,iBAAiB,EAAE,cAAc;AAAA,QACvC;AAAA,QACA,WAAW,KAAK,IAAI;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AAEA,MAAI,qBAAqB,CAAC,eAAe;AACvC,iBAAa,KAAK,KAAK;AAAA,MACrB,MAAM;AAAA,MACN,SAAS;AAAA,MACT,WAAW,KAAK,IAAI;AAAA,IACtB,CAAC;AAAA,EACH;AAEA,SAAO;AACT;;;AD3DO,IAAM,SAAN,MAAa;AAAA,EAMlB,YAAY,SAAwB;AAClC,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,UAAU,KAAK,EAAE,aAAa,QAAQ,QAAQ,QAAQ,CAAC,EAAE;AAC9D,SAAK,cAAc,QAAQ,eAAe;AAE1C,SAAK,MAAM,mBAAmB;AAAA,MAC5B,MAAM,QAAQ,QAAQ;AAAA,MACtB,QAAQ,QAAQ;AAAA,MAChB,SAAS,QAAQ;AAAA,MACjB,SAAS,KAAK;AAAA,MACd,eAAe,QAAQ;AAAA,MACvB,mBAAmB,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,sBAAsB;AAC5B,SAAK,WAAW,QAAQ,QAAQ,qBAAqB;AAAA,MACnD,eAAe,KAAK,IAAI,IAAI,KAAK,IAAI,KAAK,CAAC,EAAE;AAAA,IAC/C,CAAC;AAAA,EACH;AAAA,EAEQ,WACN,MACA,MACA,SACA,SACA;AACA,SAAK,IAAI,IAAI,EAAG,KAAK;AAAA,MACnB;AAAA,MACA;AAAA,MACA,SAAS,mBAAmB,QAAQ,YAAY,OAAO,IAAI;AAAA,MAC3D,WAAW,KAAK,IAAI;AAAA,IACtB,CAAC;AAAA,EACH;AAAA;AAAA,EAGO,QAAQ,OAAO,KAAK,aAAa;AACtC,QAAI,CAAC,KAAK,IAAI,IAAI,GAAG;AACnB,WAAK,IAAI,IAAI,IAAI,CAAC;AAAA,IACpB;AAEA,WAAO;AAAA,MACL,MAAM,CAAC,SAAiB,YAAkC;AACxD,aAAK,WAAW,MAAM,QAAQ,SAAS,OAAO;AAAA,MAChD;AAAA,MACA,MAAM,CAAC,SAAiB,YAAkC;AACxD,aAAK,WAAW,MAAM,QAAQ,SAAS,OAAO;AAAA,MAChD;AAAA,MACA,OAAO,CAAC,SAAiB,YAA0C;AACjE,aAAK,WAAW,MAAM,SAAS,SAAS,OAAO;AAAA,MACjD;AAAA,IACF;AAAA,EACF;AAAA;AAAA,EAGO,OAAgB;AACrB,SAAK,oBAAoB;AACzB,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,cAAc,SAAwB;AAC3C,WAAO,QAAQ;AACf,SAAK,MAAM,EAAE,GAAG,SAAS,GAAG,KAAK,IAAI;AAAA,EACvC;AACF;AAGO,IAAM,eAAe,CAAC,YAAmC;AAC9D,SAAO,IAAI,OAAO,OAAO;AAC3B;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hierarchical-area-logger",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"repository": {
|
|
26
26
|
"type": "git",
|
|
27
|
-
"url": "https://github.com/Em3ODMe/hierarchical-area-logger.git"
|
|
27
|
+
"url": "git+https://github.com/Em3ODMe/hierarchical-area-logger.git"
|
|
28
28
|
},
|
|
29
29
|
"engines": {
|
|
30
30
|
"node": ">=18.0.0"
|
|
@@ -57,4 +57,4 @@
|
|
|
57
57
|
"typescript",
|
|
58
58
|
"nodejs"
|
|
59
59
|
]
|
|
60
|
-
}
|
|
60
|
+
}
|
package/src/Logger.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { init } from '@paralleldrive/cuid2';
|
|
2
2
|
import { createRootLogEntry, prettyError } from './utils';
|
|
3
|
-
import { LogData, LoggerOptions, LogEntry } from './types';
|
|
3
|
+
import type { LogData, LoggerOptions, LogEntry, LogEntryType } from './types';
|
|
4
4
|
|
|
5
5
|
export class Logger {
|
|
6
6
|
public eventId: string;
|
|
@@ -11,7 +11,7 @@ export class Logger {
|
|
|
11
11
|
constructor(options: LoggerOptions) {
|
|
12
12
|
this.parentEventId = options.parentEventId;
|
|
13
13
|
this.eventId = init({ fingerprint: options.details.service })();
|
|
14
|
-
this.defaultArea = options.defaultArea || '
|
|
14
|
+
this.defaultArea = options.defaultArea || 'defaultArea';
|
|
15
15
|
|
|
16
16
|
this.log = createRootLogEntry({
|
|
17
17
|
path: options.path || '/',
|
|
@@ -23,6 +23,26 @@ export class Logger {
|
|
|
23
23
|
});
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
+
private finalizeRootMessage() {
|
|
27
|
+
this.addMessage('root', 'info', 'Request completed', {
|
|
28
|
+
totalDuration: Date.now() - this.log.root[0].timestamp,
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
private addMessage(
|
|
33
|
+
name: string,
|
|
34
|
+
type: LogEntryType,
|
|
35
|
+
message: string,
|
|
36
|
+
payload?: LogEntry['payload'] | Error
|
|
37
|
+
) {
|
|
38
|
+
this.log[name]!.push({
|
|
39
|
+
type,
|
|
40
|
+
message,
|
|
41
|
+
payload: payload instanceof Error ? prettyError(payload) : payload,
|
|
42
|
+
timestamp: Date.now(),
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
|
|
26
46
|
// Area function that returns area-specific logger methods
|
|
27
47
|
public getArea(name = this.defaultArea) {
|
|
28
48
|
if (!this.log[name]) {
|
|
@@ -31,34 +51,20 @@ export class Logger {
|
|
|
31
51
|
|
|
32
52
|
return {
|
|
33
53
|
info: (message: string, payload?: LogEntry['payload']) => {
|
|
34
|
-
this.
|
|
35
|
-
type: 'info',
|
|
36
|
-
message,
|
|
37
|
-
payload,
|
|
38
|
-
timestamp: Date.now(),
|
|
39
|
-
});
|
|
54
|
+
this.addMessage(name, 'info', message, payload);
|
|
40
55
|
},
|
|
41
56
|
warn: (message: string, payload?: LogEntry['payload']) => {
|
|
42
|
-
this.
|
|
43
|
-
type: 'warn',
|
|
44
|
-
message,
|
|
45
|
-
payload,
|
|
46
|
-
timestamp: Date.now(),
|
|
47
|
-
});
|
|
57
|
+
this.addMessage(name, 'warn', message, payload);
|
|
48
58
|
},
|
|
49
59
|
error: (message: string, payload?: LogEntry['payload'] | Error) => {
|
|
50
|
-
this.
|
|
51
|
-
type: 'error',
|
|
52
|
-
message,
|
|
53
|
-
payload: payload instanceof Error ? prettyError(payload) : payload,
|
|
54
|
-
timestamp: Date.now(),
|
|
55
|
-
});
|
|
60
|
+
this.addMessage(name, 'error', message, payload);
|
|
56
61
|
},
|
|
57
62
|
};
|
|
58
63
|
}
|
|
59
64
|
|
|
60
65
|
// Public methods on main instance
|
|
61
66
|
public dump(): LogData {
|
|
67
|
+
this.finalizeRootMessage();
|
|
62
68
|
return this.log;
|
|
63
69
|
}
|
|
64
70
|
|
package/src/index.ts
CHANGED
package/src/types.ts
CHANGED
|
@@ -10,8 +10,10 @@ export type Method =
|
|
|
10
10
|
| 'trace'
|
|
11
11
|
| 'connect';
|
|
12
12
|
|
|
13
|
+
export type LogEntryType = 'info' | 'warn' | 'error';
|
|
14
|
+
|
|
13
15
|
export type LogEntry = {
|
|
14
|
-
type:
|
|
16
|
+
type: LogEntryType;
|
|
15
17
|
message: string;
|
|
16
18
|
payload?: object;
|
|
17
19
|
timestamp: number;
|