The Alerts page allows you to enable email alerts, send test alerts, and view the email recipients and alert history for your CockroachDB Cloud organization. To view the Alerts page, log in and click Alerts.
The Alerts page is applicable for CockroachDB Dedicated clusters in your CockroachDB Cloud organization. For CockroachDB Serverless clusters in your organization, all Org Administrators automatically receive email alerts when your cluster reaches 50%, 75%, and 100% of your resource limits.
Automatic alerts
Cluster Maintenance
Org Administrators receive email alerts when:
- A cluster is scheduled for an automatic patch version upgrade and again after the upgrade is complete.
- When a cluster is scheduled for maintenance that could temporarily impact the cluster's performance.
- When a cluster's CockroachDB version is nearing end of life and must be upgraded to maintain support.
CMEK
The Customer-Managed Encryption Keys (CMEK) alert is triggered when the cluster node is unable to start due to CMEK key access failure.
If you receive the alert repeatedly, verify the following:
- The key is still enabled in their cloud provider KMS.
- The role or account used to access the key still has valid permissions.
- The credentials or access key are still valid, and generate new credentials if needed.
Opt-in alerts
Even with CockroachDB's various built-in safeguards against failure, it is critical to enable alerts and actively monitor the overall health and performance of a cluster running in production.
CockroachDB Dedicated clusters do not auto-scale and upgrade cluster capacity in response to utilization alerts. If you receive an alert repeatedly, you may need to optimize your workload or scale your CockroachDB Cloud cluster.
If alerts are enabled, CockroachDB Cloud sends alerts to specified email recipients when the following usage metrics are detected:
Storage Utilization
Storage utilization alerts are triggered when:
- Cluster-wide available disk capacity is 20% or less.
- Node-level available disk capacity is 10% or less.
If the condition triggering an alert does not change, the alert will repeat every 60 minutes.
If you receive an alert repeatedly:
- Consider increasing storage per node.
- Consider truncating or dropping unused tables.
CPU Utilization
CPU utilization alerts are triggered when:
- Cluster-wide CPU usage is 80% or greater on average for at least 60 minutes.
- Node-level CPU usage is 90% or greater on average for at least 90 minutes.
If the condition triggering an alert does not change, the cluster-wide alert will repeat every 60 minutes and the node-level alert will repeat every 90 minutes.
If you receive an alert repeatedly:
- Identify unoptimized queries and optimize your workload.
- Add one or more indexes to improve query performance.
- Consider increasing the capacity of the nodes or add more nodes to reduce the load per node.
Memory Utilization
Memory utilization alerts are triggered when:
- Cluster-wide available memory is 20% or less on average for at least 60 minutes.
- Node-level available memory is 10% or less on average for at least 90 minutes.
If the condition triggering an alert does not change, the cluster-wide alert will repeat every 60 minutes and the node-level alert will repeat every 90 minutes.
If you receive an alert repeatedly:
- Identify unoptimized queries and optimize your workload.
- Add one or more indexes to improve query performance.
- Consider increasing the capacity of the nodes or add more nodes to reduce the load per node.
Maintenance Window
For clusters with maintenance windows configured, users who have signed up for alerts will receive email notifications.
Configure alerts
To enable alerts:
- Under Configure CockroachDB Cloud alerts, toggle the Alerts are on switch.
- Under Add Email Recipients, add at least one email address and click Add.
Alerts are enabled for all CockroachDB Dedicated clusters in your Organization.
You can use an email alias to send alerts to a monitoring tool such as Alertmanager or PagerDuty.
Send a test alert
To send a test alert:
- Under Send test email, select a cluster and an alert type.
- Add at least one email address and click Add.
- Click Send test email.