A newer version of this documentation is available.

View Latest

Configure Email Alerts

    +
    When alerts are configured, which raise email alerts when a significant error occurs on the Couchbase Server cluster.

    Full Administrators and Cluster Administrators can configure alerts.

    The email alert system works by sending an email directly to a configured SMTP server. Each alert email is sent to the list of configured email recipients to highlight specific issues and problems that you should be aware of and may need to check to ensure the health of your Couchbase cluster. Alerts are also provided as a popup within the Couchbase Web Console.

    It is important to ensure that all Couchbase Server nodes have network access to the configured SMTP server.

    You can define the settings using the Web Console or using the REST API.

    settings alerts

    To setup email alerts using the Web Console:

    1. From the Couchbase Web Console > Settings > select the Email Alerts tab.

    2. Select the Enable email alerts check box to enable the email alerts configuration. These alerts are raised for errors that you select in the Available Alerts section.

    3. Define the following settings and click Save:

    Email Server Settings

    Option Description

    Host

    The hostname of the SMTP server that will be used to send the email.

    Port

    The TCP/IP port to be used to communicate with the SMTP server. The default is the standard SMTP port 25.

    Username

    For email servers that require a username and password to send email, the username is used for authentication.

    Password

    For email servers that require a username and password to send email, the password is used for authentication. Note that when you save the settings you enter, the password that you typed into the Password field becomes invisible, and the field therefore appears blank. This is a security measure imposed by Couchbase Server: the password remains valid, and will be used in authenticating with the email server.

    Require encryption (TLS)

    Enable Transport Layer Security (TLS) when sending the email through the designated server.

    Email Settings

    Option Description

    Sender Email

    The email address identified as a source from which the email is sent. This email address should be one that is valid as a sender address for the SMTP server that you specify.

    Recipients

    A list of the recipients of each alert message. To specify more than one recipient, separate each address by a space, comma (,), or semicolon (;).

    Test Mail

    Click Send Test Email to send a test email to confirm the settings and configuration of the email server and recipients.

    Available Alerts

    You can enable individual alert messages that can be sent by selecting the appropriate check boxes. The supported alerts are:

    Alert Description Code

    Node was auto-failed-over

    The sending node has been failed over automatically.

    auto_failover_node

    Maximum number of auto-failed-over nodes was reached

    The auto-failover system stops auto-failover when the maximum number of spare nodes available has been reached.

    auto_failover_maximum_reached

    Node wasn’t auto-failed-over as other nodes are down at the same time

    Auto-failover does not take place if there is already a node down.

    auto_failover_other_nodes_down

    Node was not auto-failed-over as there are not enough nodes in the cluster running the same service

    You cannot support auto-failover with less than three nodes.

    auto_failover_cluster_too_small

    Node was not auto-failed-over as auto-failover for one or more services running on the node is disabled

    Auto-failover does not take place on a node as one or more services running on the node is disabled.

    auto_failover_disabled

    Node’s IP address has changed unexpectedly

    The IP address of the node has changed, which may indicate a network interface, operating system, or other network or system failure.

    ip

    Disk space used for persistent storage has reach at least 90% of capacity

    The disk device configured for storage of persistent data is nearing full capacity.

    disk

    Metadata overhead is more than 50%

    The amount of data required to store the metadata information for your dataset is now greater than 50% of the available RAM.

    overhead

    Bucket memory on a node is entirely used for metadata

    All the available RAM on a node is being used to store the metadata for the objects stored. This means that there is no memory available for caching values. With no memory left for storing metadata, further requests to store data will also fail.

    Only applicable to buckets with Value-only ejection policy.

    ep_oom_errors

    Writing data to disk for a specific bucket has failed

    The disk or device used for persisting data has failed to store persistent data for a bucket.

    ep_item_commit_failed

    Writing event to audit log has failed

    The audit log event writing has failed.

    audit_dropped_events

    Approaching full Indexer RAM warning

    The indexer RAM limit threshold is approaching warning.

    indexer_ram_max_usage

    Remote mutation timestamp exceeded drift threshold

    The remote mutation timestamp exceeded drift threshold warning.

    ep_clock_cas_drift_threshold_exceeded

    Communication issues among some nodes in the cluster

    There are some communication issues in some nodes within the cluster.

    communication_issue