Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
109074: settings,*: give better names to certain settings r=stevendanna,ericharmeling a=knz

Fixes #109046.

Now we have a framework that allows us to rename cluster settings
while preserving backward-compatibility, we can clean up the settings
whose name didn't pass the linter, and had been "grand-fathered". This
also simplifies the linter.

The following have been renamed:

| Previous name                                  | New name                                           |
|------------------------------------------------|----------------------------------------------------|
| `kv.raft_log.disable_synchronization_unsafe`   | `kv.raft_log.synchronization.disabled`             |
| `sql.trace.log_statement_execute`              | `sql.log.all_statements.enabled`                   |
| `cloudstorage.gs.chunking.retry_timeout`       | `cloudstorage.gs.chunking.per_chunk_retry.timeout` |
| `trace.debug.enable`                           | `trace.http_debug_endpoint.enabled`                |
| `bulkio.restore.memory_monitor_ssts`           | `bulkio.restore.sst_memory_limit.enabled`          |
| `bulkio.restore.use_simple_import_spans`       | `bulkio.restore.simple_import_spans.enabled`       |
| `bulkio.backup.export_request_verbose_tracing` | `bulkio.backup.verbose_tracing.enabled`            |
| `changefeed.idle_timeout`                      | `changefeed.auto_idle.timeout`                     |

The following name suffixes have been adjusted to follow our linter
guidelines:

```
bulkio.backup.split_keys_on_timestamps - added .enabled
changefeed.balance_range_distribution.enable - renamed to .enabled
changefeed.batch_reduction_retry_enabled - renamed to .enabled
changefeed.new_pubsub_sink_enabled - renamed to .enabled
changefeed.new_webhook_sink_enabled - renamed to .enabled
changefeed.permissions.require_external_connection_sink - added .enabled
debug.panic_on_failed_assertions - added .enabled
diagnostics.reporting.send_crash_reports - added .enabled
kv.closed_timestamp.follower_reads_enabled - renamed to .enabled
kv.range_merge.queue_enabled - renamed to .enabled
kv.range_split.by_load_enabled - renamed to .enabled
kv.transaction.parallel_commits_enabled - renamed to .enabled
kv.transaction.write_pipelining_enabled - renamed to .enabled
kv.transaction.write_pipelining_max_batch_size - renamed to .max_batch_size
server.clock.forward_jump_check_enabled - renamed to .enabled
server.oidc_authentication.autologin - added .enabled
server.web_session_timeout - renamed to .timeout
sql.distsql.flow_stream_timeout - renamed to .timeout
sql.metrics.statement_details.dump_to_logs - added .enabled
stream_replication.job_liveness_timeout - renamed to .timeout
```

Release note (cli change): The following user-visible cluster settings
have been renamed. The previous name is still available for backward
compatibility.

| Previous name                                  | New name                                             |
|------------------------------------------------|------------------------------------------------------|
| `server.web_session_timeout`                   | `server.web_session.timeout`                         |
| `kv.closed_timestamp.follower_reads_enabled`   | `kv.closed_timestamp.follower_reads.enabled`         |
| `kv.range_split.by_load_enabled`               | `kv.range_split.by_load.enabled`                     |
| `changefeed.balance_range_distribution.enable` | `changefeed.balance_range_distribution.enabled`      |
| `changefeed.batch_reduction_retry_enabled`     | `changefeed.batch_reduction_retry.enabled`           |
| `server.clock.forward_jump_check_enabled`      | `server.clock.forward_jump_check.enabled`            |
| `server.oidc_authentication.autologin`         | `server.oidc_authentication.autologin.enabled`       |
| `sql.metrics.statement_details.dump_to_logs`   | `sql.metrics.statement_details.dump_to_logs.enabled` |
| `sql.trace.log_statement_execute`              | `sql.log.all_statements.enabled`                     |
| `trace.debug.enable`                           | `trace.http_debug_endpoint.enabled`                  |

Epic: CRDB-28893

109147: roachprod: remove references to `andrei-jepsen` r=srosenberg a=rickystewart

This GCP project was deleted.

