jdb/js-logging
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

timestamp -> ts; error -> err

Browse Source
This commit is contained in:
Jonathan Bernard
2025-07-14 15:37:41 -05:00
parent 318135e82b
commit 1dd7da1f5c
3 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "@jdbernard/logging", "name": "@jdbernard/logging",
"version": "2.1.0", "version": "2.2.0",
"description": "Simple Javascript logging service.", "description": "Simple Javascript logging service.",
"main": "dist/index.js", "main": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/index.d.ts",

12
src/log-message.ts
View File

@@ -27,8 +27,8 @@ export interface LogMessage {
level: LogLevel; level: LogLevel;
msg: string | Record<string, unknown>; msg: string | Record<string, unknown>;
stacktrace?: string; stacktrace?: string;
error?: Error; err?: Error;
timestamp: Date; ts: Date;
} }
export type FlattenedLogMessage = Record<string, unknown>; export type FlattenedLogMessage = Record<string, unknown>;
@@ -45,12 +45,12 @@ export type FlattenedLogMessage = Record<string, unknown>;
* *
* ```typescript * ```typescript
* const logger = logService.getLogger('example'); * const logger = logService.getLogger('example');
* logger.info({ foo: 'bar', baz: 'qux', timestamp: 'today', level: LogLevel.WARN }); * logger.info({ foo: 'bar', baz: 'qux', ts: 'today', level: LogLevel.WARN });
* ``` * ```
* *
* Should result after flattening in a structured log message like: * Should result after flattening in a structured log message like:
* ```json * ```json
* {"scope":"example","level":"INFO","foo":"bar","baz":"qux","timestamp":"2020-01-01T00:00:00.000Z"} * {"scope":"example","level":"INFO","foo":"bar","baz":"qux","ts":"2020-01-01T00:00:00.000Z"}
* ``` * ```
*/ */
export function flattenMessage(logMsg: LogMessage): FlattenedLogMessage { export function flattenMessage(logMsg: LogMessage): FlattenedLogMessage {
@@ -63,8 +63,8 @@ export function flattenMessage(logMsg: LogMessage): FlattenedLogMessage {
"scope", "scope",
"level", "level",
"stacktrace", "stacktrace",
"error", "err",
"timestamp", "ts",
]), ]),
...rest, ...rest,
level: LogLevel[logMsg.level], level: LogLevel[logMsg.level],

10
src/logger.ts
View File

@@ -67,17 +67,17 @@ export class Logger {
level, level,
msg: '', msg: '',
stacktrace: '', stacktrace: '',
timestamp: new Date(), ts: new Date(),
}; };
if (msg === undefined || msg === null) { if (msg === undefined || msg === null) {
logMsg.msg = msg; logMsg.msg = msg;
logMsg.stacktrace = stacktrace ?? ''; logMsg.stacktrace = stacktrace ?? '';
} else if (msg instanceof Error) { } else if (msg instanceof Error) {
const error = msg as Error; const err = msg as Error;
logMsg.error = error; logMsg.err = err;
logMsg.msg = `${error.name}: ${error.message}`; logMsg.msg = `${err.name}: ${err.message}`;
logMsg.stacktrace = stacktrace ?? error.stack ?? ''; logMsg.stacktrace = stacktrace ?? err.stack ?? '';
} else if (isDeferredMsg(msg)) { } else if (isDeferredMsg(msg)) {
logMsg.msg = msg(); logMsg.msg = msg();
logMsg.stacktrace = stacktrace == null ? '' : stacktrace; logMsg.stacktrace = stacktrace == null ? '' : stacktrace;