chore: Cleanup sequencer logs

README.md

@@ -47,7 +47,7 @@ This provide an interactive environment for debugging the CI test.
 
 ## Debugging
 
-Logging goes through the [DebugLogger](yarn-project/foundation/src/log/debug.ts) module in Typescript. To see the log output, set a `DEBUG` environment variable to the name of the module you want to debug, to `aztec:*`, or to `*` to see all logs.
+Logging goes through the [DebugLogger](yarn-project/foundation/src/log/debug.ts) module in Typescript. `LOG_LEVEL` controls the default log level, and one can set alternate levels for specific modules, such as `debug; warn: module1, module2; error: module3`.
 
 ## Releases
 

aztec-up/bin/.aztec-run

@@ -104,8 +104,8 @@ while [[ "$#" -gt 0 ]]; do
 done
 
 DOCKER_ENV="-e HOME=$HOME"
-if ! [ -z "${DEBUG:-}" ] ; then
-  DOCKER_ENV="-e DEBUG=$DEBUG"
+if ! [ -z "${LOG_LEVEL:-}" ] ; then
+  DOCKER_ENV="-e LOG_LEVEL=$LOG_LEVEL"
 fi
 for env in ${ENV_VARS_TO_INJECT:-}; do
   # SSH_AUTH_SOCK must be handled separately

aztec-up/bin/docker-compose.sandbox.yml

@@ -20,7 +20,7 @@ services:
     ports:
       - "${PXE_PORT:-8080}:${PXE_PORT:-8080}"
     environment:
