1use std::time::Duration;
13
14use mz_dyncfg::{Config, ConfigSet};
15
16pub const ALLOW_USER_SESSIONS: Config<bool> = Config::new(
17 "allow_user_sessions",
18 true,
19 "Whether to allow user roles to create new sessions. When false, only system roles will be permitted to create new sessions.",
20);
21
22pub const WITH_0DT_DEPLOYMENT_MAX_WAIT: Config<Duration> = Config::new(
24 "with_0dt_deployment_max_wait",
25 Duration::from_hours(365 * 24),
28 "How long to wait at most for clusters to be hydrated, when doing a zero-downtime deployment.",
29);
30
31pub const WITH_0DT_DEPLOYMENT_DDL_CHECK_INTERVAL: Config<Duration> = Config::new(
32 "with_0dt_deployment_ddl_check_interval",
33 Duration::from_secs(5 * 60),
34 "How often to check for DDL changes during zero-downtime deployment.",
35);
36
37pub const ENABLE_0DT_DEPLOYMENT_PANIC_AFTER_TIMEOUT: Config<bool> = Config::new(
38 "enable_0dt_deployment_panic_after_timeout",
39 false,
40 "Whether to panic if the maximum wait time is reached but preflight checks have not succeeded.",
41);
42
43pub const WITH_0DT_DEPLOYMENT_CAUGHT_UP_CHECK_INTERVAL: Config<Duration> = Config::new(
44 "0dt_deployment_hydration_check_interval",
46 Duration::from_secs(10),
47 "Interval at which to check whether clusters are caught up, when doing zero-downtime deployment.",
48);
49
50pub const WITH_0DT_CAUGHT_UP_CHECK_ALLOWED_LAG: Config<Duration> = Config::new(
51 "with_0dt_caught_up_check_allowed_lag",
52 Duration::from_secs(60),
53 "Maximum allowed lag when determining whether collections are caught up for 0dt deployments.",
54);
55
56pub const WITH_0DT_CAUGHT_UP_CHECK_CUTOFF: Config<Duration> = Config::new(
57 "with_0dt_caught_up_check_cutoff",
58 Duration::from_secs(2 * 60 * 60), "Collections whose write frontier is behind 'now' by more than the cutoff are ignored when doing caught-up checks for 0dt deployments.",
60);
61
62pub const ENABLE_0DT_CAUGHT_UP_REPLICA_STATUS_CHECK: Config<bool> = Config::new(
63 "enable_0dt_caught_up_replica_status_check",
64 true,
65 "Enable checking for crash/OOM-looping replicas during 0dt caught-up checks. Emergency break-glass flag to disable this feature if needed.",
66);
67
68pub const ENABLE_0DT_CAUGHT_UP_STABILITY_CHECK: Config<bool> = Config::new(
72 "enable_0dt_caught_up_stability_check",
73 true,
74 "Require clusters to stay caught-up and healthy for a stability period before being considered ready during 0dt deployments. Emergency break-glass flag: disabling reverts to treating a caught-up cluster as ready with no replica-health requirement, which differs from setting the stability period to zero (a zero period still requires all replicas to be healthy).",
75);
76
77pub const WITH_0DT_CAUGHT_UP_CHECK_STABILITY_PERIOD: Config<Duration> = Config::new(
78 "with_0dt_caught_up_check_stability_period",
79 Duration::from_secs(10 * 60), "How long a cluster must continuously be caught-up and have all replicas healthy before it is considered ready to cut over during a 0dt deployment.",
81);
82
83pub const ENABLE_STATEMENT_LIFECYCLE_LOGGING: Config<bool> = Config::new(
85 "enable_statement_lifecycle_logging",
86 true,
87 "Enable logging of statement lifecycle events in mz_internal.mz_statement_lifecycle_history.",
88);
89
90pub const ENABLE_INTROSPECTION_SUBSCRIBES: Config<bool> = Config::new(
92 "enable_introspection_subscribes",
93 true,
94 "Enable installation of introspection subscribes.",
95);
96
97pub const ENABLE_FRONTEND_SUBSCRIBES: Config<bool> = Config::new(
99 "enable_frontend_subscribes",
100 true,
101 "Enable sending subscribes down the new frontend-peek path.",
102);
103
104pub const PLAN_INSIGHTS_NOTICE_FAST_PATH_CLUSTERS_OPTIMIZE_DURATION: Config<Duration> = Config::new(
106 "plan_insights_notice_fast_path_clusters_optimize_duration",
107 Duration::from_millis(10),
113 "Enable plan insights fast path clusters calculation if the optimize step took less than this duration.",
114);
115
116pub const ENABLE_EXPRESSION_CACHE: Config<bool> = Config::new(
118 "enable_expression_cache",
119 true,
120 "Use a cache to store optimized expressions to help speed up start times. \
121 Read at startup, so changing it takes effect on the next restart.",
122);
123
124pub const ENABLE_PASSWORD_AUTH: Config<bool> = Config::new(
126 "enable_password_auth",
127 false,
128 "Enable password authentication.",
129);
130
131pub const READ_THEN_WRITE_MAX_DEPENDENCIES: Config<usize> = Config::new(
137 "read_then_write_max_dependencies",
138 100_000,
139 "Maximum number of transitive dependencies validated for a read-then-write \
140 statement before it is rejected.",
141);
142
143pub const OIDC_ISSUER: Config<Option<&'static str>> =
145 Config::new("oidc_issuer", None, "OIDC issuer URL.");
146
147pub const OIDC_AUDIENCE: Config<fn() -> serde_json::Value> = Config::new(
153 "oidc_audience",
154 || serde_json::json!([]),
155 "OIDC audience (client IDs). A JSON array of strings. When empty, audience validation is skipped.",
156);
157
158pub const OIDC_AUTHENTICATION_CLAIM: Config<&'static str> = Config::new(
160 "oidc_authentication_claim",
161 "sub",
162 "OIDC authentication claim to use as username.",
163);
164
165pub const OIDC_GROUP_ROLE_SYNC_ENABLED: Config<bool> = Config::new(
168 "oidc_group_role_sync_enabled",
169 false,
170 "Enable OIDC JWT group-to-role membership sync on login.",
171);
172
173pub const OIDC_GROUP_CLAIM: Config<&'static str> = Config::new(
177 "oidc_group_claim",
178 "groups",
179 "JWT claim path containing group memberships for role sync. Supports dot-separated paths into nested objects (e.g. customClaims.groups).",
180);
181
182pub const OIDC_GROUP_ROLE_SYNC_STRICT: Config<bool> = Config::new(
185 "oidc_group_role_sync_strict",
186 false,
187 "When true, reject login if OIDC group-to-role sync fails (fail-closed).",
188);
189
190pub const PERSIST_FAST_PATH_ORDER: Config<bool> = Config::new(
191 "persist_fast_path_order",
192 false,
193 "If set, send queries with a compatible literal constraint or ordering clause down the Persist fast path.",
194);
195
196pub const ENABLE_S3_TABLES_REGION_CHECK: Config<bool> = Config::new(
199 "enable_s3_tables_region_check",
200 false,
201 "Whether to enforce that S3 Tables connections are in the same region as the environment.",
202);
203
204pub const ENABLE_MCP_AGENT: Config<bool> = Config::new(
206 "enable_mcp_agent",
207 true,
208 "Whether the MCP agent HTTP endpoint is enabled. When false, requests to /api/mcp/agent return 503 Service Unavailable.",
209);
210
211pub const ENABLE_MCP_AGENT_QUERY_TOOL: Config<bool> = Config::new(
215 "enable_mcp_agent_query_tool",
216 true,
217 "Whether the MCP agent query tool is enabled. When false, the query tool is not advertised and calls to it are rejected. Agents can still discover and inspect data products.",
218);
219
220pub const ENABLE_MCP_AGENT_READ_DATA_PRODUCT_TOOL: Config<bool> = Config::new(
224 "enable_mcp_agent_read_data_product_tool",
225 true,
226 "Whether the MCP agent read_data_product tool is enabled. When false, the read_data_product tool is not advertised and calls to it are rejected. Agents can use the query tool to read data products.",
227);
228
229pub const ENABLE_MCP_DEVELOPER: Config<bool> = Config::new(
231 "enable_mcp_developer",
232 true,
233 "Whether the MCP developer HTTP endpoint is enabled. When false, requests to /api/mcp/developer return 503 Service Unavailable.",
234);
235
236pub const ENABLE_MCP_DEVELOPER_QUERY_TOOL: Config<bool> = Config::new(
240 "enable_mcp_developer_query_tool",
241 true,
242 "Whether the MCP developer query tool is enabled. When false, the query tool is not advertised and calls to it are rejected. Developers can still use query_system_catalog.",
243);
244
245pub const ENABLE_PUBLIC_METRICS_ENDPOINT: Config<bool> = Config::new(
247 "enable_public_metrics_endpoint",
248 true,
249 "Whether the external metrics endpoint on environmentd is enabled. When false, requests return 503.",
250);
251
252pub const MCP_MAX_RESPONSE_SIZE: Config<usize> = Config::new(
256 "mcp_max_response_size",
257 1_000_000,
258 "Maximum size in bytes of MCP tool response content. Responses exceeding this limit are rejected with an error telling the agent to narrow its query.",
259);
260
261pub const MCP_REQUEST_TIMEOUT: Config<Duration> = Config::new(
264 "mcp_request_timeout",
265 Duration::from_secs(60),
266 "Maximum time an MCP request may run before it is aborted with a timeout error.",
267);
268
269pub const WEBHOOK_MAX_REQUEST_SIZE_BYTES: Config<usize> = Config::new(
274 "webhook_max_request_size_bytes",
275 5 * 1024 * 1024,
277 "The maximum size in bytes of a webhook request body, measured after decompression.",
278);
279
280pub const WEBHOOK_VALIDATION_MEMORY_BUDGET_BYTES: Config<usize> = Config::new(
295 "webhook_validation_memory_budget_bytes",
296 20 * 1024 * 1024,
297 "The maximum bytes of temporary storage a webhook CHECK expression may allocate while validating one request.",
298);
299
300pub const SUBSCRIBE_MAX_BUFFERED_BYTES: Config<usize> = Config::new(
314 "subscribe_max_buffered_bytes",
315 128 * 1024 * 1024,
316 "Maximum bytes a SUBSCRIBE may buffer in environmentd for a slow client before it is retired with an error.",
317);
318
319pub const USER_ID_POOL_BATCH_SIZE: Config<u32> = Config::new(
322 "user_id_pool_batch_size",
323 512,
324 "Number of user IDs to pre-allocate in a batch for DDL operations.",
325);
326
327pub const GROUP_COMMIT_MAX_ATTEMPTS: Config<usize> = Config::new(
331 "group_commit_max_attempts",
332 100,
333 "Maximum number of txns-shard write attempts before rebuilding environmentd. Values below 1 are treated as 1.",
334);
335
336pub const CONSOLE_OIDC_CLIENT_ID: Config<&'static str> = Config::new(
338 "console_oidc_client_id",
339 "",
340 "OIDC client ID for the web console.",
341);
342
343pub const CONSOLE_OIDC_SCOPES: Config<&'static str> = Config::new(
345 "console_oidc_scopes",
346 "",
347 "Space-separated OIDC scopes requested by the web console.",
348);
349
350pub const ARRANGEMENT_SIZE_HISTORY_COLLECTION_INTERVAL: Config<Duration> = Config::new(
352 "arrangement_size_history_collection_interval",
353 Duration::ZERO,
355 "Interval at which to collect and snapshot per-object arrangement sizes \
356 into mz_internal.mz_object_arrangement_size_history.",
357);
358
359pub const ARRANGEMENT_SIZE_HISTORY_RETENTION_PERIOD: Config<Duration> = Config::new(
361 "arrangement_size_history_retention_period",
362 Duration::from_hours(7 * 24),
363 "How long to retain rows in mz_internal.mz_object_arrangement_size_history.",
364);
365
366pub const CATALOG_INFO_METRICS_RECONCILE_INTERVAL: Config<Duration> = Config::new(
370 "catalog_info_metrics_reconcile_interval",
371 Duration::from_secs(30),
372 "How frequently to reconcile the catalog `*_info` metrics with the catalog. A zero duration disables reconciliation.",
373);
374
375pub const PG_TIMESTAMP_ORACLE_STATEMENT_TIMEOUT: Config<Duration> = Config::new(
379 "pg_timestamp_oracle_statement_timeout",
380 crate::timestamp_oracle::DEFAULT_PG_TIMESTAMP_ORACLE_STATEMENT_TIMEOUT,
381 "The server-side statement timeout to set on Postgres/CRDB connections used by the \
382 Postgres/CRDB timestamp oracle. A value of zero leaves the statement timeout unset.",
383);
384
385pub const CLUSTER_CONTROLLER_TICK_INTERVAL: Config<Duration> = Config::new(
387 "cluster_controller_tick_interval",
388 Duration::from_secs(5),
389 "How often the cluster controller runs a reconcile tick.",
390);
391
392pub const ENABLE_BACKGROUND_ALTER_CLUSTER: Config<bool> = Config::new(
399 "enable_background_alter_cluster",
400 true,
401 "Whether a config-shape ALTER CLUSTER returns immediately (true) or the session blocks on a wait-shim over the durable reconfiguration record (false).",
402);
403
404pub const DEFAULT_CLUSTER_RECONFIGURATION_TIMEOUT: Config<Duration> = Config::new(
408 "default_cluster_reconfiguration_timeout",
409 Duration::from_secs(60 * 60 * 24),
410 "The reconfiguration deadline written when a config-shape ALTER CLUSTER omits WITH (WAIT ...).",
411);
412
413pub const ENABLE_HYDRATION_BURST: Config<bool> = Config::new(
421 "enable_hydration_burst",
422 true,
423 "Whether the cluster controller's hydration-burst strategy may run a burst replica (break-glass; leaves graceful reconfiguration and ON REFRESH untouched).",
424);
425
426pub const DEFAULT_HYDRATION_BURST_LINGER: Config<Duration> = Config::new(
430 "default_hydration_burst_linger",
431 Duration::from_secs(0),
432 "The burst-replica linger duration written when an AUTO SCALING STRATEGY omits LINGER DURATION.",
433);
434
435pub const FRONTEND_READ_THEN_WRITE: Config<bool> = Config::new(
436 "enable_adapter_frontend_occ_read_then_write",
437 false,
438 "Use frontend sequencing (with optimistic concurrency control) for \
439 DELETE, UPDATE, and INSERT operations. Read at startup, so changing it \
440 takes effect on the next restart.",
441);
442
443pub fn all_dyncfgs(configs: ConfigSet) -> ConfigSet {
445 configs
446 .add(&ALLOW_USER_SESSIONS)
447 .add(&CLUSTER_CONTROLLER_TICK_INTERVAL)
448 .add(&ENABLE_BACKGROUND_ALTER_CLUSTER)
449 .add(&DEFAULT_CLUSTER_RECONFIGURATION_TIMEOUT)
450 .add(&ENABLE_HYDRATION_BURST)
451 .add(&DEFAULT_HYDRATION_BURST_LINGER)
452 .add(&WITH_0DT_DEPLOYMENT_MAX_WAIT)
453 .add(&WITH_0DT_DEPLOYMENT_DDL_CHECK_INTERVAL)
454 .add(&ENABLE_0DT_DEPLOYMENT_PANIC_AFTER_TIMEOUT)
455 .add(&WITH_0DT_DEPLOYMENT_CAUGHT_UP_CHECK_INTERVAL)
456 .add(&WITH_0DT_CAUGHT_UP_CHECK_ALLOWED_LAG)
457 .add(&WITH_0DT_CAUGHT_UP_CHECK_CUTOFF)
458 .add(&ENABLE_0DT_CAUGHT_UP_REPLICA_STATUS_CHECK)
459 .add(&ENABLE_0DT_CAUGHT_UP_STABILITY_CHECK)
460 .add(&WITH_0DT_CAUGHT_UP_CHECK_STABILITY_PERIOD)
461 .add(&ENABLE_STATEMENT_LIFECYCLE_LOGGING)
462 .add(&ENABLE_INTROSPECTION_SUBSCRIBES)
463 .add(&ENABLE_FRONTEND_SUBSCRIBES)
464 .add(&PLAN_INSIGHTS_NOTICE_FAST_PATH_CLUSTERS_OPTIMIZE_DURATION)
465 .add(&ENABLE_EXPRESSION_CACHE)
466 .add(&ENABLE_PASSWORD_AUTH)
467 .add(&READ_THEN_WRITE_MAX_DEPENDENCIES)
468 .add(&OIDC_ISSUER)
469 .add(&OIDC_AUDIENCE)
470 .add(&OIDC_AUTHENTICATION_CLAIM)
471 .add(&OIDC_GROUP_ROLE_SYNC_ENABLED)
472 .add(&OIDC_GROUP_CLAIM)
473 .add(&OIDC_GROUP_ROLE_SYNC_STRICT)
474 .add(&PERSIST_FAST_PATH_ORDER)
475 .add(&ENABLE_S3_TABLES_REGION_CHECK)
476 .add(&ENABLE_MCP_AGENT)
477 .add(&ENABLE_MCP_AGENT_QUERY_TOOL)
478 .add(&ENABLE_MCP_AGENT_READ_DATA_PRODUCT_TOOL)
479 .add(&ENABLE_MCP_DEVELOPER)
480 .add(&ENABLE_MCP_DEVELOPER_QUERY_TOOL)
481 .add(&ENABLE_PUBLIC_METRICS_ENDPOINT)
482 .add(&MCP_MAX_RESPONSE_SIZE)
483 .add(&MCP_REQUEST_TIMEOUT)
484 .add(&WEBHOOK_MAX_REQUEST_SIZE_BYTES)
485 .add(&WEBHOOK_VALIDATION_MEMORY_BUDGET_BYTES)
486 .add(&SUBSCRIBE_MAX_BUFFERED_BYTES)
487 .add(&USER_ID_POOL_BATCH_SIZE)
488 .add(&GROUP_COMMIT_MAX_ATTEMPTS)
489 .add(&CONSOLE_OIDC_CLIENT_ID)
490 .add(&CONSOLE_OIDC_SCOPES)
491 .add(&ARRANGEMENT_SIZE_HISTORY_COLLECTION_INTERVAL)
492 .add(&ARRANGEMENT_SIZE_HISTORY_RETENTION_PERIOD)
493 .add(&CATALOG_INFO_METRICS_RECONCILE_INTERVAL)
494 .add(&PG_TIMESTAMP_ORACLE_STATEMENT_TIMEOUT)
495 .add(&FRONTEND_READ_THEN_WRITE)
496}