Epic: none
Release note: None

Co-authored-by: Raphael 'kena' Poss <[email protected]>
Co-authored-by: Ricky Stewart <[email protected]>
  • Loading branch information
3 people committed Aug 21, 2023
3 parents eb78af2 + f3cf1e7 + fb92edc commit 4698cfe
Show file tree
Hide file tree
Showing 82 changed files with 230 additions and 211 deletions.
2 changes: 1 addition & 1 deletion docs/RFCS/20181227_follower_reads_implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ timestamp for use with an `AS OF SYSTEM TIME` query, this RFC introduces a new
SQL function `follower_read_timestamp()` which is effectively a syntactic
short-hand for multiplying the above mentioned cluster settings then extends `AS
OF SYSTEM TIME` to allow for a non-constant expression. After this change and
the enabling of `kv.closed_timestamp.follower_reads_enabled` clients can
the enabling of `kv.closed_timestamp.follower_reads.enabled` clients can
trivially encourage their `SELECT` statements to be directed to physically close
replicas. For example, imagine that the kv.kv table exists, the below query
would perform a read against the nearest replica:
Expand Down
2 changes: 1 addition & 1 deletion docs/RFCS/20211106_multitenant_cluster_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Beyond the obvious usability issues, there are important functional gaps:

- in certain cases tenant code may need to consult values for cluster settings
that apply to the host cluster: for example
`kv.closed_timestamp.follower_reads_enabled` applies to the KV subsystem but
`kv.closed_timestamp.follower_reads.enabled` applies to the KV subsystem but
is read by the SQL code when serving queries.

### Note on SQL settings
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/eventlog.md
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ Events in this category are logged to the `SQL_EXEC` channel.
### `query_execute`

An event of type `query_execute` is recorded when a query is executed,
and the cluster setting `sql.trace.log_statement_execute` is set.
and the cluster setting `sql.log.all_statements.enabled` is set.



Expand Down
2 changes: 1 addition & 1 deletion docs/generated/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ The `SQL_EXEC` channel is used to report SQL execution on
behalf of client connections:

- Logical SQL statement executions (when enabled via the
`sql.trace.log_statement_execute` [cluster setting](cluster-settings.html))
`sql.log.all_statements.enabled` [cluster setting](cluster-settings.html))
- uncaught Go panic errors during the execution of a SQL statement.

