renovate/lib/logger/index.ts

// Do not static import `bunyan` here!
// Otherwise otel can't instrument it.

import { randomUUID } from 'node:crypto';
import { ProblemStream } from './problem-stream.ts';
import { RenovateLogger } from './renovate-logger.ts';
import type {
  BunyanLogLevel,
  BunyanRecord,
  BunyanStream,
  Logger,
} from './types.ts';
import { getEnv } from './utils.ts';

const problems = new ProblemStream();
let stdoutLevel: BunyanLogLevel = 'info';

export function logLevel(): BunyanLogLevel {
  return stdoutLevel;
}

const loggerInternal = new RenovateLogger(
  getEnv('LOG_CONTEXT') ?? randomUUID(),
  {},
);

export const logger: Logger = loggerInternal;

export async function init(): Promise<void> {
  // dynamic import to allow bunyan to be instrumented by otel
  const { createLogger, validateLogLevel } = await import('./bunyan.ts');
  stdoutLevel = validateLogLevel(getEnv('LOG_LEVEL'), 'info');
  const bunyanLogger = createLogger(stdoutLevel, problems);
  loggerInternal.bunyan = bunyanLogger;
}

export function setContext(value: string): void {
  loggerInternal.logContext = value;
}

export function getContext(): any {
  return loggerInternal.logContext;
}

// setMeta overrides existing meta, may remove fields if no longer existing
export function setMeta(obj: Record<string, unknown>): void {
  loggerInternal.setMeta(obj);
}

// addMeta overrides or adds fields but does not remove any
export function addMeta(obj: Record<string, unknown>): void {
  loggerInternal.addMeta(obj);
}

// removeMeta removes the provided fields from meta
export function removeMeta(fields: string[]): void {
  loggerInternal.removeMeta(fields);
}

export function withMeta<T>(obj: Record<string, unknown>, cb: () => T): T {
  addMeta(obj);
  try {
    return cb();
  } finally {
    removeMeta(Object.keys(obj));
  }
}

export function addStream(stream: BunyanStream): void {
  loggerInternal.addStream(stream);
}

/**
 * For testing purposes only
 * @param name stream name
 * @param level log level
 * @private
 */
export function levels(
  name: 'stdout' | 'logfile',
  level: BunyanLogLevel,
): void {
  loggerInternal.levels(name, level);
  // v8 ignore else -- TODO: add test #40625
  if (name === 'stdout') {
    stdoutLevel = level;
  }
}

export function getProblems(): BunyanRecord[] {
  return problems.getProblems();
}

export function clearProblems(): void {
  return problems.clearProblems();
}