From 6699233ac2bae7659bca3fbe637dec53f65ebaf2 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 7 Aug 2025 15:52:19 -0500 Subject: [PATCH] DOC-5518 Added missing metrics_exporter_expose_bdb_name and expose_hostnames_for_all_suffixes to RS references for cluster_settings REST API object and rladmin tune cluster --- .../rs/7.4/references/rest-api/objects/cluster_settings.md | 1 + content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md | 2 ++ .../rs/7.8/references/rest-api/objects/cluster_settings.md | 2 ++ content/operate/rs/references/cli-utilities/rladmin/tune.md | 2 ++ .../operate/rs/references/rest-api/objects/cluster_settings.md | 2 ++ 5 files changed, 9 insertions(+) diff --git a/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md b/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md index c914673bdd..c346c225e6 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md +++ b/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md @@ -31,6 +31,7 @@ Cluster resources management policy | default_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default proxy_policy for newly created sharded databases' endpoints | | default_shards_placement | `dense`
`sparse` | Default shards_placement for a newly created databases | | endpoint_rebind_propagation_grace_time | integer | Time to wait between the addition and removal of a proxy | +| expose_hostnames_for_all_suffixes | boolean (default: false) | If true, enables exposing hostnames for non-default DNS suffixes | | failure_detection_sensitivity | `high`
`low` | Predefined thresholds and timeouts for failure detection (previously known as `watchdog_profile`)
• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover
• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) | | hide_user_data_from_log | boolean (default: false) | Set to `true` to enable the `hide-user-data-from-log` Redis configuration setting, which avoids logging user data | | login_lockout_counter_reset_after | integer | Number of seconds that must elapse between failed sign in attempts before the lockout counter is reset to 0. | diff --git a/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md b/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md index 4e9c6eed7f..e216eb498c 100644 --- a/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md +++ b/content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md @@ -34,6 +34,7 @@ rladmin tune cluster [ slave_ha_cooldown_period ] [ slave_ha_bdb_cooldown_period ] [ max_saved_events_per_type ] + [ metrics_exporter_expose_bdb_name { enabled | disabled } ] [ parallel_shards_upgrade ] [ default_concurrent_restore_actions ] [ show_internals { enabled | disabled } ] @@ -75,6 +76,7 @@ rladmin tune cluster | login_lockout_threshold | integer | Number of failed sign-in attempts to trigger locking a user account ("0" means never lock the account) | | max_saved_events_per_type | integer | Maximum number of events each type saved in CCS per object type | | max_simultaneous_backups | integer (default: 4) | Number of database backups allowed to run at the same time. Combines with `max_redis_forks` (set by [`tune node`](#tune-node)) to determine the number of shard backups allowed to run simultaneously. | +| metrics_exporter_expose_bdb_name | `enabled`
`disabled` | If enabled, adds a label with the database name to relevant metrics | | parallel_shards_upgrade | integer
`all` | Number of shards upgraded in parallel during DB upgrade (positive integer or "all") | | redis_migrate_node_threshold | size in MB | Memory (in MBs by default or can be specified) needed to migrate a database between nodes | | redis_migrate_node_threshold_percent | percentage | Memory (in percentage) needed to migrate a database between nodes | diff --git a/content/operate/rs/7.8/references/rest-api/objects/cluster_settings.md b/content/operate/rs/7.8/references/rest-api/objects/cluster_settings.md index f2a104e9c2..ae743b18cc 100644 --- a/content/operate/rs/7.8/references/rest-api/objects/cluster_settings.md +++ b/content/operate/rs/7.8/references/rest-api/objects/cluster_settings.md @@ -33,6 +33,7 @@ Cluster resources management policy | default_shards_placement | `dense`
`sparse` | Default shards_placement for a newly created databases | | default_tracking_table_max_keys_policy | integer (default: 1000000) | Defines the default value of the client-side caching invalidation table size for new databases. 0 makes the cache unlimited. | | endpoint_rebind_propagation_grace_time | integer | Time to wait between the addition and removal of a proxy | +| expose_hostnames_for_all_suffixes | boolean (default: false) | If true, enables exposing hostnames for non-default DNS suffixes | | failure_detection_sensitivity | `high`
`low` | Predefined thresholds and timeouts for failure detection (previously known as `watchdog_profile`)
• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover
• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) | | hide_user_data_from_log | boolean (default: false) | Set to `true` to enable the `hide-user-data-from-log` Redis configuration setting, which avoids logging user data | | login_lockout_counter_reset_after | integer | Number of seconds that must elapse between failed sign in attempts before the lockout counter is reset to 0. | @@ -40,6 +41,7 @@ Cluster resources management policy | login_lockout_threshold | integer | Number of failed sign in attempts allowed before locking a user account | | max_saved_events_per_type | integer | Maximum saved events per event type | | max_simultaneous_backups | integer (default: 4) | Maximum number of backup processes allowed at the same time | +| metrics_exporter_expose_bdb_name | boolean (default: false) | If true, adds a label with the database name to relevant metrics | | parallel_shards_upgrade | integer | Maximum number of shards to upgrade in parallel | | persistence_cleanup_scan_interval | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the Redis cleanup schedule | | persistent_node_removal | boolean | When removing a node, wait for persistence files to be created for all migrated shards | diff --git a/content/operate/rs/references/cli-utilities/rladmin/tune.md b/content/operate/rs/references/cli-utilities/rladmin/tune.md index 113333ef1a..84f7f05015 100644 --- a/content/operate/rs/references/cli-utilities/rladmin/tune.md +++ b/content/operate/rs/references/cli-utilities/rladmin/tune.md @@ -33,6 +33,7 @@ rladmin tune cluster [ slave_ha_cooldown_period ] [ slave_ha_bdb_cooldown_period ] [ max_saved_events_per_type ] + [ metrics_exporter_expose_bdb_name { enabled | disabled } ] [ parallel_shards_upgrade ] [ default_concurrent_restore_actions ] [ show_internals { enabled | disabled } ] @@ -74,6 +75,7 @@ rladmin tune cluster | login_lockout_threshold | integer | Number of failed sign-in attempts to trigger locking a user account ("0" means never lock the account) | | max_saved_events_per_type | integer | Maximum number of events each type saved in CCS per object type | | max_simultaneous_backups | integer (default: 4) | Number of database backups allowed to run at the same time. Combines with `max_redis_forks` (set by [`tune node`](#tune-node)) to determine the number of shard backups allowed to run simultaneously. | +| metrics_exporter_expose_bdb_name | `enabled`
`disabled` | If enabled, adds a label with the database name to relevant metrics | | parallel_shards_upgrade | integer
`all` | Number of shards upgraded in parallel during DB upgrade (positive integer or "all") | | redis_migrate_node_threshold | size in MB | Memory (in MBs by default or can be specified) needed to migrate a database between nodes | | redis_migrate_node_threshold_percent | percentage | Memory (in percentage) needed to migrate a database between nodes | diff --git a/content/operate/rs/references/rest-api/objects/cluster_settings.md b/content/operate/rs/references/rest-api/objects/cluster_settings.md index 9a4d169aac..af57acf357 100644 --- a/content/operate/rs/references/rest-api/objects/cluster_settings.md +++ b/content/operate/rs/references/rest-api/objects/cluster_settings.md @@ -34,6 +34,7 @@ Cluster resources management policy | default_shards_placement | `dense`
`sparse` | Default shards_placement for a newly created databases | | default_tracking_table_max_keys_policy | integer (default: 1000000) | Defines the default value of the client-side caching invalidation table size for new databases. 0 makes the cache unlimited. | | endpoint_rebind_propagation_grace_time | integer | Time to wait between the addition and removal of a proxy | +| expose_hostnames_for_all_suffixes | boolean (default: false) | If true, enables exposing hostnames for non-default DNS suffixes | | failure_detection_sensitivity | `high`
`low` | Predefined thresholds and timeouts for failure detection (previously known as `watchdog_profile`)
• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover
• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) | | hide_user_data_from_log | boolean (default: false) | Set to `true` to enable the `hide-user-data-from-log` Redis configuration setting, which avoids logging user data | | login_lockout_counter_reset_after | integer | Number of seconds that must elapse between failed sign in attempts before the lockout counter is reset to 0. | @@ -42,6 +43,7 @@ Cluster resources management policy | max_redis_forks | integer (default: 0) | Maximum number of background processes forked from shards that can exist on the node at any given time. 0 means unlimited. | | max_saved_events_per_type | integer | Maximum saved events per event type | | max_simultaneous_backups | integer (default: 4) | Maximum number of backup processes allowed at the same time | +| metrics_exporter_expose_bdb_name | boolean (default: false) | If true, adds a label with the database name to relevant metrics | | parallel_shards_upgrade | integer | Maximum number of shards to upgrade in parallel | | max_slave_full_syncs | integer (default: 0) | Maximum number of simultaneous replica full syncs that can run at any given time. 0 means unlimited. | | persistence_cleanup_scan_interval | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the Redis cleanup schedule |