-      DEBUG: # Loaded from the user shell if explicitly set
+      LOG_LEVEL: # Loaded from the user shell if explicitly set
       HOST_WORKDIR: "${PWD}" # Loaded from the user shell to show log files absolute path in host
       ETHEREUM_HOST: ${ETHEREUM_HOST:-http://ethereum}:${ANVIL_PORT:-8545}
       L1_CHAIN_ID: 31337

aztec-up/bin/docker-compose.test.yml

@@ -2,7 +2,6 @@ services:
   txe:
     image: "aztecprotocol/aztec"
     environment:
-      DEBUG: # Loaded from the user shell if explicitly set
       LOG_LEVEL: # Loaded from the user shell if explicitly set
       HOST_WORKDIR: "${PWD}" # Loaded from the user shell to show log files absolute path in host
     volumes:

docker-compose.yml

@@ -6,8 +6,6 @@ services:
     platform: linux/amd64
     environment:
       LOG_LEVEL: ${LOG_LEVEL:-info}
-      DEBUG: ${DEBUG:-aztec:*,-json-rpc:*,-aztec:circuits:artifact_hash,-aztec:randomness_singleton}
-      DEBUG_COLORS: 1
       L1_CHAIN_ID: 31337
       VERSION: 1
       PXE_PROVER_ENABLED: ${PXE_PROVER_ENABLED:-1}
@@ -38,8 +36,6 @@ services:
     platform: linux/amd64
     environment:
       LOG_LEVEL: ${LOG_LEVEL:-info}
-      DEBUG: ${DEBUG:-aztec:*,-json-rpc:*,-aztec:circuits:artifact_hash,-aztec:randomness_singleton,-aztec:avm_simulator:*}
-      DEBUG_COLORS: 1
       L1_CHAIN_ID: 31337
       VERSION: 1
       NODE_NO_WARNINGS: 1

docs/docs/migration_notes.md

@@ -6,6 +6,35 @@ keywords: [sandbox, aztec, notes, migration, updating, upgrading]
 
 Aztec is in full-speed development. Literally every version breaks compatibility with the previous ones. This page attempts to target errors and difficulties you might encounter when upgrading, and how to resolve them.
 
+## 0.66
+
+### DEBUG env var is removed
+
+The `DEBUG` variable is no longer used. Use `LOG_LEVEL` with one of `silent`, `fatal`, `error`, `warn`, `info`, `verbose`, `debug`, or `trace`. To tweak log levels per module, add a list of module prefixes with their overridden level. For example, LOG_LEVEL="info; verbose: aztec:sequencer, aztec:archiver; debug: aztec:kv-store" sets `info` as the default log level, `verbose` for the sequencer and archiver, and `debug` for the kv-store. Module name match is done by prefix.
+
+### `tty` resolve fallback required for browser bundling
+
+When bundling `aztec.js` for web, the `tty` package now needs to be specified as an empty fallback:
+
+```diff
+resolve: {
+  plugins: [new ResolveTypeScriptPlugin()],
+  alias: { './node/index.js': false },
+  fallback: {
+    crypto: false,
+    os: false,
+    fs: false,
+    path: false,
+    url: false,
++   tty: false,
+    worker_threads: false,
+    buffer: require.resolve('buffer/'),
+    util: require.resolve('util/'),
+    stream: require.resolve('stream-browserify'),
+  },
+},
+```
+
 ## 0.65
 
 ### [aztec.nr] Removed SharedImmutable

docs/docs/reference/developer_references/debugging.md

@@ -53,7 +53,7 @@ debug_log_array(my_array);
 
 ### Start Sandbox in debug mode
 
-Update the `DEBUG` environment variable in docker-compose.sandbox.yml to the following:
+Set `LOG_LEVEL` to `verbose` or `debug`:
 
 ```yml
 # ~/.aztec/docker-compose.sandbox.yml
@@ -65,8 +65,7 @@ aztec:
   ports:
     - "${PXE_PORT:-8080}:${PXE_PORT:-8080}"
   environment:
-    DEBUG: aztec:simulator:client_execution_context, aztec:sandbox, aztec:avm_simulator:debug_log
-    LOG_LEVEL: verbose # optionally add this for more logs
+    LOG_LEVEL: verbose
   # ...
 ```
 

spartan/aztec-network/templates/deploy-l1-verifier.yaml

@@ -62,8 +62,6 @@ spec:
           env:
             - name: NODE_NO_WARNINGS
               value: "1"
-            - name: DEBUG
-              value: "aztec:*"
             - name: LOG_LEVEL
               value: "debug"
             - name: L1_CHAIN_ID

spartan/aztec-network/templates/prover-agent.yaml

@@ -85,8 +85,6 @@ spec:
               value: "{{ .Values.proverAgent.logLevel }}"
             - name: LOG_JSON
               value: "1"
-            - name: DEBUG
-              value: "{{ .Values.proverAgent.debug }}"
             - name: PROVER_REAL_PROOFS
               value: "{{ .Values.aztec.realProofs }}"
             - name: PROVER_AGENT_COUNT

spartan/aztec-network/templates/prover-broker.yaml

@@ -66,8 +66,6 @@ spec:
               value: "{{ .Values.proverBroker.logLevel }}"
             - name: LOG_JSON
               value: "1"
-            - name: DEBUG
-              value: "{{ .Values.proverBroker.debug }}"
             - name: PROVER_BROKER_POLL_INTERVAL_MS
               value: "{{ .Values.proverBroker.pollIntervalMs }}"
             - name: PROVER_BROKER_JOB_TIMEOUT_MS

spartan/aztec-network/templates/pxe.yaml

@@ -84,8 +84,6 @@ spec:
               value: "1"
             - name: LOG_LEVEL
               value: "{{ .Values.pxe.logLevel }}"
-            - name: DEBUG
-              value: "{{ .Values.pxe.debug }}"
             - name: PXE_PROVER_ENABLED
               value: "{{ .Values.aztec.realProofs }}"
           ports:

spartan/aztec-network/templates/setup-l2-contracts.yaml

@@ -61,8 +61,6 @@ spec:
               node --no-warnings /usr/src/yarn-project/aztec/dest/bin/index.js setup-protocol-contracts --skipProofWait --l1-chain-id {{ .Values.ethereum.chainId }}
               echo "L2 contracts initialized"
           env:
-            - name: DEBUG
-              value: "aztec:*"
             - name: LOG_LEVEL
               value: "debug"
             - name: NETWORK_PUBLIC

spartan/aztec-network/templates/transaction-bot.yaml

@@ -79,8 +79,6 @@ spec:
               value: "1"
             - name: LOG_LEVEL
               value: "{{ .Values.bot.logLevel }}"
-            - name: DEBUG
-              value: "{{ .Values.bot.debug }}"
             - name: BOT_PRIVATE_KEY
               value: "{{ .Values.bot.botPrivateKey }}"
             - name: BOT_TX_INTERVAL_SECONDS

spartan/aztec-network/values.yaml

@@ -44,7 +44,7 @@ bootNode:
     p2pUdpPort: 40400
     nodePort: 8080
   logLevel: "debug"
-  debug: "aztec:*,-aztec:avm_simulator*,-aztec:libp2p_service*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*"
+  debug: ""
   coinbaseAddress: "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
   sequencer:
     maxSecondsBetweenBlocks: 0
@@ -87,7 +87,7 @@ validator:
     p2pUdpPort: 40400
     nodePort: 8080
   logLevel: "debug"
-  debug: "aztec:*,-aztec:avm_simulator*,-aztec:libp2p_service*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*"
+  debug: ""
   sequencer:
     maxSecondsBetweenBlocks: 0
     minTxsPerBlock: 1
@@ -117,7 +117,7 @@ proverNode:
     p2pUdpPort: 40400
     nodePort: 8080
   logLevel: "debug"
-  debug: "aztec:*,-aztec:avm_simulator*,-aztec:libp2p_service*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*"
+  debug: ""
   proverAgent:
     count: 0
     pollIntervalMs: 1000
@@ -136,7 +136,6 @@ proverNode:
 
 pxe:
   logLevel: "debug"
-  debug: "aztec:*,-aztec:avm_simulator*,-aztec:libp2p_service*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*"
   replicas: 1
   service:
     nodePort: 8081
@@ -155,7 +154,6 @@ bot:
   enabled: true
   nodeUrl: ""
   logLevel: "debug"
-  debug: "aztec:*,-aztec:avm_simulator*,-aztec:libp2p_service*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:l2_block_stream,-aztec:world-state:database"
   replicas: 1
   botPrivateKey: "0xcafe"
   txIntervalSeconds: 24
@@ -216,7 +214,6 @@ proverAgent:
   gke:
     spotEnabled: false
   logLevel: "debug"
-  debug: "aztec:*,-aztec:avm_simulator*,-aztec:libp2p_service*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*"
   bb:
     hardwareConcurrency: ""
   nodeSelector: {}
@@ -232,7 +229,6 @@ proverBroker:
   jobMaxRetries: 3
   dataDirectory: ""
   logLevel: "debug"
-  debug: "aztec:*,-aztec:avm_simulator*,-aztec:libp2p_service*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*"
   nodeSelector: {}
   resources: {}
 

spartan/aztec-network/values/prover-node-with-agents.yaml

@@ -12,7 +12,7 @@ validator:
   external: true
 
 bootNode:
-  debug: "aztec:*,-aztec:avm_simulator:*,-aztec:world-state:database,discv5:*,-JsonProxy:*"
+  debug: "discv5:*"
   validator:
     disabled: true
 

spartan/releases/rough-rhino/aztec-spartan.sh

@@ -178,7 +178,6 @@ services:
             - VALIDATOR_PRIVATE_KEY=${KEY}
             - SEQ_PUBLISHER_PRIVATE_KEY=${KEY}
             - L1_PRIVATE_KEY=${KEY}
-            - DEBUG=aztec:*,-aztec:avm_simulator*,-aztec:circuits:artifact_hash,-aztec:libp2p_service,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*
             - LOG_LEVEL=debug
             - AZTEC_PORT=${PORT}
             - P2P_ENABLED=true

spartan/testnet-runbook.md

@@ -45,7 +45,6 @@ Verbose logging on Aztec nodes should be enabled by default using the following
 
 - `LOG_JSON=1`
 - `LOG_LEVEL=debug`
-- `DEBUG=discv5*,aztec:*,-aztec:avm_simulator*,-aztec:circuits:artifact_hash,-json-rpc*,-aztec:world-state:database,-aztec:l2_block_stream*`
 
 Deployments are initiated from CI by manually running the (_name pending_) workflow.
 

yarn-project/Earthfile

@@ -302,15 +302,16 @@ test:
 
 run-e2e:
     ARG test
+    ARG log_level=""
     ARG debug=""
     FROM +end-to-end
-    RUN DEBUG=$debug yarn test $test
+    RUN DEBUG=$debug LOG_LEVEL=$log_level yarn test $test
 
 prover-client-test:
     FROM +build
     ARG test
-    ARG debug=""
-    RUN cd prover-client && DEBUG=$debug yarn test $test
+    ARG log_level=""
+    RUN cd prover-client && LOG_LEVEL=$log_level yarn test $test
 
 # NOTE: This is not in the end-to-end Earthfile as that is entirely LOCALLY commands that will go away sometime.
 # Running this inside the main builder as the point is not to run this through dockerization.

yarn-project/archiver/src/archiver/archiver.ts

@@ -35,7 +35,7 @@ import { type ContractArtifact } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { type EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
-import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
+import { type Logger, createLogger } from '@aztec/foundation/log';
 import { RunningPromise } from '@aztec/foundation/running-promise';
 import { count } from '@aztec/foundation/string';
 import { Timer } from '@aztec/foundation/timer';
@@ -119,7 +119,7 @@ export class Archiver implements ArchiveSource {
     private readonly pollingIntervalMs: number,
     private readonly instrumentation: ArchiverInstrumentation,
     private readonly l1constants: L1RollupConstants = EmptyL1RollupConstants,
-    private readonly log: DebugLogger = createDebugLogger('aztec:archiver'),
+    private readonly log: Logger = createLogger('archiver'),
   ) {
     this.store = new ArchiverStoreHelper(dataStore);
 
@@ -805,7 +805,7 @@ class ArchiverStoreHelper
       | 'addFunctions'
     >
 {
-  #log = createDebugLogger('aztec:archiver:block-helper');
+  #log = createLogger('archiver:block-helper');
 
   constructor(private readonly store: ArchiverDataStore) {}
 

yarn-project/archiver/src/archiver/data_retrieval.ts

@@ -2,7 +2,7 @@ import { Body, InboxLeaf, L2Block } from '@aztec/circuit-types';
 import { AppendOnlyTreeSnapshot, Fr, Header, Proof } from '@aztec/circuits.js';
 import { type EthAddress } from '@aztec/foundation/eth-address';
 import { type ViemSignature } from '@aztec/foundation/eth-signature';
-import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
+import { type Logger, createLogger } from '@aztec/foundation/log';
 import { numToUInt32BE } from '@aztec/foundation/serialize';
 import { type InboxAbi, RollupAbi } from '@aztec/l1-artifacts';
 
@@ -37,7 +37,7 @@ export async function retrieveBlockFromRollup(
   blockUntilSynced: boolean,
   searchStartBlock: bigint,
   searchEndBlock: bigint,
-  logger: DebugLogger = createDebugLogger('aztec:archiver'),
+  logger: Logger = createLogger('archiver'),
 ): Promise<L1Published<L2Block>[]> {
   const retrievedBlocks: L1Published<L2Block>[] = [];
   do {
@@ -79,7 +79,7 @@ export async function processL2BlockProposedLogs(
   rollup: GetContractReturnType<typeof RollupAbi, PublicClient<HttpTransport, Chain>>,
   publicClient: PublicClient,
   logs: GetContractEventsReturnType<typeof RollupAbi, 'L2BlockProposed'>,
-  logger: DebugLogger,
+  logger: Logger,
 ): Promise<L1Published<L2Block>[]> {
   const retrievedBlocks: L1Published<L2Block>[] = [];
   for (const log of logs) {

yarn-project/archiver/src/archiver/instrumentation.ts

@@ -1,5 +1,5 @@
 import { type L2Block } from '@aztec/circuit-types';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import {
   Attributes,
   type Gauge,
@@ -21,7 +21,7 @@ export class ArchiverInstrumentation {
   private proofsSubmittedCount: UpDownCounter;
   private dbMetrics: LmdbMetrics;
 
-  private log = createDebugLogger('aztec:archiver:instrumentation');
+  private log = createLogger('archiver:instrumentation');
 
   constructor(private telemetry: TelemetryClient) {
     const meter = telemetry.getMeter('Archiver');

yarn-project/archiver/src/archiver/kv_archiver_store/block_store.ts

@@ -1,6 +1,6 @@
 import { Body, type InBlock, L2Block, L2BlockHash, type TxEffect, type TxHash, TxReceipt } from '@aztec/circuit-types';
 import { AppendOnlyTreeSnapshot, type AztecAddress, Header, INITIAL_L2_BLOCK_NUM } from '@aztec/circuits.js';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { type AztecKVStore, type AztecMap, type AztecSingleton, type Range } from '@aztec/kv-store';
 
 import { type L1Published, type L1PublishedData } from '../structs/published.js';
@@ -38,7 +38,7 @@ export class BlockStore {
   /** Index mapping a contract's address (as a string) to its location in a block */
   #contractIndex: AztecMap<string, BlockIndexValue>;
 
-  #log = createDebugLogger('aztec:archiver:block_store');
+  #log = createLogger('archiver:block_store');
 
   constructor(private db: AztecKVStore) {
     this.#blocks = db.openMap('archiver_blocks');

yarn-project/archiver/src/archiver/kv_archiver_store/kv_archiver_store.ts

@@ -19,7 +19,7 @@ import {
 } from '@aztec/circuits.js';
 import { type ContractArtifact, FunctionSelector } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { type AztecKVStore } from '@aztec/kv-store';
 
 import { type ArchiverDataStore, type ArchiverL1SynchPoint } from '../archiver_store.js';
@@ -46,7 +46,7 @@ export class KVArchiverDataStore implements ArchiverDataStore {
   #contractArtifactStore: ContractArtifactsStore;
   private functionNames = new Map<string, string>();
 
-  #log = createDebugLogger('aztec:archiver:data-store');
+  #log = createLogger('archiver:data-store');
 
   constructor(private db: AztecKVStore, logsMaxPageSize: number = 1000) {
     this.#blockStore = new BlockStore(db);

yarn-project/archiver/src/archiver/kv_archiver_store/log_store.ts

@@ -11,7 +11,7 @@ import {
 } from '@aztec/circuit-types';
 import { Fr, PrivateLog } from '@aztec/circuits.js';
 import { INITIAL_L2_BLOCK_NUM, MAX_NOTE_HASHES_PER_TX } from '@aztec/circuits.js/constants';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { BufferReader } from '@aztec/foundation/serialize';
 import { type AztecKVStore, type AztecMap } from '@aztec/kv-store';
 
@@ -27,7 +27,7 @@ export class LogStore {
   #unencryptedLogsByBlock: AztecMap<number, Buffer>;
   #contractClassLogsByBlock: AztecMap<number, Buffer>;
   #logsMaxPageSize: number;
-  #log = createDebugLogger('aztec:archiver:log_store');
+  #log = createLogger('archiver:log_store');
 
   constructor(private db: AztecKVStore, private blockStore: BlockStore, logsMaxPageSize: number = 1000) {
     this.#logsByTag = db.openMap('archiver_tagged_logs_by_tag');