chore: Remove debug and winston in favor of pino

yarn-project/aztec.js/src/index.ts

@@ -161,7 +161,7 @@ export { decodeFromAbi, encodeArguments, type AbiType } from '@aztec/foundation/
 export { toBigIntBE } from '@aztec/foundation/bigint-buffer';
 export { sha256 } from '@aztec/foundation/crypto';
 export { makeFetch } from '@aztec/foundation/json-rpc/client';
-export { createDebugLogger, onLog, type DebugLogger } from '@aztec/foundation/log';
+export { createDebugLogger, type DebugLogger } from '@aztec/foundation/log';
 export { retry, retryUntil } from '@aztec/foundation/retry';
 export { to2Fields, toBigInt } from '@aztec/foundation/serialize';
 export { sleep } from '@aztec/foundation/sleep';

yarn-project/aztec/package.json

@@ -55,16 +55,13 @@
     "@aztec/telemetry-client": "workspace:^",
     "@aztec/txe": "workspace:^",
     "@aztec/types": "workspace:^",
-    "@opentelemetry/winston-transport": "^0.7.0",
     "@types/chalk": "^2.2.0",
     "abitype": "^0.8.11",
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
     "koa": "^2.14.2",
     "koa-router": "^12.0.0",
-    "viem": "^2.7.15",
-    "winston": "^3.10.0",
-    "winston-daily-rotate-file": "^4.7.1"
+    "viem": "^2.7.15"
   },
   "files": [
     "dest",

yarn-project/aztec/src/cli/cli.ts

@@ -9,7 +9,6 @@ import { type DebugLogger, type LogFn } from '@aztec/foundation/log';
 
 import { Command } from 'commander';
 
-import { setupConsoleJsonLog } from '../logging.js';
 import { createSandbox } from '../sandbox.js';
 import { github, splash } from '../splash.js';
 import { aztecStartOptions } from './aztec_start_options.js';
@@ -39,11 +38,6 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
   startCmd.helpInformation = printAztecStartHelpText;
 
   startCmd.action(async options => {
-    // setup json logging
-    if (['1', 'true', 'TRUE'].includes(process.env.LOG_JSON ?? '')) {
-      setupConsoleJsonLog();
-    }
-
     // list of 'stop' functions to call when process ends
     const signalHandlers: Array<() => Promise<void>> = [];
     const services: NamespacedApiHandlers = {};

yarn-project/bb-prover/src/avm_proving.test.ts

@@ -30,7 +30,7 @@ async function proveAndVerifyAvmTestContract(functionName: string, calldata: Fr[
   const bbWorkingDirectory = await fs.mkdtemp(path.join(tmpdir(), 'bb-'));
 
   // Then we prove.
-  const proofRes = await generateAvmProof(bbPath, bbWorkingDirectory, avmCircuitInputs, logger);
+  const proofRes = await generateAvmProof(bbPath, bbWorkingDirectory, avmCircuitInputs, internalLogger);
   if (proofRes.status === BB_RESULT.FAILURE) {
     internalLogger.error(`Proof generation failed: ${proofRes.reason}`);
   }

yarn-project/bb-prover/src/bb/execute.ts

@@ -1,6 +1,6 @@
 import { type AvmCircuitInputs } from '@aztec/circuits.js';
 import { sha256 } from '@aztec/foundation/crypto';
-import { type LogFn, currentLevel as currentLogLevel } from '@aztec/foundation/log';
+import { type DebugLogger, type LogFn } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import { type NoirCompiledCircuit } from '@aztec/types/noir';
 
@@ -493,7 +493,7 @@ export async function generateAvmProof(
   pathToBB: string,
   workingDirectory: string,
   input: AvmCircuitInputs,
-  log: LogFn,
+  logger: DebugLogger,
 ): Promise<BBFailure | BBSuccess> {
   // Check that the working directory exists
   try {
@@ -550,11 +550,11 @@ export async function generateAvmProof(
       avmHintsPath,
       '-o',
       outputPath,
-      currentLogLevel == 'debug' ? '-d' : currentLogLevel == 'verbose' ? '-v' : '',
+      logger.level === 'debug' || logger.level === 'trace' ? '-d' : logger.level === 'verbose' ? '-v' : '',
     ];
     const timer = new Timer();
     const logFunction = (message: string) => {
-      log(`AvmCircuit (prove) BB out - ${message}`);
+      logger.verbose(`AvmCircuit (prove) BB out - ${message}`);
     };
     const result = await executeBB(pathToBB, 'avm_prove', args, logFunction);
     const duration = timer.ms();

yarn-project/bb-prover/src/prover/bb_prover.ts

@@ -535,7 +535,7 @@ export class BBNativeRollupProver implements ServerCircuitProver {
   private async generateAvmProofWithBB(input: AvmCircuitInputs, workingDirectory: string): Promise<BBSuccess> {
     logger.info(`Proving avm-circuit for ${input.functionName}...`);
 
-    const provingResult = await generateAvmProof(this.config.bbBinaryPath, workingDirectory, input, logger.verbose);
+    const provingResult = await generateAvmProof(this.config.bbBinaryPath, workingDirectory, input, logger);
 
     if (provingResult.status === BB_RESULT.FAILURE) {
       logger.error(`Failed to generate AVM proof for ${input.functionName}: ${provingResult.reason}`);

yarn-project/end-to-end/package.json

@@ -93,7 +93,6 @@
     "viem": "^2.7.15",
     "webpack": "^5.88.2",
     "webpack-cli": "^5.1.4",
-    "winston": "^3.10.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {

yarn-project/end-to-end/src/fixtures/logging.ts

@@ -1,10 +1,5 @@
-import { onLog } from '@aztec/aztec.js';
-
 import { mkdirpSync } from 'fs-extra';
 import { dirname } from 'path';
-import * as winston from 'winston';
-
-const { format, transports } = winston;
 
 let metricsLoggerSet = false;
 
@@ -22,15 +17,6 @@ export function setupMetricsLogger(filename: string) {
     return;
   }
   mkdirpSync(dirname(filename));
-  const logger = winston.createLogger({
-    level: 'debug',
-    format: format.combine(format.timestamp(), format.json()),
-    transports: [new transports.File({ filename })],
-  });
-  onLog((level, namespace, message, data) => {
-    if (data && data['eventName']) {
-      logger.log({ ...data, level, namespace, message });
-    }
-  });
+  // TODO(palla/log): Reenable or kill metrics logger
   metricsLoggerSet = true;
 }

yarn-project/foundation/package.json

@@ -101,7 +101,9 @@
     "@aztec/bb.js": "portal:../../barretenberg/ts",
     "@koa/cors": "^5.0.0",
     "@noble/curves": "^1.2.0",
+    "@opentelemetry/instrumentation-pino": "^0.44.0",
     "bn.js": "^5.2.1",
+    "colorette": "^2.0.20",
     "debug": "^4.3.4",
     "detect-node": "^2.1.0",
     "elliptic": "^6.5.4",
@@ -116,6 +118,8 @@
     "lodash.clonedeepwith": "^4.5.0",
     "memdown": "^6.1.1",
     "pako": "^2.1.0",
+    "pino": "^9.5.0",
+    "pino-pretty": "^13.0.0",
     "sha3": "^2.1.4",
     "zod": "^3.23.8"
   },

yarn-project/foundation/src/crypto/random/randomness_singleton.ts

@@ -1,4 +1,4 @@
-import { createDebugLogger } from '../../log/logger.js';
+import { createDebugLogger } from '../../log/pino-logger.js';
 
 /**
  * A number generator which is used as a source of randomness in the system. If the SEED env variable is set, the

yarn-project/foundation/src/json-rpc/client/safe_json_rpc_client.ts

@@ -1,6 +1,6 @@
 import { format } from 'util';
 
-import { createDebugLogger } from '../../log/logger.js';
+import { createDebugLogger } from '../../log/pino-logger.js';
 import { type ApiSchema, type ApiSchemaFor, schemaHasMethod } from '../../schemas/api.js';
 import { defaultFetch } from './fetch.js';
 

yarn-project/foundation/src/log/index.ts

@@ -1,5 +1,5 @@
 export * from './console.js';
 export * from './debug.js';
-export * from './logger.js';
+export * from './pino-logger.js';
 export * from './log_history.js';
 export * from './log_fn.js';

yarn-project/foundation/src/log/log-filters.test.ts

@@ -0,0 +1,50 @@
+import { parseEnv } from './log-filters.js';
+
+describe('parseEnv', () => {
+  const defaultLevel = 'info';
+
+  it('returns default level and empty filters when env is empty', () => {
+    const env = '';
+    const [level, filters] = parseEnv(env, defaultLevel);
+    expect(level).toBe(defaultLevel);
+    expect(filters).toEqual([]);
+  });
+
+  it('parses level and filters from env string', () => {
+    const env = 'debug;warn:module1,module2;error:module3';
+    const [level, filters] = parseEnv(env, defaultLevel);
+    expect(level).toBe('debug');
+    expect(filters).toEqual([
+      ['module3', 'error'],
+      ['module2', 'warn'],
+      ['module1', 'warn'],
+    ]);
+  });
+
+  it('handles spaces in env string', () => {
+    const env = 'debug; warn: module1, module2; error: module3';
+    const [level, filters] = parseEnv(env, defaultLevel);
+    expect(level).toBe('debug');
+    expect(filters).toEqual([
+      ['module3', 'error'],
+      ['module2', 'warn'],
+      ['module1', 'warn'],
+    ]);
+  });
+
+  it('throws an error for invalid default log level', () => {
+    const env = 'invalid;module1:warn';
+    expect(() => parseEnv(env, defaultLevel)).toThrow('Invalid log level: invalid');
+  });
+
+  it('throws an error for invalid log level in filter', () => {
+    const env = 'invalid;warn:module';
+    expect(() => parseEnv(env, defaultLevel)).toThrow('Invalid log level: invalid');
+  });
+
+  it('throws an error for invalid log filter statement', () => {
+    const defaultLevel = 'info';
+    const env = 'debug;warn:module1;error:';
+    expect(() => parseEnv(env, defaultLevel)).toThrow('Invalid log filter statement: error');
+  });
+});

yarn-project/foundation/src/log/log-filters.ts

@@ -0,0 +1,49 @@
+import { type LogLevel, LogLevels } from './log-levels.js';
+
+export type LogFilters = [string, LogLevel][];
+
+export function getLogLevelFromFilters(filters: LogFilters, module: string): LogLevel | undefined {
+  for (const [filterModule, level] of filters) {
+    if (module.startsWith(filterModule)) {
+      return level as LogLevel;
+    }
+  }
+  return undefined;
+}
+
+export function assertLogLevel(level: string): asserts level is LogLevel {
+  if (!LogLevels.includes(level as LogLevel)) {
+    throw new Error(`Invalid log level: ${level}`);
+  }
+}
+
+export function parseEnv(env: string | undefined, defaultLevel: LogLevel): [LogLevel, LogFilters] {
+  if (!env) {
+    return [defaultLevel, []];
+  }
+  const [level] = env.split(';', 1);
+  assertLogLevel(level);
+  return [level, parseFilters(env.slice(level.length + 1))];
+}
+
+export function parseFilters(definition: string | undefined): LogFilters {
+  if (!definition) {
+    return [];
+  }
+
+  const statements = definition.split(';');
+  const filters: LogFilters = [];
+  for (const statement of statements) {
+    const [level] = statement.split(':', 1);
+    const modules = statement.slice(level.length + 1);
+    if (!modules || !level) {
+      throw new Error(`Invalid log filter statement: ${statement}`);
+    }
+    const sanitizedLevel = level.trim().toLowerCase();
+    assertLogLevel(sanitizedLevel);
+    for (const module of modules.split(',')) {
+      filters.push([module.trim().toLowerCase(), sanitizedLevel as LogLevel | 'silent']);
+    }
+  }
+  return filters.reverse();
+}

yarn-project/foundation/src/log/log-levels.ts

@@ -0,0 +1,3 @@
+export const LogLevels = ['silent', 'fatal', 'error', 'warn', 'info', 'verbose', 'debug', 'trace'] as const;
+
+export type LogLevel = (typeof LogLevels)[number];