diff --git a/src/current/v24.2/cluster-virtualization-metric-scopes.md b/src/current/v24.2/cluster-virtualization-metric-scopes.md index 779890abce0..b01bc30cf4f 100644 --- a/src/current/v24.2/cluster-virtualization-metric-scopes.md +++ b/src/current/v24.2/cluster-virtualization-metric-scopes.md @@ -17,10 +17,11 @@ When [cluster virtualization]({% link {{ page.version.version }}/cluster-virtual - When a metric is scoped to the system virtual cluster, it is included only in the metrics for the system virtual cluster. These metrics provide information about the underlying CockroachDB cluster's performance. Refer to [Metrics scoped to the system virtual cluster](#metrics-scoped-to-the-system-virtual-cluster). {% comment %} -Src: cockroach gen metrics-list against v23.2.0-rc.2 +Src: cockroach gen metrics-list --format=csv against cockroach-v24.2.0-rc.1.darwin-10.9-amd64 + Also saved in https://docs.google.com/spreadsheets/d/1HIalzAhwU0CEYzSuG2m1aXSJRpiIyQPJdt8SusHpJ_U/edit?usp=sharing -(shared CRL-internal). There is a filter-view on the STORAGE column: +(shared CRL-internal). Sort by Layer, then Metric. Paste into the correct section below. APPLICATION: Scoped to a virtual cluster STORAGE: Scoped to the system virtual cluster @@ -32,11 +33,14 @@ SERVER: n/a {% comment %}LAYER=APPLICATION{% endcomment %} - `backup.last-failed-time.kms-inaccessible` +- `build.timestamp` - `changefeed.admit_latency` - `changefeed.aggregator_progress` - `changefeed.backfill_count` - `changefeed.backfill_pending_ranges` - `changefeed.batch_reduction_count` +- `changefeed.buffer_entries_mem.acquired` +- `changefeed.buffer_entries_mem.released` - `changefeed.buffer_entries.allocated_mem` - `changefeed.buffer_entries.flush` - `changefeed.buffer_entries.in` @@ -44,26 +48,26 @@ SERVER: n/a - `changefeed.buffer_entries.out` - `changefeed.buffer_entries.released` - `changefeed.buffer_entries.resolved` -- `changefeed.buffer_entries_mem.acquired` -- `changefeed.buffer_entries_mem.released` - `changefeed.buffer_pushback_nanos` - `changefeed.bytes.messages_pushback_nanos` - `changefeed.checkpoint_hist_nanos` - `changefeed.checkpoint_progress` - `changefeed.cloudstorage_buffered_bytes` - `changefeed.commit_latency` +- `changefeed.emitted_batch_sizes` - `changefeed.emitted_bytes` - `changefeed.emitted_messages` - `changefeed.error_retries` - `changefeed.failures` - `changefeed.filtered_messages` -- `changefeed.flush.messages_pushback_nanos` - `changefeed.flush_hist_nanos` +- `changefeed.flush.messages_pushback_nanos` - `changefeed.flushed_bytes` - `changefeed.flushes` - `changefeed.forwarded_resolved_messages` - `changefeed.frontier_updates` - `changefeed.internal_retry_message_count` +- `changefeed.kafka_throttling_hist_nanos` - `changefeed.lagging_ranges` - `changefeed.max_behind_nanos` - `changefeed.message_size_hist` @@ -71,7 +75,10 @@ SERVER: n/a - `changefeed.nprocs_consume_event_nanos` - `changefeed.nprocs_flush_nanos` - `changefeed.nprocs_in_flight_count` +- `changefeed.parallel_io_in_flight_keys` +- `changefeed.parallel_io_pending_rows` - `changefeed.parallel_io_queue_nanos` +- `changefeed.parallel_io_result_queue_nanos` - `changefeed.queue_time_nanos` - `changefeed.running` - `changefeed.schema_registry.registrations` @@ -81,10 +88,22 @@ SERVER: n/a - `changefeed.sink_batch_hist_nanos` - `changefeed.sink_io_inflight` - `changefeed.size_based_flushes` +- `changefeed.usage.error_count` +- `changefeed.usage.query_duration` +- `changefeed.usage.table_bytes` - `clock-offset.meannanos` - `clock-offset.stddevnanos` +- `cloud.conns_opened` +- `cloud.conns_reused` +- `cloud.listing_results` +- `cloud.listings` +- `cloud.open_readers` +- `cloud.open_writers` - `cloud.read_bytes` +- `cloud.readers_opened` +- `cloud.tls_handshakes` - `cloud.write_bytes` +- `cloud.writers_opened` - `cluster.preserve-downgrade-option.last-updated` - `distsender.batch_requests.cross_region.bytes` - `distsender.batch_requests.cross_zone.bytes` @@ -96,12 +115,22 @@ SERVER: n/a - `distsender.batches.async.sent` - `distsender.batches.async.throttled` - `distsender.batches.partial` +- `distsender.circuit_breaker.replicas.count` +- `distsender.circuit_breaker.replicas.probes.failure` +- `distsender.circuit_breaker.replicas.probes.running` +- `distsender.circuit_breaker.replicas.probes.success` +- `distsender.circuit_breaker.replicas.requests.cancelled` +- `distsender.circuit_breaker.replicas.requests.rejected` +- `distsender.circuit_breaker.replicas.tripped` +- `distsender.circuit_breaker.replicas.tripped_events` - `distsender.errors.inleasetransferbackoffs` - `distsender.errors.notleaseholder` - `distsender.rangefeed.catchup_ranges` - `distsender.rangefeed.error_catchup_ranges` +- `distsender.rangefeed.local_ranges` - `distsender.rangefeed.restart_ranges` - `distsender.rangefeed.retry.logical_ops_missing` +- `distsender.rangefeed.retry.manual_range_split` - `distsender.rangefeed.retry.no_leaseholder` - `distsender.rangefeed.retry.node_not_found` - `distsender.rangefeed.retry.raft_snapshot` @@ -114,7 +143,6 @@ SERVER: n/a - `distsender.rangefeed.retry.send` - `distsender.rangefeed.retry.slow_consumer` - `distsender.rangefeed.retry.store_not_found` -- `distsender.rangefeed.retry.stuck` - `distsender.rangefeed.total_ranges` - `distsender.rangelookups` - `distsender.rpc.addsstable.sent` @@ -162,6 +190,7 @@ SERVER: n/a - `distsender.rpc.err.notleaseholdererrtype` - `distsender.rpc.err.oprequirestxnerrtype` - `distsender.rpc.err.optimisticevalconflictserrtype` +- `distsender.rpc.err.proxyfailederrtype` - `distsender.rpc.err.raftgroupdeletederrtype` - `distsender.rpc.err.rangefeedretryerrtype` - `distsender.rpc.err.rangekeymismatcherrtype` @@ -170,6 +199,7 @@ SERVER: n/a - `distsender.rpc.err.refreshfailederrtype` - `distsender.rpc.err.replicacorruptionerrtype` - `distsender.rpc.err.replicatooolderrtype` +- `distsender.rpc.err.replicaunavailableerrtype` - `distsender.rpc.err.storenotfounderrtype` - `distsender.rpc.err.transactionabortederrtype` - `distsender.rpc.err.transactionpusherrtype` @@ -188,9 +218,14 @@ SERVER: n/a - `distsender.rpc.initput.sent` - `distsender.rpc.isspanempty.sent` - `distsender.rpc.leaseinfo.sent` +- `distsender.rpc.linkexternalsstable.sent` - `distsender.rpc.merge.sent` - `distsender.rpc.migrate.sent` - `distsender.rpc.probe.sent` +- `distsender.rpc.proxy.err` +- `distsender.rpc.proxy.forward.err` +- `distsender.rpc.proxy.forward.sent` +- `distsender.rpc.proxy.sent` - `distsender.rpc.pushtxn.sent` - `distsender.rpc.put.sent` - `distsender.rpc.queryintent.sent` @@ -215,6 +250,7 @@ SERVER: n/a - `distsender.rpc.transferlease.sent` - `distsender.rpc.truncatelog.sent` - `distsender.rpc.writebatch.sent` +- `distsender.slow.replicarpcs` - `jobs.adopt_iterations` - `jobs.auto_config_env_runner.currently_idle` - `jobs.auto_config_env_runner.currently_paused` @@ -349,6 +385,30 @@ SERVER: n/a - `jobs.create_stats.resume_completed` - `jobs.create_stats.resume_failed` - `jobs.create_stats.resume_retry_error` +- `jobs.history_retention.currently_idle` +- `jobs.history_retention.currently_paused` +- `jobs.history_retention.currently_running` +- `jobs.history_retention.expired_pts_records` +- `jobs.history_retention.fail_or_cancel_completed` +- `jobs.history_retention.fail_or_cancel_failed` +- `jobs.history_retention.fail_or_cancel_retry_error` +- `jobs.history_retention.protected_age_sec` +- `jobs.history_retention.protected_record_count` +- `jobs.history_retention.resume_completed` +- `jobs.history_retention.resume_failed` +- `jobs.history_retention.resume_retry_error` +- `jobs.import_rollback.currently_idle` +- `jobs.import_rollback.currently_paused` +- `jobs.import_rollback.currently_running` +- `jobs.import_rollback.expired_pts_records` +- `jobs.import_rollback.fail_or_cancel_completed` +- `jobs.import_rollback.fail_or_cancel_failed` +- `jobs.import_rollback.fail_or_cancel_retry_error` +- `jobs.import_rollback.protected_age_sec` +- `jobs.import_rollback.protected_record_count` +- `jobs.import_rollback.resume_completed` +- `jobs.import_rollback.resume_failed` +- `jobs.import_rollback.resume_retry_error` - `jobs.import.currently_idle` - `jobs.import.currently_paused` - `jobs.import.currently_running` @@ -373,6 +433,18 @@ SERVER: n/a - `jobs.key_visualizer.resume_completed` - `jobs.key_visualizer.resume_failed` - `jobs.key_visualizer.resume_retry_error` +- `jobs.logical_replication.currently_idle` +- `jobs.logical_replication.currently_paused` +- `jobs.logical_replication.currently_running` +- `jobs.logical_replication.expired_pts_records` +- `jobs.logical_replication.fail_or_cancel_completed` +- `jobs.logical_replication.fail_or_cancel_failed` +- `jobs.logical_replication.fail_or_cancel_retry_error` +- `jobs.logical_replication.protected_age_sec` +- `jobs.logical_replication.protected_record_count` +- `jobs.logical_replication.resume_completed` +- `jobs.logical_replication.resume_failed` +- `jobs.logical_replication.resume_retry_error` - `jobs.metrics.task_failed` - `jobs.migration.currently_idle` - `jobs.migration.currently_paused` @@ -480,18 +552,6 @@ SERVER: n/a - `jobs.row_level_ttl.total_expired_rows` - `jobs.row_level_ttl.total_rows` - `jobs.running_non_idle` -- `jobs.schema_change.currently_idle` -- `jobs.schema_change.currently_paused` -- `jobs.schema_change.currently_running` -- `jobs.schema_change.expired_pts_records` -- `jobs.schema_change.fail_or_cancel_completed` -- `jobs.schema_change.fail_or_cancel_failed` -- `jobs.schema_change.fail_or_cancel_retry_error` -- `jobs.schema_change.protected_age_sec` -- `jobs.schema_change.protected_record_count` -- `jobs.schema_change.resume_completed` -- `jobs.schema_change.resume_failed` -- `jobs.schema_change.resume_retry_error` - `jobs.schema_change_gc.currently_idle` - `jobs.schema_change_gc.currently_paused` - `jobs.schema_change_gc.currently_running` @@ -504,6 +564,18 @@ SERVER: n/a - `jobs.schema_change_gc.resume_completed` - `jobs.schema_change_gc.resume_failed` - `jobs.schema_change_gc.resume_retry_error` +- `jobs.schema_change.currently_idle` +- `jobs.schema_change.currently_paused` +- `jobs.schema_change.currently_running` +- `jobs.schema_change.expired_pts_records` +- `jobs.schema_change.fail_or_cancel_completed` +- `jobs.schema_change.fail_or_cancel_failed` +- `jobs.schema_change.fail_or_cancel_retry_error` +- `jobs.schema_change.protected_age_sec` +- `jobs.schema_change.protected_record_count` +- `jobs.schema_change.resume_completed` +- `jobs.schema_change.resume_failed` +- `jobs.schema_change.resume_retry_error` - `jobs.typedesc_schema_change.currently_idle` - `jobs.typedesc_schema_change.currently_paused` - `jobs.typedesc_schema_change.currently_running` @@ -520,6 +592,27 @@ SERVER: n/a - `kv.protectedts.reconciliation.num_runs` - `kv.protectedts.reconciliation.records_processed` - `kv.protectedts.reconciliation.records_removed` +- `logical_replication.batch_hist_nanos` +- `logical_replication.checkpoint_events_ingested` +- `logical_replication.commit_latency` +- `logical_replication.events_dlqed` +- `logical_replication.events_dlqed_age` +- `logical_replication.events_dlqed_errtype` +- `logical_replication.events_dlqed_space` +- `logical_replication.events_ingested` +- `logical_replication.events_initial_failure` +- `logical_replication.events_initial_success` +- `logical_replication.events_retry_failure` +- `logical_replication.events_retry_success` +- `logical_replication.flush_bytes` +- `logical_replication.flush_hist_nanos` +- `logical_replication.flush_row_count` +- `logical_replication.logical_bytes` +- `logical_replication.optimistic_insert_conflict_count` +- `logical_replication.replan_count` +- `logical_replication.replicated_time_seconds` +- `logical_replication.retry_queue_bytes` +- `logical_replication.retry_queue_events` - `physical_replication.admit_latency` - `physical_replication.commit_latency` - `physical_replication.cutover_progress` @@ -600,6 +693,7 @@ SERVER: n/a - `sql.disk.distsql.spilled.bytes.read` - `sql.disk.distsql.spilled.bytes.written` - `sql.distsql.contended_queries.count` +- `sql.distsql.cumulative_contention_nanos` - `sql.distsql.dist_query_rerun_locally.count` - `sql.distsql.dist_query_rerun_locally.failure_count` - `sql.distsql.exec.latency` @@ -651,6 +745,11 @@ SERVER: n/a - `sql.insights.anomaly_detection.fingerprints` - `sql.insights.anomaly_detection.memory` - `sql.leases.active` +- `sql.leases.expired` +- `sql.leases.long_wait_for_no_version` +- `sql.leases.long_wait_for_one_version` +- `sql.leases.long_wait_for_two_version_invariant` +- `sql.leases.waiting_to_expire` - `sql.mem.bulk.current` - `sql.mem.bulk.max` - `sql.mem.conns.current` @@ -689,6 +788,7 @@ SERVER: n/a - `sql.pgwire_cancel.ignored` - `sql.pgwire_cancel.successful` - `sql.pgwire_cancel.total` +- `sql.pgwire.pipeline.count` - `sql.pre_serve.bytesin` - `sql.pre_serve.bytesout` - `sql.pre_serve.conn.failures` @@ -723,11 +823,11 @@ SERVER: n/a - `sql.savepoint.rollback.started.count.internal` - `sql.savepoint.started.count` - `sql.savepoint.started.count.internal` -- `sql.schema.invalid_objects` - `sql.schema_changer.permanent_errors` - `sql.schema_changer.retry_errors` - `sql.schema_changer.running` - `sql.schema_changer.successes` +- `sql.schema.invalid_objects` - `sql.select.count` - `sql.select.count.internal` - `sql.select.started.count` @@ -736,11 +836,16 @@ SERVER: n/a - `sql.service.latency.internal` - `sql.statements.active` - `sql.statements.active.internal` +- `sql.stats.activity.update.latency` +- `sql.stats.activity.updates.failed` +- `sql.stats.activity.updates.successful` - `sql.stats.cleanup.rows_removed` - `sql.stats.discarded.current` -- `sql.stats.flush.count` -- `sql.stats.flush.duration` -- `sql.stats.flush.error` +- `sql.stats.flush.done_signals.ignored` +- `sql.stats.flush.fingerprint.count` +- `sql.stats.flush.latency` +- `sql.stats.flushes.failed` +- `sql.stats.flushes.successful` - `sql.stats.mem.current` - `sql.stats.mem.max` - `sql.stats.reported.mem.current` @@ -768,6 +873,8 @@ SERVER: n/a - `sql.txn.rollback.count.internal` - `sql.txn.rollback.started.count` - `sql.txn.rollback.started.count.internal` +- `sql.txn.upgraded_iso_level.count` +- `sql.txn.upgraded_iso_level.count.internal` - `sql.txns.open` - `sql.txns.open.internal` - `sql.update.count` @@ -780,14 +887,33 @@ SERVER: n/a - `sqlliveness.sessions_deletion_runs` - `sqlliveness.write_failures` - `sqlliveness.write_successes` +- `tenant.cost_client.blocked_requests` +- `tenant.sql_usage.cross_region_network_ru` +- `tenant.sql_usage.estimated_cpu_seconds` +- `tenant.sql_usage.estimated_kv_cpu_seconds` +- `tenant.sql_usage.estimated_replication_bytes` +- `tenant.sql_usage.external_io_egress_bytes` +- `tenant.sql_usage.external_io_ingress_bytes` +- `tenant.sql_usage.kv_request_units` +- `tenant.sql_usage.pgwire_egress_bytes` +- `tenant.sql_usage.read_batches` +- `tenant.sql_usage.read_bytes` +- `tenant.sql_usage.read_requests` +- `tenant.sql_usage.request_units` +- `tenant.sql_usage.sql_pods_cpu_seconds` +- `tenant.sql_usage.write_batches` +- `tenant.sql_usage.write_bytes` +- `tenant.sql_usage.write_requests` - `txn.aborts` - `txn.commit_waits` - `txn.commits` +- `txn.commits_read_only` - `txn.commits1PC` - `txn.condensed_intent_spans` - `txn.condensed_intent_spans_gauge` - `txn.condensed_intent_spans_rejected` - `txn.durations` +- `txn.inflight_locks_over_tracking_budget` - `txn.parallelcommits` - `txn.parallelcommits.auto_retries` - `txn.refresh.auto_retries` @@ -823,13 +949,14 @@ SERVER: n/a - `admission.admitted.elastic-cpu` - `admission.admitted.elastic-cpu.bulk-normal-pri` - `admission.admitted.elastic-cpu.normal-pri` +- `admission.admitted.elastic-stores` +- `admission.admitted.elastic-stores.bulk-normal-pri` +- `admission.admitted.elastic-stores.ttl-low-pri` - `admission.admitted.kv` - `admission.admitted.kv-stores` -- `admission.admitted.kv-stores.bulk-normal-pri` - `admission.admitted.kv-stores.high-pri` - `admission.admitted.kv-stores.locking-normal-pri` - `admission.admitted.kv-stores.normal-pri` -- `admission.admitted.kv-stores.ttl-low-pri` - `admission.admitted.kv.high-pri` - `admission.admitted.kv.locking-normal-pri` - `admission.admitted.kv.normal-pri` @@ -857,13 +984,14 @@ SERVER: n/a - `admission.errored.elastic-cpu` - `admission.errored.elastic-cpu.bulk-normal-pri` - `admission.errored.elastic-cpu.normal-pri` +- `admission.errored.elastic-stores` +- `admission.errored.elastic-stores.bulk-normal-pri` +- `admission.errored.elastic-stores.ttl-low-pri` - `admission.errored.kv` - `admission.errored.kv-stores` -- `admission.errored.kv-stores.bulk-normal-pri` - `admission.errored.kv-stores.high-pri` - `admission.errored.kv-stores.locking-normal-pri` - `admission.errored.kv-stores.normal-pri` -- `admission.errored.kv-stores.ttl-low-pri` - `admission.errored.kv.high-pri` - `admission.errored.kv.locking-normal-pri` - `admission.errored.kv.normal-pri` @@ -882,6 +1010,7 @@ SERVER: n/a - `admission.granter.cpu_load_long_period_duration.kv` - `admission.granter.cpu_load_short_period_duration.kv` - `admission.granter.elastic_io_tokens_available.kv` +- `admission.granter.elastic_io_tokens_exhausted_duration.kv` - `admission.granter.io_tokens_available.kv` - `admission.granter.io_tokens_bypassed.kv` - `admission.granter.io_tokens_exhausted_duration.kv` @@ -902,13 +1031,14 @@ SERVER: n/a - `admission.requested.elastic-cpu` - `admission.requested.elastic-cpu.bulk-normal-pri` - `admission.requested.elastic-cpu.normal-pri` +- `admission.requested.elastic-stores` +- `admission.requested.elastic-stores.bulk-normal-pri` +- `admission.requested.elastic-stores.ttl-low-pri` - `admission.requested.kv` - `admission.requested.kv-stores` -- `admission.requested.kv-stores.bulk-normal-pri` - `admission.requested.kv-stores.high-pri` - `admission.requested.kv-stores.locking-normal-pri` - `admission.requested.kv-stores.normal-pri` -- `admission.requested.kv-stores.ttl-low-pri` - `admission.requested.kv.high-pri` - `admission.requested.kv.locking-normal-pri` - `admission.requested.kv.normal-pri` @@ -928,13 +1058,14 @@ SERVER: n/a - `admission.wait_durations.elastic-cpu` - `admission.wait_durations.elastic-cpu.bulk-normal-pri` - `admission.wait_durations.elastic-cpu.normal-pri` +- `admission.wait_durations.elastic-stores` +- `admission.wait_durations.elastic-stores.bulk-normal-pri` +- `admission.wait_durations.elastic-stores.ttl-low-pri` - `admission.wait_durations.kv` - `admission.wait_durations.kv-stores` -- `admission.wait_durations.kv-stores.bulk-normal-pri` - `admission.wait_durations.kv-stores.high-pri` - `admission.wait_durations.kv-stores.locking-normal-pri` - `admission.wait_durations.kv-stores.normal-pri` -- `admission.wait_durations.kv-stores.ttl-low-pri` - `admission.wait_durations.kv.high-pri` - `admission.wait_durations.kv.locking-normal-pri` - `admission.wait_durations.kv.normal-pri` @@ -953,13 +1084,14 @@ SERVER: n/a - `admission.wait_queue_length.elastic-cpu` - `admission.wait_queue_length.elastic-cpu.bulk-normal-pri` - `admission.wait_queue_length.elastic-cpu.normal-pri` +- `admission.wait_queue_length.elastic-stores` +- `admission.wait_queue_length.elastic-stores.bulk-normal-pri` +- `admission.wait_queue_length.elastic-stores.ttl-low-pri` - `admission.wait_queue_length.kv` - `admission.wait_queue_length.kv-stores` -- `admission.wait_queue_length.kv-stores.bulk-normal-pri` - `admission.wait_queue_length.kv-stores.high-pri` - `admission.wait_queue_length.kv-stores.locking-normal-pri` - `admission.wait_queue_length.kv-stores.normal-pri` -- `admission.wait_queue_length.kv-stores.ttl-low-pri` - `admission.wait_queue_length.kv.high-pri` - `admission.wait_queue_length.kv.locking-normal-pri` - `admission.wait_queue_length.kv.normal-pri` @@ -993,6 +1125,10 @@ SERVER: n/a - `gcbytesage` - `gossip.bytes.received` - `gossip.bytes.sent` +- `gossip.callbacks.pending` +- `gossip.callbacks.pending_duration` +- `gossip.callbacks.processed` +- `gossip.callbacks.processing_duration` - `gossip.connections.incoming` - `gossip.connections.outgoing` - `gossip.connections.refused` @@ -1023,6 +1159,7 @@ SERVER: n/a - `kv.closed_timestamp.max_behind_nanos` - `kv.concurrency.avg_lock_hold_duration_nanos` - `kv.concurrency.avg_lock_wait_duration_nanos` +- `kv.concurrency.latch_conflict_wait_durations` - `kv.concurrency.lock_wait_queue_waiters` - `kv.concurrency.locks` - `kv.concurrency.locks_with_wait_queues` @@ -1058,6 +1195,8 @@ SERVER: n/a - `kv.replica_read_batch_evaluate.latency` - `kv.replica_read_batch_evaluate.without_interleaving_iter` - `kv.replica_write_batch_evaluate.latency` +- `kv.split.estimated_stats` +- `kv.split.total_bytes_estimates` - `kv.tenant_rate_limit.current_blocked` - `kv.tenant_rate_limit.num_tenants` - `kv.tenant_rate_limit.read_batches_admitted` @@ -1156,6 +1295,11 @@ SERVER: n/a - `queue.gc.process.failure` - `queue.gc.process.success` - `queue.gc.processingnanos` +- `queue.lease.pending` +- `queue.lease.process.failure` +- `queue.lease.process.success` +- `queue.lease.processingnanos` +- `queue.lease.purgatory` - `queue.merge.pending` - `queue.merge.process.failure` - `queue.merge.process.success` @@ -1222,6 +1366,7 @@ SERVER: n/a - `queue.tsmaintenance.process.failure` - `queue.tsmaintenance.process.success` - `queue.tsmaintenance.processingnanos` +- `raft.commands.pending` - `raft.commands.proposed` - `raft.commands.reproposed.new-lai` - `raft.commands.reproposed.unchanged` @@ -1234,6 +1379,8 @@ SERVER: n/a - `raft.entrycache.read_bytes` - `raft.entrycache.size` - `raft.heartbeats.pending` +- `raft.loaded_entries.bytes` +- `raft.loaded_entries.reserved.bytes` - `raft.process.applycommitted.latency` - `raft.process.commandcommit.latency` - `raft.process.handleready.latency` @@ -1265,6 +1412,7 @@ SERVER: n/a - `raft.sent.bytes` - `raft.sent.cross_region.bytes` - `raft.sent.cross_zone.bytes` +- `raft.storage.error` - `raft.storage.read_bytes` - `raft.ticks` - `raft.timeoutcampaign` @@ -1314,6 +1462,8 @@ SERVER: n/a - `range.snapshots.sent-bytes` - `range.snapshots.unknown.rcvd-bytes` - `range.snapshots.unknown.sent-bytes` +- `range.snapshots.upreplication.rcvd-bytes` +- `range.snapshots.upreplication.sent-bytes` - `range.splits` - `rangekeybytes` - `rangekeycount` @@ -1390,6 +1540,7 @@ SERVER: n/a - `rpc.method.initput.recv` - `rpc.method.isspanempty.recv` - `rpc.method.leaseinfo.recv` +- `rpc.method.linkexternalsstable.recv` - `rpc.method.merge.recv` - `rpc.method.migrate.recv` - `rpc.method.probe.recv` @@ -1416,8 +1567,6 @@ SERVER: n/a - `rpc.method.writebatch.recv` - `rpc.streams.mux_rangefeed.active` - `rpc.streams.mux_rangefeed.recv` -- `rpc.streams.rangefeed.active` -- `rpc.streams.rangefeed.recv` - `spanconfig.kvsubscriber.oldest_protected_record_nanos` - `spanconfig.kvsubscriber.protected_record_count` - `spanconfig.kvsubscriber.update_behind_nanos` @@ -1429,12 +1578,28 @@ SERVER: n/a - `storage.batch-commit.sem-wait.duration` - `storage.batch-commit.wal-queue-wait.duration` - `storage.batch-commit.wal-rotation.duration` +- `storage.block-load.active` +- `storage.block-load.queued` +- `storage.category-pebble-manifest.bytes-written` +- `storage.category-pebble-wal.bytes-written` +- `storage.category-unspecified.bytes-written` - `storage.checkpoints` - `storage.compactions.duration` - `storage.compactions.keys.pinned.bytes` - `storage.compactions.keys.pinned.count` - `storage.disk-slow` - `storage.disk-stalled` +- `storage.disk.io.time` +- `storage.disk.iopsinprogress` +- `storage.disk.read-max.bytespersecond` +- `storage.disk.read.bytes` +- `storage.disk.read.count` +- `storage.disk.read.time` +- `storage.disk.weightedio.time` +- `storage.disk.write-max.bytespersecond` +- `storage.disk.write.bytes` +- `storage.disk.write.count` +- `storage.disk.write.time` - `storage.flush.ingest.count` - `storage.flush.ingest.table.bytes` - `storage.flush.ingest.table.count` @@ -1489,8 +1654,17 @@ SERVER: n/a - `storage.shared-storage.write` - `storage.single-delete.ineffectual` - `storage.single-delete.invariant-violation` +- `storage.sstable.compression.none.count` +- `storage.sstable.compression.snappy.count` +- `storage.sstable.compression.unknown.count` +- `storage.sstable.compression.zstd.count` +- `storage.sstable.zombie.bytes` - `storage.wal.bytes_in` - `storage.wal.bytes_written` +- `storage.wal.failover.primary.duration` +- `storage.wal.failover.secondary.duration` +- `storage.wal.failover.switch.count` +- `storage.wal.failover.write_and_sync.latency` - `storage.wal.fsync.latency` - `storage.write-stall-nanos` - `storage.write-stalls` @@ -1516,14 +1690,14 @@ SERVER: n/a - `tscache.skl.pages` - `tscache.skl.rotations` - `txn.commit_waits.before_commit_trigger` -- `txn.server_side.1PC.failure` -- `txn.server_side.1PC.success` - `txn.server_side_retry.read_evaluation.failure` - `txn.server_side_retry.read_evaluation.success` - `txn.server_side_retry.uncertainty_interval_error.failure` - `txn.server_side_retry.uncertainty_interval_error.success` - `txn.server_side_retry.write_evaluation.failure` - `txn.server_side_retry.write_evaluation.success` +- `txn.server_side.1PC.failure` +- `txn.server_side.1PC.success` - `txnrecovery.attempts.pending` - `txnrecovery.attempts.total` - `txnrecovery.failures` diff --git a/src/current/v24.2/cluster-virtualization-setting-scopes.md b/src/current/v24.2/cluster-virtualization-setting-scopes.md index 3f4245c117e..f6fcc6658b7 100644 --- a/src/current/v24.2/cluster-virtualization-setting-scopes.md +++ b/src/current/v24.2/cluster-virtualization-setting-scopes.md @@ -18,14 +18,14 @@ When [cluster virtualization]({% link {{ page.version.version }}/cluster-virtual - When a cluster setting is system-visible, it can be set only from the system virtual cluster but can be queried from any virtual cluster. For example, a virtual cluster can query a system-visible cluster setting's value, such as `storage.max_sync_duration`, to help adapt to the CockroachDB cluster's configuration. {% comment %} -Src: cockroach gen settings-list --show-class --show-format against v23.2.0-rc.2 +Src: cockroach gen metrics-list --format=csv against cockroach-v24.2.0-rc.1.darwin-10.9-amd64 Also saved in https://docs.google.com/spreadsheets/d/1HIalzAhwU0CEYzSuG2m1aXSJRpiIyQPJdt8SusHpJ_U/edit?usp=sharing -(shared CRL-internal). There is a filter-view on the Class column: +(shared CRL-internal). Sort by the Class column, then Settings column, and paste into the correct section below. application: Scoped to a virtual cluster -system virtual cluster: Scoped to the system virtual cluster -system visible: Can be set / modified only from the system virtual cluster, but can be viewed from a VC +system-only: Scoped to the system virtual cluster +system-visible: Can be set / modified only from the system virtual cluster, but can be viewed from a VC {% endcomment %} ## Cluster settings scoped to a virtual cluster @@ -45,8 +45,8 @@ system visible: Can be set / modified only from the system virtual cluster, but - `changefeed.aggregator.flush_jitter` - `changefeed.backfill.concurrent_scan_requests` - `changefeed.backfill.scan_request_size` -- `changefeed.balance_range_distribution.enabled` -- `changefeed.batch_reduction_retry.enabled` +- `changefeed.batch_reduction_retry.enabled (alias: changefeed.batch_reduction_retry_enabled)` +- `changefeed.default_range_distribution_strategy` - `changefeed.event_consumer_worker_queue_size` - `changefeed.event_consumer_workers` - `changefeed.fast_gzip.enabled` @@ -54,8 +54,8 @@ system visible: Can be set / modified only from the system virtual cluster, but - `changefeed.memory.per_changefeed_limit` - `changefeed.min_highwater_advance` - `changefeed.node_throttle_config` -- `changefeed.protect_timestamp.max_age` - `changefeed.protect_timestamp_interval` +- `changefeed.protect_timestamp.max_age` - `changefeed.schema_feed.read_with_priority_after` - `changefeed.sink_io_workers` - `cloudstorage.azure.concurrent_upload_buffers` @@ -63,6 +63,7 @@ system visible: Can be set / modified only from the system virtual cluster, but - `cloudstorage.timeout` - `cluster.auto_upgrade.enabled` - `cluster.preserve_downgrade_option` +- `debug.zip.redact_addresses.enabled` - `diagnostics.forced_sql_stat_reset.interval` - `diagnostics.reporting.enabled` - `diagnostics.reporting.interval` @@ -76,11 +77,21 @@ system visible: Can be set / modified only from the system virtual cluster, but - `feature.schema_change.enabled` - `feature.stats.enabled` - `jobs.retention_time` +- `kv.dist_sender.circuit_breaker.cancellation.enabled` +- `kv.dist_sender.circuit_breaker.cancellation.write_grace_period` +- `kv.dist_sender.circuit_breaker.probe.interval` +- `kv.dist_sender.circuit_breaker.probe.threshold` +- `kv.dist_sender.circuit_breaker.probe.timeout` +- `kv.dist_sender.circuit_breakers.mode` - `kv.rangefeed.client.stream_startup_rate` -- `kv.rangefeed.range_stuck_threshold` - `kv.transaction.max_intents_bytes` - `kv.transaction.max_refresh_spans_bytes` +- `kv.transaction.randomized_anchor_key.enabled` - `kv.transaction.reject_over_max_intents_budget.enabled` +- `kv.transaction.write_pipelining.enabled (alias: kv.transaction.write_pipelining_enabled)` +- `kv.transaction.write_pipelining.locking_reads.enabled` +- `kv.transaction.write_pipelining.max_batch_size (alias: kv.transaction.write_pipelining_max_batch_size)` +- `kv.transaction.write_pipelining.ranged_writes.enabled` - `schedules.backup.gc_protection.enabled` - `security.ocsp.mode` - `security.ocsp.timeout` @@ -89,7 +100,7 @@ system visible: Can be set / modified only from the system virtual cluster, but - `server.authentication_cache.enabled` - `server.child_metrics.enabled` - `server.client_cert_expiration_cache.capacity` -- `server.clock.forward_jump_check.enabled` +- `server.clock.forward_jump_check.enabled (alias: server.clock.forward_jump_check_enabled)` - `server.clock.persist_upper_bound_interval` - `server.eventlog.enabled` - `server.eventlog.ttl` @@ -101,20 +112,25 @@ system visible: Can be set / modified only from the system virtual cluster, but - `server.log_gc.max_deletions_per_cycle` - `server.log_gc.period` - `server.max_connections_per_gateway` -- `server.oidc_authentication.autologin.enabled` +- `server.max_open_transactions_per_gateway` +- `server.oidc_authentication.autologin.enabled (alias: server.oidc_authentication.autologin)` - `server.oidc_authentication.button_text` - `server.oidc_authentication.claim_json_key` - `server.oidc_authentication.client_id` - `server.oidc_authentication.client_secret` +- `server.oidc_authentication.client.timeout` - `server.oidc_authentication.enabled` - `server.oidc_authentication.principal_regex` - `server.oidc_authentication.provider_url` - `server.oidc_authentication.redirect_url` - `server.oidc_authentication.scopes` -- `server.shutdown.connections.timeout` -- `server.shutdown.initial_wait` -- `server.shutdown.jobs.timeout` -- `server.shutdown.transactions.timeout` +- `server.redact_sensitive_settings.enabled` +- `server.shutdown.connections.timeout (alias: server.shutdown.connection_wait)` +- `server.shutdown.initial_wait (alias: server.shutdown.drain_wait)` +- `server.shutdown.jobs.timeout (alias: server.shutdown.jobs_wait)` +- `server.shutdown.transactions.timeout (alias: server.shutdown.query_wait)` +- `server.sql_tcp_keep_alive.count` +- `server.sql_tcp_keep_alive.interval` - `server.time_until_store_dead` - `server.user_login.cert_password_method.auto_scram_promotion.enabled` - `server.user_login.downgrade_scram_stored_passwords_to_bcrypt.enabled` @@ -126,14 +142,17 @@ system visible: Can be set / modified only from the system virtual cluster, but - `server.user_login.timeout` - `server.user_login.upgrade_bcrypt_stored_passwords_to_scram.enabled` - `server.web_session.purge.ttl` -- `server.web_session.timeout` +- `server.web_session.timeout (alias: server.web_session_timeout)` - `sql.auth.change_own_password.enabled` +- `sql.auth.grant_option_for_owner.enabled` +- `sql.auth.grant_option_inheritance.enabled` - `sql.auth.public_schema_create_privilege.enabled` - `sql.auth.resolve_membership_single_scan.enabled` - `sql.closed_session_cache.capacity` - `sql.closed_session_cache.time_to_live` - `sql.contention.event_store.capacity` - `sql.contention.event_store.duration_threshold` +- `sql.contention.record_serialization_conflicts.enabled` - `sql.contention.txn_id_cache.max_size` - `sql.cross_db_fks.enabled` - `sql.cross_db_sequence_owners.enabled` @@ -184,12 +203,14 @@ system visible: Can be set / modified only from the system virtual cluster, but - `sql.guardrails.max_row_size_err` - `sql.guardrails.max_row_size_log` - `sql.hash_sharded_range_pre_split.max` +- `sql.index_recommendation.drop_unused_duration` - `sql.insights.anomaly_detection.enabled` - `sql.insights.anomaly_detection.latency_threshold` - `sql.insights.anomaly_detection.memory_limit` - `sql.insights.execution_insights_capacity` - `sql.insights.high_retry_count.threshold` - `sql.insights.latency_threshold` +- `sql.log.all_statements.enabled (alias: sql.trace.log_statement_execute)` - `sql.log.slow_query.experimental_full_table_scans.enabled` - `sql.log.slow_query.internal_queries.enabled` - `sql.log.slow_query.latency_threshold` @@ -200,7 +221,7 @@ system visible: Can be set / modified only from the system virtual cluster, but - `sql.metrics.max_mem_reported_txn_fingerprints` - `sql.metrics.max_mem_stmt_fingerprints` - `sql.metrics.max_mem_txn_fingerprints` -- `sql.metrics.statement_details.dump_to_logs.enabled` +- `sql.metrics.statement_details.dump_to_logs.enabled (alias: sql.metrics.statement_details.dump_to_logs)` - `sql.metrics.statement_details.enabled` - `sql.metrics.statement_details.gateway_node.enabled` - `sql.metrics.statement_details.index_recommendation_collection.enabled` @@ -213,7 +234,6 @@ system visible: Can be set / modified only from the system virtual cluster, but - `sql.multiregion.drop_primary_region.enabled` - `sql.notices.enabled` - `sql.optimizer.uniqueness_checks_for_gen_random_uuid.enabled` -- `sql.show_ranges_deprecated_behavior.enabled` - `sql.spatial.experimental_box2d_comparison_operators.enabled` - `sql.stats.activity.persisted_rows.max` - `sql.stats.automatic_collection.enabled` @@ -223,6 +243,9 @@ system visible: Can be set / modified only from the system virtual cluster, but - `sql.stats.flush.enabled` - `sql.stats.flush.interval` - `sql.stats.forecasts.enabled` +- `sql.stats.forecasts.max_decrease` +- `sql.stats.forecasts.min_goodness_of_fit` +- `sql.stats.forecasts.min_observations` - `sql.stats.histogram_buckets.count` - `sql.stats.histogram_collection.enabled` - `sql.stats.histogram_samples.count` @@ -232,27 +255,29 @@ system visible: Can be set / modified only from the system virtual cluster, but - `sql.stats.post_events.enabled` - `sql.stats.response.max` - `sql.stats.response.show_internal.enabled` -- `sql.stats.system_tables.enabled` - `sql.stats.system_tables_autostats.enabled` +- `sql.stats.system_tables.enabled` +- `sql.stats.virtual_computed_columns.enabled` - `sql.telemetry.query_sampling.enabled` - `sql.telemetry.query_sampling.internal.enabled` - `sql.telemetry.query_sampling.max_event_frequency` +- `sql.telemetry.query_sampling.mode` +- `sql.telemetry.transaction_sampling.max_event_frequency` +- `sql.telemetry.transaction_sampling.statement_events_per_transaction.max` - `sql.temp_object_cleaner.cleanup_interval` - `sql.temp_object_cleaner.wait_interval` -- `sql.log.all_statements.enabled` -- `sql.trace.session_eventlog.enabled` - `sql.trace.stmt.enable_threshold` - `sql.trace.txn.enable_threshold` +- `sql.ttl.changefeed_replication.disabled` - `sql.ttl.default_delete_batch_size` - `sql.ttl.default_delete_rate_limit` - `sql.ttl.default_select_batch_size` - `sql.ttl.default_select_rate_limit` - `sql.ttl.job.enabled` -- `sql.txn.read_committed_isolation.enabled` - `sql.txn_fingerprint_id_cache.capacity` +- `sql.txn.read_committed_isolation.enabled` - `storage.max_sync_duration.fatal.enabled` -- `storage.value_blocks.enabled` -- `trace.debug_http_endpoint.enabled` +- `trace.debug_http_endpoint.enabled (alias: trace.debug.enable)` - `trace.opentelemetry.collector` - `trace.snapshot.rate` - `trace.span_registry.enabled` @@ -262,23 +287,24 @@ system visible: Can be set / modified only from the system virtual cluster, but ## Cluster settings scoped to the system virtual cluster -{% comment %}Class=system virtual cluster{% endcomment %} +{% comment %}Class=system-only{% endcomment %} - `admission.disk_bandwidth_tokens.elastic.enabled` - `admission.kv.enabled` -- `physical_replication.consumer.minimum_flush_interval` - `kv.allocator.lease_rebalance_threshold` - `kv.allocator.load_based_lease_rebalancing.enabled` - `kv.allocator.load_based_rebalancing` -- `kv.allocator.load_based_rebalancing.objective` - `kv.allocator.load_based_rebalancing_interval` +- `kv.allocator.load_based_rebalancing.objective` - `kv.allocator.qps_rebalance_threshold` - `kv.allocator.range_rebalance_threshold` - `kv.allocator.store_cpu_rebalance_threshold` - `kv.bulk_io_write.max_rate` - `kv.bulk_sst.max_allowed_overage` +- `kv.lease_transfer_read_summary.global_budget` +- `kv.lease_transfer_read_summary.local_budget` - `kv.log_range_and_node_events.enabled` -- `kv.range_split.by_load.enabled` +- `kv.range_split.by_load.enabled (alias: kv.range_split.by_load_enabled)` - `kv.range_split.load_cpu_threshold` - `kv.range_split.load_qps_threshold` - `kv.replica_circuit_breaker.slow_replication_threshold` @@ -287,14 +313,16 @@ system visible: Can be set / modified only from the system virtual cluster, but - `kv.snapshot_rebalance.max_rate` - `kv.snapshot_receiver.excise.enabled` - `kvadmission.store.provisioned_bandwidth` +- `physical_replication.consumer.minimum_flush_interval (alias: bulkio.stream_ingestion.minimum_flush_interval)` - `server.consistency_check.max_rate` - `server.rangelog.ttl` -- `server.shutdown.lease_transfer_iteration.timeout` +- `server.shutdown.lease_transfer_iteration.timeout (alias: server.shutdown.lease_transfer_wait)` - `spanconfig.bounds.enabled` -- `spanconfig.range_coalescing.system.enabled` -- `spanconfig.range_coalescing.application.enabled` +- `spanconfig.range_coalescing.application.enabled (alias: spanconfig.tenant_coalesce_adjacent.enabled)` +- `spanconfig.range_coalescing.system.enabled (alias: spanconfig.storage_coalesce_adjacent.enabled)` - `storage.experimental.eventually_file_only_snapshots.enabled` - `storage.ingest_split.enabled` +- `storage.wal_failover.unhealthy_op_threshold` - `timeseries.storage.enabled` ## System-visible cluster settings @@ -306,15 +334,19 @@ system visible: Can be set / modified only from the system virtual cluster, but - `diagnostics.memory_monitoring_dumps.enabled` - `enterprise.license` - `kv.bulk_sst.target_size` -- `kv.closed_timestamp.follower_reads.enabled` +- `kv.closed_timestamp.follower_reads.enabled (alias: kv.closed_timestamp.follower_reads_enabled)` - `kv.closed_timestamp.lead_for_global_reads_override` - `kv.closed_timestamp.side_transport_interval` - `kv.closed_timestamp.target_duration` - `kv.protectedts.reconciliation.interval` - `kv.rangefeed.closed_timestamp_refresh_interval` - `kv.rangefeed.enabled` +- `security.client_cert.subject_required.enabled` - `sql.schema.telemetry.recurrence` - `storage.max_sync_duration` +- `storage.sstable.compression_algorithm` +- `storage.sstable.compression_algorithm_backup_storage` +- `storage.sstable.compression_algorithm_backup_transport` - `timeseries.storage.resolution_10s.ttl` - `timeseries.storage.resolution_30m.ttl`