### `SQL_PERF`
Expand Down
16 changes: 8 additions & 8 deletions docs/generated/settings/settings-for-tenants.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ bulkio.backup.read_with_priority_after duration 1m0s amount of time since the re
bulkio.stream_ingestion.minimum_flush_interval duration 5s the minimum timestamp between flushes; flushes may still occur if internal buffers fill up tenant-rw
changefeed.backfill.concurrent_scan_requests integer 0 number of concurrent scan requests per node issued during a backfill tenant-rw
changefeed.backfill.scan_request_size integer 524288 the maximum number of bytes returned by each scan request tenant-rw
changefeed.balance_range_distribution.enable boolean false if enabled, the ranges are balanced equally among all nodes tenant-rw
changefeed.batch_reduction_retry_enabled boolean false if true, kafka changefeeds upon erroring on an oversized batch will attempt to resend the messages with progressively lower batch sizes tenant-rw
changefeed.balance_range_distribution.enabled boolean false if enabled, the ranges are balanced equally among all nodes tenant-rw
changefeed.batch_reduction_retry.enabled boolean false if true, kafka changefeeds upon erroring on an oversized batch will attempt to resend the messages with progressively lower batch sizes tenant-rw
changefeed.event_consumer_worker_queue_size integer 16 if changefeed.event_consumer_workers is enabled, this setting sets the maxmimum number of events which a worker can buffer tenant-rw
changefeed.event_consumer_workers integer 0 the number of workers to use when processing events: <0 disables, 0 assigns a reasonable default, >0 assigns the setting value. for experimental/core changefeeds and changefeeds using parquet format, this is disabled tenant-rw
changefeed.fast_gzip.enabled boolean true use fast gzip implementation tenant-rw
Expand Down Expand Up @@ -58,7 +58,7 @@ server.auth_log.sql_sessions.enabled boolean false if set, log SQL session login
server.authentication_cache.enabled boolean true enables a cache used during authentication to avoid lookups to system tables when retrieving per-user authentication-related information tenant-rw
server.child_metrics.enabled boolean false enables the exporting of child metrics, additional prometheus time series with extra labels tenant-rw
server.client_cert_expiration_cache.capacity integer 1000 the maximum number of client cert expirations stored tenant-rw
server.clock.forward_jump_check_enabled boolean false if enabled, forward clock jumps > max_offset/2 will cause a panic tenant-rw
server.clock.forward_jump_check.enabled boolean false if enabled, forward clock jumps > max_offset/2 will cause a panic tenant-rw
server.clock.persist_upper_bound_interval duration 0s the interval between persisting the wall time upper bound of the clock. The clock does not generate a wall time greater than the persisted timestamp and will panic if it sees a wall time greater than this value. When cockroach starts, it waits for the wall time to catch-up till this persisted timestamp. This guarantees monotonic wall time across server restarts. Not setting this or setting a value of 0 disables this feature. tenant-rw
server.eventlog.enabled boolean true if set, logged notable events are also stored in the table system.eventlog tenant-rw
server.eventlog.ttl duration 2160h0m0s if nonzero, entries in system.eventlog older than this duration are periodically purged tenant-rw
Expand All @@ -69,7 +69,7 @@ server.identity_map.configuration string system-identity to database-username m
server.log_gc.max_deletions_per_cycle integer 1000 the maximum number of entries to delete on each purge of log-like system tables tenant-rw
server.log_gc.period duration 1h0m0s the period at which log-like system tables are checked for old entries tenant-rw
server.max_connections_per_gateway integer -1 the maximum number of SQL connections per gateway allowed at a given time (note: this will only limit future connection attempts and will not affect already established connections). Negative values result in unlimited number of connections. Superusers are not affected by this limit. tenant-rw
server.oidc_authentication.autologin boolean false if true, logged-out visitors to the DB Console will be automatically redirected to the OIDC login endpoint tenant-rw
server.oidc_authentication.autologin.enabled boolean false if true, logged-out visitors to the DB Console will be automatically redirected to the OIDC login endpoint tenant-rw
server.oidc_authentication.button_text string Log in with your OIDC provider text to show on button on DB Console login page to login with your OIDC provider (only shown if OIDC is enabled) tenant-rw
server.oidc_authentication.claim_json_key string sets JSON key of principal to extract from payload after OIDC authentication completes (usually email or sid) tenant-rw
server.oidc_authentication.client_id string sets OIDC client id tenant-rw
Expand All @@ -95,7 +95,7 @@ server.user_login.rehash_scram_stored_passwords_on_cost_change.enabled boolean t
server.user_login.timeout duration 10s timeout after which client authentication times out if some system range is unavailable (0 = no timeout) tenant-rw
server.user_login.upgrade_bcrypt_stored_passwords_to_scram.enabled boolean true if server.user_login.password_encryption=scram-sha-256, this controls whether to automatically re-encode stored passwords using crdb-bcrypt to scram-sha-256 tenant-rw
server.web_session.purge.ttl duration 1h0m0s if nonzero, entries in system.web_sessions older than this duration are periodically purged tenant-rw
server.web_session_timeout duration 168h0m0s the duration that a newly created web session will be valid tenant-rw
server.web_session.timeout duration 168h0m0s the duration that a newly created web session will be valid tenant-rw
sql.auth.change_own_password.enabled boolean false controls whether a user is allowed to change their own password, even if they have no other privileges tenant-rw
sql.auth.public_schema_create_privilege.enabled boolean true determines whether to grant all users the CREATE privileges on the public schema when it is created tenant-rw
sql.auth.resolve_membership_single_scan.enabled boolean true determines whether to populate the role membership cache with a single scan tenant-rw
Expand Down Expand Up @@ -250,7 +250,7 @@ sql.metrics.max_mem_reported_stmt_fingerprints integer 100000 the maximum number
sql.metrics.max_mem_reported_txn_fingerprints integer 100000 the maximum number of reported transaction fingerprints stored in memory tenant-rw
sql.metrics.max_mem_stmt_fingerprints integer 100000 the maximum number of statement fingerprints stored in memory tenant-rw
sql.metrics.max_mem_txn_fingerprints integer 100000 the maximum number of transaction fingerprints stored in memory tenant-rw
sql.metrics.statement_details.dump_to_logs boolean false dump collected statement statistics to node logs when periodically cleared tenant-rw
sql.metrics.statement_details.dump_to_logs.enabled boolean false dump collected statement statistics to node logs when periodically cleared tenant-rw
sql.metrics.statement_details.enabled boolean true collect per-statement query statistics tenant-rw
sql.metrics.statement_details.gateway_node.enabled boolean true save the gateway node for each statement fingerprint. If false, the value will be stored as 0. tenant-rw
sql.metrics.statement_details.index_recommendation_collection.enabled boolean true generate an index recommendation for each fingerprint ID tenant-rw
Expand Down Expand Up @@ -289,7 +289,7 @@ sql.telemetry.query_sampling.enabled boolean false when set to true, executed qu
sql.telemetry.query_sampling.internal.enabled boolean false when set to true, internal queries will be sampled in telemetry logging tenant-rw
sql.temp_object_cleaner.cleanup_interval duration 30m0s how often to clean up orphaned temporary objects tenant-rw
sql.temp_object_cleaner.wait_interval duration 30m0s how long after creation a temporary object will be cleaned up tenant-rw
sql.trace.log_statement_execute boolean false set to true to enable logging of executed statements tenant-rw
sql.log.all_statements.enabled boolean false set to true to enable logging of all executed statements tenant-rw
sql.trace.session_eventlog.enabled boolean false set to true to enable session tracing; note that enabling this may have a negative performance impact tenant-rw
sql.trace.stmt.enable_threshold duration 0s enables tracing on all statements; statements executing for longer than this duration will have their trace logged (set to 0 to disable); note that enabling this may have a negative performance impact; this setting applies to individual statements within a transaction and is therefore finer-grained than sql.trace.txn.enable_threshold tenant-rw
sql.trace.txn.enable_threshold duration 0s enables tracing on all transactions; transactions open for longer than this duration will have their trace logged (set to 0 to disable); note that enabling this may have a negative performance impact; this setting is coarser-grained than sql.trace.stmt.enable_threshold because it applies to all statements within a transaction as well as client communication (e.g. retries) tenant-rw
Expand All @@ -303,7 +303,7 @@ storage.max_sync_duration.fatal.enabled boolean true if true, fatal the process
timeseries.storage.enabled boolean true if set, periodic timeseries data is stored within the cluster; disabling is not recommended unless you are storing the data elsewhere tenant-rw
timeseries.storage.resolution_10s.ttl duration 240h0m0s the maximum age of time series data stored at the 10 second resolution. Data older than this is subject to rollup and deletion. tenant-rw
timeseries.storage.resolution_30m.ttl duration 2160h0m0s the maximum age of time series data stored at the 30 minute resolution. Data older than this is subject to deletion. tenant-rw
trace.debug.enable boolean false if set, traces for recent requests can be seen at https://<ui>/debug/requests tenant-rw
trace.debug_http_endpoint.enabled boolean false if set, traces for recent requests can be seen at https://<ui>/debug/requests tenant-rw
trace.jaeger.agent string the address of a Jaeger agent to receive traces using the Jaeger UDP Thrift protocol, as <host>:<port>. If no port is specified, 6381 will be used. tenant-rw
trace.opentelemetry.collector string address of an OpenTelemetry trace collector to receive traces using the otel gRPC protocol, as <host>:<port>. If no port is specified, 4317 will be used. tenant-rw
trace.snapshot.rate duration 0s if non-zero, interval at which background trace snapshots are captured tenant-rw
Expand Down
Loading

0 comments on commit 4698cfe

Please sign in to comment.