Setting Alerts

The alert is sent as an email by Couchbase Server to a configured SMTP server. From there, the email is forwarded to a configured list of email recipients. All cluster-nodes must have network access to the configured SMTP server, for the system to be fully effective.

The alert appears as a pop-up, within Couchbase Web Console.

username and password. The username and password of the administrator who is managing the settings. The Full Admin or Cluster Admin role is required. (See Roles.)

emailPass. The password of the email server that will dispatch the emails. This parameter is optional. The default is an empty string.

sender. The email address of the sender. This parameter is optional. The default value is couchbase@localhost.

recipients. A list of comma-separated email addresses of the intended recipients. This parameter is optional. The default value is root@localhost.

emailHost. The IP address or domain name of the email server to dispatch the alerts. This parameter is optional. The default value is localhost.

emailPort. The port that will be used by the email server. This parameter is optional. The default value is 25.

emailEncrypt. Determines whether emails should be dispatched in encrypted form: the value must be true or false (the default). This parameter is optional.

alerts. A list of email-alert names. If the alert-name is included in the list, a corresponding email-alert will be sent as appropriate, when enabled is true. If the name of an alert is not included in the list, the email-alert is not dispatched. This parameter is optional. The default value contains all alerts: these are listed in Available Alerts.

pop_up_alerts. A list of pop-up-alert names. If the alert-name is included in the list, a corresponding pop-up alert will be displayed as appropriate, when enabled is true. If the name of an alert is not included in the list, the corresponding pop-up alert is not displayed. This parameter is optional. The default value contains all alerts: these are listed in Available Alerts.

enabled. Enables or disables alerts: the value can be true or false (the default). If alerts are enabled, any alert that appears in the list that is passed as the value of alerts or pop_up_alerts (see immediately below) will have an email and/or pop-up display generated as appropriate.

historyWarningThreshold. Warns that the change history for one of the buckets is becoming full, across one or more vBuckets. (The size of the change history is administrator-specified for the whole bucket.) The value of historyWarningThreshold must be an integer that represents a percentage: the default value is 90. When the percentage is exceeded for one or more vBuckets, an alert is generated. See Creating and Editing Buckets, for information on establishing the size of the change history.

lowIndexerResidentPerc. Warns that the Index Service is, on a given node, occupying a percentage of available memory that is below an established threshold, which is the value of lowIndexerResidentPerc. The default value is 10.

maxDiskUsedPerc, maxIndexerRamPerc, and maxOverheadPerc. The maximum percentages for disk usage, memory consumption by the Index Service, and overhead. Values must be between 0 and 100.

memoryNoticeThreshold, memoryWarningThreshold, and memoryCriticalThreshold. Thresholds for memory-usage. These are all disabled until the memory_threshold alert is enabled — for email or for pop-up display, or for both — by means of POST /settings/alerts (see Available Alerts for the full list of alerts). Note that even when memory_threshold is enabled, any of these thresholds can be individually disabled, by setting its value to -1. When a threshold is fully enabled, its value is an integer between 1 and 100: the integer specifies the percentage of total system memory that must have been consumed for an email and/or pop-up alert to be correspondingly generated. Thresholds are enabled, disabled, and configured by means of POST /settings/alerts/limits; and their values are retrieved by means of GET /settings/alerts/limits.

memcachedSystemConnectionWarningThreshold. Trigger the memcached_connections alert if the number of system connections in use exceeds the given percentage of connections available. (E.g., set this value to 90 to trigger an alert if the system connections used by the data service exceed 90% of the connections available.)

memcachedUserConnectionWarningThreshold. Trigger the memcached_connections alert if the number of user connections in use exceeds the given percentage of connections available. (E.g., if this value is set to 90, the system will trigger an alert if the number of user connections used by the data service exceeds 90% of the available connections.)

Failure to specify enabled: {"errors":{"enabled":"The value must be one of the following: [true,false]"}}

Invalid key: {"errors":{"enabled":"The value must be one of the following: [true,false]"}}

Unsupported key: {"errors":{"port":"Unsupported key"}}

Incorrect specification of recipients list: {"errors":{"recipients":"recipients must be a comma separated list of valid email addresses."}}

Incorrect specification of emailEncrypt: {"errors":{"emailEncrypt":"The value must be one of the following: [true,false]"}}

Incorrect specification of sender: {"errors":{"sender":"The value must be a valid email address"}}

Incorrect specification of a memory threshold: {"errors":{"memoryWarningThreshold":"The value must be in range from -1 to 100"}}