@altinn/dialogporten-node-logger 1.89.0

package/README.md

@@ -0,0 +1,55 @@
+# node-logger
+
+Logger for nodejs that uses [pino](https://github.com/pinojs/pino)
+as the logger tool. Allows for both a prettified log and a more
+machine readable log depending on environment.
+
+## Usage
+
+```typescript
+import { logger } from '@digdir/dialogporten-node-logger'
+
+logger.info('Hello world')
+logger.info({such: 'context'}, 'Hello world with additional context')
+logger.error(new Error('Some error'), 'Oops')
+
+```
+
+You can also create a "context logger", this will add a context object
+to all log calls to that logger.
+
+```typescript
+import { logger, createContextLogger } from '@digdir/dialgporten-node-logger'
+
+logger.info('Hello world')
+// logs: { <standard fields>, mgs: 'Hello world' }
+logger.info({such: 'context'}, 'Hello world with additional context')
+// logs: { <standard fields>, such: 'context', mgs: 'Hello world' }
+
+const ctxLogger = createContextLogger({ foo: 'bar' })
+
+ctxLogger.info('Hello world')
+// logs: { <standard fields>, foo: 'bar', mgs: 'Hello world' }
+ctxLogger.info({such: 'context'}, 'Hello world with additional context')
+// logs: { <standard fields>, foo: 'bar', such: 'context', mgs: 'Hello world' }
+```
+
+You can also import the `pino` logger instance itself.
+
+```typescript
+import { logger } from '@digdir/dialgporten-node-logger'
+
+logger.pinoLogger.info('Hello world')
+// logs: { <standard fields>, mgs: 'Hello world' }
+
+### Configuration
+
+Log level and format are configured through environment variables:
+
+* `LOG_LEVEL` - Determines the log level. Allowed values:
+  `trace, debug, info, warn, error, fatal, silent`
+* `TEST_LOGGING` - Verifies the log level set by logging
+  a message with every available log level. Allowed values: `true`
+* `LOGGER_FORMAT` - If set to `json`, the logs will be output in
+  json format for easier consumption by log services. otherwise,
+  the logs are prettified

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import pino from 'pino';
+export declare const createContextLogger: (context: Record<string | number | symbol, unknown>) => {
+    trace: pino.LogFn;
+    debug: pino.LogFn;
+    info: pino.LogFn;
+    warn: pino.LogFn;
+    error: pino.LogFn;
+    fatal: pino.LogFn;
+    silent: pino.LogFn;
+};
+export declare const logger: {
+    trace: pino.LogFn;
+    debug: pino.LogFn;
+    info: pino.LogFn;
+    warn: pino.LogFn;
+    error: pino.LogFn;
+    fatal: pino.LogFn;
+    silent: pino.LogFn;
+    pinoLoggerInstance: import("pino").Logger<never>;
+};

package/dist/index.js

@@ -0,0 +1,76 @@
+import pino from 'pino';
+import z from 'zod';
+const envVariables = z.object({
+    LOGGER_FORMAT: z.enum(['json', 'pretty']).default('pretty'),
+    LOG_LEVEL: z.nativeEnum(pino.levels.labels).default('info'),
+    TEST_LOGGING: z
+        .enum(['true', 'false'])
+        .transform((val) => val === 'true')
+        .default('false'),
+    OTEL_EXPORTER_OTLP_ENDPOINT: z.string().optional(),
+});
+const env = envVariables.parse(process.env);
+console.info(`node-logger: Log level set to ${env.LOG_LEVEL}`);
+const openTelemetryTransport = {
+    target: 'pino-opentelemetry-transport',
+};
+const pinoPrettyTransport = {
+    target: 'pino-pretty',
+    options: {
+        destination: 1,
+        colorize: true,
+        levelFirst: true,
+    },
+};
+const jsonTransport = {
+    target: 'pino/file',
+    options: {
+        destination: 1,
+    },
+};
+const consoleTransport = env.LOGGER_FORMAT === 'json' ? jsonTransport : pinoPrettyTransport;
+// biome-ignore lint/suspicious/noExplicitAny: poor typings from pino
+let transports;
+// Configure transports based on OTEL endpoint availability
+if (env.OTEL_EXPORTER_OTLP_ENDPOINT) {
+    console.info('node-logger: Using console and OpenTelemetry transports');
+    transports = pino.transport({
+        targets: [openTelemetryTransport, consoleTransport],
+    });
+}
+else {
+    console.info('node-logger: Using console transport only');
+    transports = pino.transport(consoleTransport);
+}
+const pinoLogger = pino({ level: env.LOG_LEVEL }, transports);
+export const createContextLogger = (context) => {
+    const child = pinoLogger.child(context);
+    return {
+        trace: child.trace.bind(child),
+        debug: child.debug.bind(child),
+        info: child.info.bind(child),
+        warn: child.warn.bind(child),
+        error: child.error.bind(child),
+        fatal: child.fatal.bind(child),
+        silent: child.silent.bind(child),
+    };
+};
+if (env.TEST_LOGGING) {
+    pinoLogger.debug('Debug test');
+    pinoLogger.trace('Trace test');
+    pinoLogger.info({ some: 'object' }, 'Info test');
+    pinoLogger.warn('Consider this a warning');
+    pinoLogger.error(new Error('Test error'), 'Error test');
+    pinoLogger.fatal(new Error('Test error'), 'Fatal test');
+}
+export const logger = {
+    trace: pinoLogger.trace.bind(pinoLogger),
+    debug: pinoLogger.debug.bind(pinoLogger),
+    info: pinoLogger.info.bind(pinoLogger),
+    warn: pinoLogger.warn.bind(pinoLogger),
+    error: pinoLogger.error.bind(pinoLogger),
+    fatal: pinoLogger.fatal.bind(pinoLogger),
+    silent: pinoLogger.silent.bind(pinoLogger),
+    pinoLoggerInstance: pinoLogger,
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,CAAC,MAAM,KAAK,CAAC;AAEpB,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC3D,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IAC3D,YAAY,EAAE,CAAC;SACZ,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACvB,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC;SAClC,OAAO,CAAC,OAAO,CAAC;IACnB,2BAA2B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnD,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAE5C,OAAO,CAAC,IAAI,CAAC,iCAAiC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;AAE/D,MAAM,sBAAsB,GAAG;IAC7B,MAAM,EAAE,8BAA8B;CACvC,CAAC;AAEF,MAAM,mBAAmB,GAAG;IAC1B,MAAM,EAAE,aAAa;IACrB,OAAO,EAAE;QACP,WAAW,EAAE,CAAC;QACd,QAAQ,EAAE,IAAI;QACd,UAAU,EAAE,IAAI;KACjB;CACF,CAAC;AAEF,MAAM,aAAa,GAAG;IACpB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE;QACP,WAAW,EAAE,CAAC;KACf;CACF,CAAC;AAEF,MAAM,gBAAgB,GAAG,GAAG,CAAC,aAAa,KAAK,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,mBAAmB,CAAC;AAE5F,qEAAqE;AACrE,IAAI,UAAe,CAAC;AAEpB,2DAA2D;AAC3D,IAAI,GAAG,CAAC,2BAA2B,EAAE,CAAC;IACpC,OAAO,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;IACxE,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1B,OAAO,EAAE,CAAC,sBAAsB,EAAE,gBAAgB,CAAC;KACpD,CAAC,CAAC;AACL,CAAC;KAAM,CAAC;IACN,OAAO,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;IAC1D,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAkD,EAAE,EAAE;IACxF,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAExC,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;IACrB,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC/B,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC/B,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC;IACjD,UAAU,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAC3C,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC;IACxD,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;IACxC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;IACxC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IACtC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IACtC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;IACxC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;IACxC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;IAC1C,kBAAkB,EAAE,UAAU;CAC/B,CAAC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@altinn/dialogporten-node-logger",
+  "version": "1.89.0",
+  "description": "A logger for nodejs",
+  "main": "dist/index.js",
+  "scripts": {
+    "prepare": "tsc",
+    "build": "tsc",
+    "test": "npm run build && TEST_LOGGING=true node dist/index.js"
+  },
+  "keywords": [
+    "logging"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "pino": "9.3.2",
+    "pino-opentelemetry-transport": "1.1.0",
+    "pino-pretty": "11.2.2"
+  },
+  "devDependencies": {
+    "@types/node": "22.5.1",
+    "typescript": "5.5.4",
+    "zod": "3.23.8"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Altinn/dialogporten-frontend.git"
+  },
+  "type": "module"
+}

package/src/index.ts

@@ -0,0 +1,88 @@
+import pino from 'pino';
+import z from 'zod';
+
+const envVariables = z.object({
+  LOGGER_FORMAT: z.enum(['json', 'pretty']).default('pretty'),
+  LOG_LEVEL: z.nativeEnum(pino.levels.labels).default('info'),
+  TEST_LOGGING: z
+    .enum(['true', 'false'])
+    .transform((val) => val === 'true')
+    .default('false'),
+  OTEL_EXPORTER_OTLP_ENDPOINT: z.string().optional(),
+});
+
+const env = envVariables.parse(process.env);
+
+console.info(`node-logger: Log level set to ${env.LOG_LEVEL}`);
+
+const openTelemetryTransport = {
+  target: 'pino-opentelemetry-transport',
+};
+
+const pinoPrettyTransport = {
+  target: 'pino-pretty',
+  options: {
+    destination: 1,
+    colorize: true,
+    levelFirst: true,
+  },
+};
+
+const jsonTransport = {
+  target: 'pino/file',
+  options: {
+    destination: 1,
+  },
+};
+
+const consoleTransport = env.LOGGER_FORMAT === 'json' ? jsonTransport : pinoPrettyTransport;
+
+// biome-ignore lint/suspicious/noExplicitAny: poor typings from pino
+let transports: any;
+
+// Configure transports based on OTEL endpoint availability
+if (env.OTEL_EXPORTER_OTLP_ENDPOINT) {
+  console.info('node-logger: Using console and OpenTelemetry transports');
+  transports = pino.transport({
+    targets: [openTelemetryTransport, consoleTransport],
+  });
+} else {
+  console.info('node-logger: Using console transport only');
+  transports = pino.transport(consoleTransport);
+}
+
+const pinoLogger = pino({ level: env.LOG_LEVEL }, transports);
+
+export const createContextLogger = (context: Record<string | number | symbol, unknown>) => {
+  const child = pinoLogger.child(context);
+
+  return {
+    trace: child.trace.bind(child),
+    debug: child.debug.bind(child),
+    info: child.info.bind(child),
+    warn: child.warn.bind(child),
+    error: child.error.bind(child),
+    fatal: child.fatal.bind(child),
+    silent: child.silent.bind(child),
+  };
+};
+
+if (env.TEST_LOGGING) {
+  pinoLogger.debug('Debug test');
+  pinoLogger.trace('Trace test');
+  pinoLogger.info({ some: 'object' }, 'Info test');
+  pinoLogger.warn('Consider this a warning');
+  pinoLogger.error(new Error('Test error'), 'Error test');
+  pinoLogger.fatal(new Error('Test error'), 'Fatal test');
+}
+
+export const logger = {
+  trace: pinoLogger.trace.bind(pinoLogger),
+  debug: pinoLogger.debug.bind(pinoLogger),
+  info: pinoLogger.info.bind(pinoLogger),
+  warn: pinoLogger.warn.bind(pinoLogger),
+  error: pinoLogger.error.bind(pinoLogger),
+  fatal: pinoLogger.fatal.bind(pinoLogger),
+  silent: pinoLogger.silent.bind(pinoLogger),
+  pinoLoggerInstance: pinoLogger,
+};