5.4.9. Settings

Provides global settings for ClusterControl.

5.4.9.1. General Settings

5.4.9.1.1. Cluster Settings

  • 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 mysqldumps, binaries, RPMs used in e.g installations/upgrades and automatic scaling.
  • Sudo
    • Sudo password if running as sudoers.
  • SSH User
    • Read-only. The user that can SSH from the ClusterControl Server to the other nodes without password. Change in CMON configuration file under os_user or osuser.
  • SSH Identity
    • Read-only. Change in CMON configuration file under ssh_identity.
  • SSH Options
    • Read-only. SSH options for the SSH connections. Change in CMON configuration file under ssh_opts.
  • History
    • 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.

5.4.9.1.2. Configure Mailserver

Configure how email notifications are to be sent. ClusterControl supports two options for sending email notifications, either using local mail commands via local MTA (Sendmail/Postfix/Exim) or using an external SMTP server. Make sure the local MTA is installed and verified with Test Email button.

5.4.9.1.2.1. Option 1: Sendmail

  • Use ‘sendmail’
    • Use this option to enable sendmail to send notifications. Instructions on how to set it up can be found here.
  • Reply-to/From
    • Specify the sender of the email. This will appear in the ‘From’ field of mail header.

5.4.9.1.2.3. Using Postfix

Many of Linux distributions come with Sendmail as default MTA. To replace Sendmail and use other MTA, e.g Postfix, you just need to uninstall Sendmail, install Postfix and start the service. Following example shows commands that need to be executed on ClusterControl node as root user for RHEL:

$ service sendmail stop
$ yum remove sendmail -y
$ yum install postfix mailx cronie -y
$ chkconfig postfix on
$ service postfix start

5.4.9.1.3. Email Notification

Configures email notifications for alarms generated for your database cluster.

  • Send email to
    • Recipient email address.
  • Send digests at
    • Send a digested (summary) email at this time every dayf or the selected recipient.
  • Timezone
    • 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, missing GRANT, failed to start HAproxy, 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.
    DbPerformance Alarms for long running transactions and deadlocks
    SoftwareInstallation 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 everyday at Send digests at

5.4.9.1.4. Version

View the database server, vendor, operating system distribution and ClusterControl version installed. Check the Check for updates button to get notified when a new ClusterControl version is released. New versions are made available from our download site and Severalnines repository.

To upgrade to the latest version, see Upgrading ClusterControl section.

5.4.9.2. Subscription

For users with a valid subscription (Standard, Pro, Enterprise), enter your license information here to enable additional features based on the subscription.

This functionality is also globally accessible at ClusterControl > Settings > Subscription. Following screenshot shows example on filing up the license information:

../../_images/subscription1.png

Attention

Make sure you copy the subscription information as they are, with no leading/trailing spaces.

The license key is validated during runtime. Reload your web browser after registering the license.

Note

When the license expires, ClusterControl defaults back to the Community Edition. For features comparison, please refer to ClusterControl product page.

5.4.9.3. Thresholds

Provides thresholds for warnings and criticals event. 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. Set your alarm thresholds for:

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

5.4.9.4. Replication Lag

Manages the replication lag and statistic collection interval.

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