Documentation
¶
Index ¶
Constants ¶
View Source
const EnvVarPrefix = "OP_CONDUCTOR"
Variables ¶
View Source
var ( ConsensusAddr = &cli.StringFlag{ Name: "consensus.addr", Usage: "Address (excluding port) to listen for consensus connections.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "CONSENSUS_ADDR"), Value: "127.0.0.1", } ConsensusPort = &cli.IntFlag{ Name: "consensus.port", Usage: "Port to listen for consensus connections. May be 0 to let the system select a port.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "CONSENSUS_PORT"), Value: 50050, } AdvertisedFullAddr = &cli.StringFlag{ Name: "consensus.advertised", Usage: "Full address (host and port) for other peers to contact the consensus server. Optional: if left empty, the local address is advertised.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "CONSENSUS_ADVERTISED"), Value: "", } RaftBootstrap = &cli.BoolFlag{ Name: "raft.bootstrap", Usage: "If this node should bootstrap a new raft cluster", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_BOOTSTRAP"), Value: false, } RaftServerID = &cli.StringFlag{ Name: "raft.server.id", Usage: "Unique ID for this server used by raft consensus", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_SERVER_ID"), } RaftStorageDir = &cli.StringFlag{ Name: "raft.storage.dir", Usage: "Directory to store raft data", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_STORAGE_DIR"), } RaftSnapshotInterval = &cli.DurationFlag{ Name: "raft.snapshot-interval", Usage: "The interval to check if a snapshot should be taken.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_SNAPSHOT_INTERVAL"), Value: 120 * time.Second, } RaftSnapshotThreshold = &cli.Uint64Flag{ Name: "raft.snapshot-threshold", Usage: "Number of logs to trigger a snapshot", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_SNAPSHOT_THRESHOLD"), Value: 8192, } RaftTrailingLogs = &cli.Uint64Flag{ Name: "raft.trailing-logs", Usage: "Number of logs to keep after a snapshot", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_TRAILING_LOGS"), Value: 10240, } RaftHeartbeatTimeout = &cli.DurationFlag{ Name: "raft.heartbeat-timeout", Usage: "Heartbeat interval timeout", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_HEARTBEAT_TIMEOUT"), Value: 1000 * time.Millisecond, } RaftLeaderLeaseTimeout = &cli.DurationFlag{ Name: "raft.lease-timeout", Usage: "Leader lease timeout", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RAFT_LEASE_TIMEOUT"), Value: 500 * time.Millisecond, } NodeRPC = &cli.StringFlag{ Name: "node.rpc", Usage: "HTTP provider URL for op-node", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "NODE_RPC"), } ExecutionRPC = &cli.StringFlag{ Name: "execution.rpc", Usage: "HTTP provider URL for execution layer", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "EXECUTION_RPC"), } SupervisorRPC = &cli.StringFlag{ Name: "supervisor.rpc", Usage: "HTTP provider URL for supervisor", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "SUPERVISOR_RPC"), } RollupBoostEnabled = &cli.BoolFlag{ Name: "rollup-boost.enabled", Usage: "Enable the rollup-boost healthcheck that uses HTTP status codes (200/206/503). Healthchecks are performed against execution.rpc + '/healthz' (path appended automatically). Mutually exclusive with rollup-boost.next-enabled.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "ROLLUP_BOOST_ENABLED"), Value: false, } RollupBoostHealthcheckTimeout = &cli.DurationFlag{ Name: "rollup-boost.healthcheck-timeout", Usage: "Timeout for rollup-boost healthchecks (applies to both standard and next)", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "ROLLUP_BOOST_HEALTHCHECK_TIMEOUT"), Value: 5 * time.Second, } RollupBoostNextEnabled = &cli.BoolFlag{ Name: "rollup-boost.next-enabled", Usage: "Enable rollup-boost healthcheck using JSON response parsing. Requires rollup-boost.next-healthcheck-url. Mutually exclusive with rollup-boost.enabled.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "ROLLUP_BOOST_NEXT_ENABLED"), Value: false, } RollupBoostNextHealthcheckURL = &cli.StringFlag{ Name: "rollup-boost.next-healthcheck-url", Usage: "Full URL including path for the rollup-boost health endpoint (e.g., 'http://localhost:8080/healthz'). Required when rollup-boost.next-enabled is true.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "ROLLUP_BOOST_NEXT_HEALTHCHECK_URL"), } HealthCheckInterval = &cli.Uint64Flag{ Name: "healthcheck.interval", Usage: "Interval between health checks", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_INTERVAL"), } HealthCheckUnsafeInterval = &cli.Uint64Flag{ Name: "healthcheck.unsafe-interval", Usage: "Interval allowed between unsafe head and now measured in seconds", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_UNSAFE_INTERVAL"), } HealthCheckSafeEnabled = &cli.BoolFlag{ Name: "healthcheck.safe-enabled", Usage: "Whether to enable safe head progression checks", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_SAFE_ENABLED"), Value: false, } HealthCheckSafeInterval = &cli.Uint64Flag{ Name: "healthcheck.safe-interval", Usage: "Interval between safe head progression measured in seconds", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_SAFE_INTERVAL"), Value: 1200, } HealthCheckMinPeerCount = &cli.Uint64Flag{ Name: "healthcheck.min-peer-count", Usage: "Minimum number of peers required to be considered healthy", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_MIN_PEER_COUNT"), } Paused = &cli.BoolFlag{ Name: "paused", Usage: "Whether the conductor is paused", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "PAUSED"), Value: false, } RPCEnableProxy = &cli.BoolFlag{ Name: "rpc.enable-proxy", Usage: "Enable the RPC proxy to underlying sequencer services", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "RPC_ENABLE_PROXY"), Value: true, } RollupBoostWsURL = &cli.StringFlag{ Name: "rollupboost.ws-url", Usage: "WebSocket URL for the rollup boost to listen for payload streams.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "ROLLUPBOOST_WS_URL"), } WebsocketServerPort = &cli.IntFlag{ Name: "websocket.server-port", Usage: "Port for the conductor to run a WebSocket server that pushes payload streams out.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "WEBSOCKET_SERVER_PORT"), Value: 8546, } HealthcheckExecutionP2pEnabled = &cli.BoolFlag{ Name: "healthcheck.execution-p2p-enabled", Usage: "Whether to enable EL P2P checks", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_EXECUTION_P2P_ENABLED"), Value: false, } HealthcheckExecutionP2pMinPeerCount = &cli.Uint64Flag{ Name: "healthcheck.execution-p2p-min-peer-count", Usage: "Minimum number of EL P2P peers required to be considered healthy", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_EXECUTION_P2P_MIN_PEER_COUNT"), } HealthcheckExecutionP2pRPCUrl = &cli.StringFlag{ Name: "healthcheck.execution-p2p-rpc-url", Usage: "URL override for the execution layer RPC client for the sake of p2p healthcheck. If not set, the execution RPC URL will be used.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_EXECUTION_P2P_RPC_URL"), } HealthcheckExecutionP2pCheckApi = &cli.StringFlag{ Name: "healthcheck.execution-p2p-check-api", Usage: "Type of EL P2P check to perform. If not set, the default `net` type will be used corresponding to the `net_peerCount` RPC call.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_EXECUTION_P2P_CHECK_API"), Value: "net", } HealthCheckRollupBoostPartialHealthinessToleranceLimit = &cli.Uint64Flag{ Name: "healthcheck.rollup-boost-partial-healthiness-tolerance-limit", Usage: "Sets the count of rollup-boost partial healthiness failures to occur before marking op-conducto as unhealthy. Default is 0 with which a single occurrence of rollup-boost partial healthiness is enough to set op-conductor as unhealthy", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_ROLLUP_BOOST_PARTIAL_HEALTHINESS_TOLERANCE_LIMIT"), } HealthCheckRollupBoostPartialHealthinessToleranceIntervalSeconds = &cli.Uint64Flag{ Name: "healthcheck.rollup-boost-partial-healthiness-tolerance-interval-seconds", Usage: "The time frame within which rollup-boost partial healthiness tolerance is evaluated", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_ROLLUP_BOOST_PARTIAL_HEALTHINESS_TOLERANCE_INTERVAL_SECONDS"), } )
View Source
var Flags []cli.Flag
Functions ¶
func CheckRequired ¶
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.