constants.ts

/**
 * Environment variable name for enabling/disabling profiling globally.
 * When set to 'true', profiling is enabled. When set to 'false' or unset, profiling is disabled.
 *
 * @example
 * CP_PROFILING=true npm run dev
 */
export const PROFILER_ENABLED_ENV_VAR = 'CP_PROFILING';

/**
 * Environment variable name for enabling debug mode for profiler state transitions.
 * When set to 'true', profiler state transitions create performance marks for debugging.
 *
 * @example
 * CP_PROFILER_DEBUG=true npm run dev
 */
export const PROFILER_DEBUG_ENV_VAR = 'CP_PROFILER_DEBUG';

/**
 * Environment variable name for setting the Sharded WAL Coordinator ID.
 * This ID is used to identify the coordinator instance in a sharded Write-Ahead Logging setup.
 *
 * @example
 * CP_SHARDED_WAL_COORDINATOR_ID=coordinator-1 npm run dev
 */
export const SHARDED_WAL_COORDINATOR_ID_ENV_VAR =
  'CP_SHARDED_WAL_COORDINATOR_ID';

/**
 * Default base name for WAL files.
 * Used as the base name for sharded WAL files (e.g., "trace" in "trace.json").
 */
export const PROFILER_PERSIST_BASENAME = 'trace';

/**
 * Name for current measure.
 * Used as the name for the sharded folder.
 */
export const PROFILER_MEASURE_NAME_ENV_VAR = 'CP_PROFILER_MEASURE_NAME';