2. Home
  4. Docs
  6. ClusterControl
  8. User Guide (GUI)
  10. MongoDB
  12. Settings

Settings

Settings for the cluster including general settings, mail notifications and thresholds.

CMON Settings

General Settings

Field Description
Cluster Name
  • Cluster name. This name will appear in the database cluster list and database cluster summary.
Staging Area
  • The staging area is a directory (created automatically) to store intermediate data, such as dump files, binaries, packages used in installations, upgrades, or scaling. The staging area is automatically cleaned but should be big enough to hold dump files of your entire database.
Sudo
  • Sudo command password (if SSH User is not root) if running as sudoers. Change in CMON configuration file under <span class="pre">sudo</span>.
SSH User
  • Read-only. The user can SSH from the ClusterControl Server to the other nodes without a password. Change in CMON configuration file under <span class="pre">os_user</span> or <span class="pre">osuser</span>.
SSH Identity
  • Read-only. Change in CMON configuration file under <span class="pre">ssh_identity</span>.
History
  • The number of days you would like to keep historic data. Ensure you have enough disk space on the ClusterControl server if you want to store historic data.
Log Interval
  • How many minutes between automatic MongoDB error log collection retrieval.

Email Notification Settings

Configures email notification settings for alarms generated for the database cluster.

Field Description
Send email to
  • Recipient email address.
Send digests at
  • Send a digested (summary) email at this time every day or the selected recipient.
TimezoneTimezone
  • Timezone for the selected recipient.
Daily limit for non-digest email as
  • The maximum number of non-digest email notification should be sent per day for the selected recipient. -1 for unlimited.

Alarm/Event Category

Event Description
Network Network related messages, e.g host unreachable, SSH issues.
CmonDatabase Internal CMON database-related messages.
Mail Mail system-related messages.
Cluster Cluster related messages, e.g cluster failed.
ClusterConfiguration Cluster configuration messages, e.g software configuration messages.
ClusterRecovery Recovery messages like cluster or node recovery failures.
Node Message related to nodes, e.g node disconnected, failed to start MongoDB cluster nodes.
Host Host related messages, e.g CPU/disk/RAM/swap alarms.
DbHealth Database health-related messages, e.g memory usage of MongoDB servers, connections.
DB performance Alarms for long-running transactions and deadlocks
Software installation Software installation related messages.
Backup Messages about backups.
Unknown Other uncategorized messages.

Select how you wants alarms/events delivered

Action Description
Ignore Ignore if an alarm raised.
Deliver Send notification immediately via email once an alarm raised.
Digest Send a summary of alarms raised every day at Send digests at

Runtime Configuration

Summarizes the active ClusterControl Controller (CMON) runtime configuration parameters and displays the versions of ClusterControl Controller and ClusterControl UI packages. All parameters listed here are loaded directly from <span class="pre">cmon.cmon_configuration</span> the table, displayed by the current cluster-ID. You can filter out the variables by using the Search field on the top of the table. Each parameter has the Current Value (the active value loaded into ClusterControl) and also the Default Value (if undefined, ClusterControl will use this value) as well as a description of the parameter.

See also

ClusterControl Controller (CMON).

Some configuration parameters can be modified directly from the UI like <span class="pre">swap_warning</span> (Settings → Thresholds → Swap Warning) and <span class="pre">backup_subdir</span> (Backup → Settings → Default Backup Subdirectory). Some parameters have to be set inside CMON configuration file for the respective cluster-ID.

Thus, there are two ways to modify the value of any parameter:

  1. Change the value directly from the UI if exists. This will save it into the cmon database. No cmon restart requires.
  2. Append the parameter line inside the CMON configuration file for the respective cluster <span class="pre">/etc/cmon.d/cmon_X.cnf</span> (where X is the cluster-ID). This requires a cmon restart to get it loaded into the cmon database.

As a side note, the settings that are set through UI will always take precedence.

Note

You can also run <span class="pre">cmon</span> <span class="pre">--help-config</span> to get the details of supported parameters.

Thresholds

Provides thresholds for warnings and critical events. Thresholds specify the threshold level at which an alarm will be triggered and notification will be sent via email to the list of recipients configured in the Email Notification Settings. Set your alarm thresholds for:

  • CPU utilization
  • RAM utilization
  • Disk space utilization
Level Description
Warning Sets your warning threshold in percentage for a specific event.
Critical Sets your critical threshold in percentage for a specific event.

Replication Lag

Manages the replication lag in the replica set and statistic collection interval.

Field Description
Max Replication Lag
  • Maximum replication lag in seconds before ClusterControl raises an alarm.
DB Stats Collection Interval
  • MongoDB stats collection interval in seconds.
Attention

Starting from ClusterControl 1.9.7 (September 2023), ClusterControl GUI v2 is the default frontend graphical user interface (GUI) for ClusterControl. Note that the GUI v1 is considered a feature-freeze product with no future development. All new developments will be happening on ClusterControl GUI v2. See User Guide (GUI v2).

Was this article helpful to you? Yes No 1