Skip to content

Commit db42da0

Browse files
authored
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 (#1957)
1 parent f1bd96d commit db42da0

File tree

5 files changed

+9
-0
lines changed

5 files changed

+9
-0
lines changed

content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Cluster resources management policy
3131
| default_sharded_proxy_policy | `single`<br /><br />`all-master-shards`<br /><br />`all-nodes` | Default proxy_policy for newly created sharded databases' endpoints |
3232
| default_shards_placement | `dense`<br />`sparse` | Default shards_placement for a newly created databases |
3333
| endpoint_rebind_propagation_grace_time | integer | Time to wait between the addition and removal of a proxy |
34+
| expose_hostnames_for_all_suffixes | boolean (default: false) | If true, enables exposing hostnames for non-default DNS suffixes |
3435
| failure_detection_sensitivity | `high`<br />`low` | Predefined thresholds and timeouts for failure detection (previously known as <span class="break-all">`watchdog_profile`</span>)<br />• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover<br />• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) |
3536
| 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 |
3637
| 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. |

content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ rladmin tune cluster
3434
[ slave_ha_cooldown_period <seconds> ]
3535
[ slave_ha_bdb_cooldown_period <seconds> ]
3636
[ max_saved_events_per_type <value> ]
37+
[ metrics_exporter_expose_bdb_name { enabled | disabled } ]
3738
[ parallel_shards_upgrade <value> ]
3839
[ default_concurrent_restore_actions <value> ]
3940
[ show_internals { enabled | disabled } ]
@@ -75,6 +76,7 @@ rladmin tune cluster
7576
| login_lockout_threshold | integer | Number of failed sign-in attempts to trigger locking a user account ("0" means never lock the account) |
7677
| max_saved_events_per_type | integer | Maximum number of events each type saved in CCS per object type |
7778
| 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. |
79+
| metrics_exporter_expose_bdb_name | `enabled`<br />`disabled` | If enabled, adds a label with the database name to relevant metrics |
7880
| parallel_shards_upgrade | integer<br />`all` | Number of shards upgraded in parallel during DB upgrade (positive integer or "all") |
7981
| redis_migrate_node_threshold | size in MB | Memory (in MBs by default or can be specified) needed to migrate a database between nodes |
8082
| redis_migrate_node_threshold_percent | percentage | Memory (in percentage) needed to migrate a database between nodes |

content/operate/rs/7.8/references/rest-api/objects/cluster_settings.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,15 @@ Cluster resources management policy
3333
| default_shards_placement | `dense`<br />`sparse` | Default shards_placement for a newly created databases |
3434
| 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. |
3535
| endpoint_rebind_propagation_grace_time | integer | Time to wait between the addition and removal of a proxy |
36+
| expose_hostnames_for_all_suffixes | boolean (default: false) | If true, enables exposing hostnames for non-default DNS suffixes |
3637
| failure_detection_sensitivity | `high`<br />`low` | Predefined thresholds and timeouts for failure detection (previously known as <span class="break-all">`watchdog_profile`</span>)<br />• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover<br />• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) |
3738
| 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 |
3839
| 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. |
3940
| login_lockout_duration | integer | Duration (in secs) of account lockout. If set to 0, the account lockout will persist until released by an admin. |
4041
| login_lockout_threshold | integer | Number of failed sign in attempts allowed before locking a user account |
4142
| max_saved_events_per_type | integer | Maximum saved events per event type |
4243
| max_simultaneous_backups | integer (default: 4) | Maximum number of backup processes allowed at the same time |
44+
| metrics_exporter_expose_bdb_name | boolean (default: false) | If true, adds a label with the database name to relevant metrics |
4345
| parallel_shards_upgrade | integer | Maximum number of shards to upgrade in parallel |
4446
| persistence_cleanup_scan_interval | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the Redis cleanup schedule |
4547
| persistent_node_removal | boolean | When removing a node, wait for persistence files to be created for all migrated shards |

content/operate/rs/references/cli-utilities/rladmin/tune.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ rladmin tune cluster
3333
[ slave_ha_cooldown_period <seconds> ]
3434
[ slave_ha_bdb_cooldown_period <seconds> ]
3535
[ max_saved_events_per_type <value> ]
36+
[ metrics_exporter_expose_bdb_name { enabled | disabled } ]
3637
[ parallel_shards_upgrade <value> ]
3738
[ default_concurrent_restore_actions <value> ]
3839
[ show_internals { enabled | disabled } ]
@@ -74,6 +75,7 @@ rladmin tune cluster
7475
| login_lockout_threshold | integer | Number of failed sign-in attempts to trigger locking a user account ("0" means never lock the account) |
7576
| max_saved_events_per_type | integer | Maximum number of events each type saved in CCS per object type |
7677
| 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. |
78+
| metrics_exporter_expose_bdb_name | `enabled`<br />`disabled` | If enabled, adds a label with the database name to relevant metrics |
7779
| parallel_shards_upgrade | integer<br />`all` | Number of shards upgraded in parallel during DB upgrade (positive integer or "all") |
7880
| redis_migrate_node_threshold | size in MB | Memory (in MBs by default or can be specified) needed to migrate a database between nodes |
7981
| redis_migrate_node_threshold_percent | percentage | Memory (in percentage) needed to migrate a database between nodes |

content/operate/rs/references/rest-api/objects/cluster_settings.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Cluster resources management policy
3434
| default_shards_placement | `dense`<br />`sparse` | Default shards_placement for a newly created databases |
3535
| 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. |
3636
| endpoint_rebind_propagation_grace_time | integer | Time to wait between the addition and removal of a proxy |
37+
| expose_hostnames_for_all_suffixes | boolean (default: false) | If true, enables exposing hostnames for non-default DNS suffixes |
3738
| failure_detection_sensitivity | `high`<br />`low` | Predefined thresholds and timeouts for failure detection (previously known as <span class="break-all">`watchdog_profile`</span>)<br />• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover<br />• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) |
3839
| 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 |
3940
| 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
4243
| 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. |
4344
| max_saved_events_per_type | integer | Maximum saved events per event type |
4445
| max_simultaneous_backups | integer (default: 4) | Maximum number of backup processes allowed at the same time |
46+
| metrics_exporter_expose_bdb_name | boolean (default: false) | If true, adds a label with the database name to relevant metrics |
4547
| parallel_shards_upgrade | integer | Maximum number of shards to upgrade in parallel |
4648
| max_slave_full_syncs | integer (default: 0) | Maximum number of simultaneous replica full syncs that can run at any given time. 0 means unlimited. |
4749
| persistence_cleanup_scan_interval | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the Redis cleanup schedule |

0 commit comments

Comments
 (0)