Email Alerts for MariaDB Xpand

Configure Email Alerts

MariaDB Xpand can be configured to send email alerts..

Use the following steps to configure the alerts for your system:

1. Set Identifying Global Variables

   Set these identifying global variables for your database. These are especially important to aid MariaDB Support in troubleshooting.

   SET GLOBAL customer_name = 'customer name';
   SET GLOBAL cluster_name = 'deployment identifier';
   

2. Configure alerts_parameters for SMTP Server

   The parameters defined in the system.alerts_parameters table control how alerts are formatted and sent.

   MariaDB Xpand requires an SMTP server to send the alert messages. These instructions presume that an SMTP server has already been set up correctly for your environment.

   Set the following SMTP parameters as they apply to your deployment.

   Parameter	Description	Required
   smtp_server	hostname for SMTP server	Yes
   smtp_port	SMTP port for your environment, if different from the default TCP port 25.	Yes
   smtp_username	SMTP username	No
   smtp_password	SMTP password	No
   smtp_security	SMTP security type. Must be SMTPS or TLS.	No

   Follow this syntax to update the parameters shown:

   UPDATE  system.alerts_parameters
   SET value = 'your smpt-specific value'
   WHERE name = 'parameter name';
   

3. Configure alerts_subscriptions

   Add email addresses of the individual(s) or group(s) who are to receive the alerts to the system.alerts_subscriptions table. You can INSERT, UPDATE, and DELETE from this table using standard SQL.

   To see current list of alert subscriptions:

   SELECT * FROM system.alerts_subscriptions;
   

   To add a new email address:

   INSERT INTO system.alerts_subscriptions
   VALUES ('desired_email@domain_name.com');
   

4. RESET Alerter

   Any time that changes are made to the system.alerts_parameters or system.alerts_subscriptions table(s), the Alerter must be RESET. Your changes will not take effect until this is done.

   To reset the Alerter:

   ALTER CLUSTER RESET ALERTER;
   

   This will not cause a group change on your deployment.

   If invalid information is provided, you may encounter the following error:

   ALTER CLUSTER RESET ALERTER;
   

   ERROR 1 (HY000): [64512] Bad configuration for alerts:
   

   Check clustrix.log for more information. Here is an example where the smtp_server parameter was not specified:

   2018-10-11 21:07:51.068524 UTC karma068.example.com clxnode:
   ERROR cluster/alerter.ct:219 prepare_write(): Couldn't write alerter
   config: Bad configuration for alerts: No smtp_server specified
   

5. Request Alert

   To verify that the configuration works properly, execute this SQL to send a test alert:

   SELECT alert(severity, 'alert text');
   

   If you do not receive the expected email alert, please re-review your configuration.

Sample Emailed Alerts

Here are some sample emailed alert messages that may be similar to some you could encounter on your deployment. These alerts will also appear in the query.log.

Severity: WARNING
Date: 2018-10-02 18:49:24.177250 UTC
Host: clxdb003
Cluster: Dogfood7
Version: clustrix-9.1.3
OS Version: CentOS Linux release 7.4.1708 (Core)
Message: Database space is 80% used. Soon user queries will fail.
path=/data/clustrix/device1 device_total=4,247,830,372,352
wal_total=1,073,741,824 device_free=327,733,190,656
temp_total_space=161,061,273,600 system_avail=758,480,666,624
system_total=3,757,962,166,272 total_used=2,999,481,499,648 %=80
user_avail=382,684,449,996 user_total=3,382,165,949,644
cont_type=USER trx_type=USER

Severity: INFO
Date: 2018-09-25 23:42:59.798249 UTC
Host: clxdb005
Cluster: Dogfood7
Version: clustrix-9.1.3
OS Version: CentOS Linux release 7.4.1708 (Core)
EC2 Region: us-west-2a
EC2 Instance ID: i-0882894eb6aa887ac
Message: [SQL] backup-25-09-2018 ERROR 2018-09-25 22:52:02

Severity: ERROR
Date: 2018-09-09 13:18:25.769801 UTC
Host: clxdb001
Cluster: Dogfood7
Version: clustrix-9.1.3
OS Version: CentOS Linux release 7.4.1708 (Core)
Message: Error reading 32768 bytes at offset 0x1d7367d0000 of
"/data/clustrix/device1": Input/output error

Additional Information