Setting up Email Notifications for the MySQL connector

Note

The Snowflake Connector for MySQL is subject to the Connector Terms.

You can enable email notifications for the connector. The connector uses the Notification System Stored Procedure to send email notifications. Setting up email notifications is an optional but recommended action.

Configuring Email Notifications

You can configure the connector to send email notifications when errors occur.

On a given schedule, the connector checks whether new errors have occurred. If so, an email containing the number of errors is sent to specified recipients. Email notifications are sent on an incremental basis, meaning that only new errors trigger notification. For security reasons, emails contains only information about the number of errors (not the errors themselves).

To receive email notifications about errors, you must have already created and set up an event table for the account (to capture the logged errors), and that event table must have CHANGE_TRACKING set to TRUE.

To configure email notifications do the following:

  1. Create a notification integration.

  2. Create a log view for the connector.

  3. Enable email notifications.

Create a notification integration

To send email notifications, the connector uses the notification integration object, which is a Snowflake object that provides an interface between Snowflake and email services.

To create notification integration, run the following command:

CREATE NOTIFICATION INTEGRATION <integration_name>
    TYPE=EMAIL
    ENABLED=TRUE
    ALLOWED_RECIPIENTS=('first.last@example.com','first2.last2@example.com');
Copy

Where:

integration_name

Specifies the name of the notification integration.

The connector requires the USAGE privilege on the notification integration that is used to send the email. To grant this privilege, run the following command:

GRANT USAGE ON INTEGRATION <integration_name> TO APPLICATION <app_db_name>;
Copy

Where:

integration_name

Specifies the name of the notification integration.

app_db_name

Specifies the name of the connector database.

More information about creating notification integration can be found here.

Create a log View for the connector

To configure email notifications you must create a log view for the event table that stores the logged messages from the connector. You can create the log view in any database and schema, except the database that serves as the connector instance.

Run the following command to create a log view on the event table:

CREATE SECURE VIEW <logs_view> CHANGE_TRACKING = TRUE AS
  SELECT *
  FROM <fully_qualified_event_table_name>
  WHERE RECORD_TYPE = 'LOG' AND
  RESOURCE_ATTRIBUTES:"snow.database.name" = '<app_db_name>';
Copy

Where:

logs_view

Specifies the name of the view that you want to create.

fully_qualified_event_table_name

Specifies the fully-qualified name of the event table.

app_db_name

Specifies the name of the connector database.

The connector requires the SELECT privilege on the view. It also requires USAGE privilege both on the database and the schema that contains the view. To grant these privileges, run the following commands:

GRANT USAGE ON DATABASE <logs_db> TO APPLICATION <app_db_name>;
GRANT USAGE ON SCHEMA <logs_db>.<logs_schema> TO APPLICATION <app_db_name>;
GRANT SELECT ON VIEW <logs_db>.<logs_schema>.<logs_view> TO APPLICATION <app_db_name>;
Copy

Where:

logs_db

Specifies the name of the database that contains the view that you just created.

logs_schema

Specifies the name of the schema that contains the view that you just created.

logs_view

Specifies the name of the view that you just created.

app_db_name

Specifies the name of the connector database.

Enable email notifications

After creating the email notification integration and the log view, run the following command to enable email notifications from the connector:

CALL PUBLIC.CONFIGURE_ALERTS('<integration_name>', '<logs_db>.<logs_schema>.<logs_view>', '<schedule>', ['<email_address_1>' [, ... '<email_address_2>']]);
Copy

Where:

integration_name

Specifies the name of the notification integration.

logs_db

Specifies the name of the database that contains the view that you created in the previous step.

logs_schema

Specifies the name of the schema that contains the view that you created in the previous step.

logs_view

Specifies the name of the view that you created in the previous step.

schedule

Specifies the schedule or frequency at which the connector should check for errors and send a notification. For details on specifying the schedule or frequency, see SCHEDULE parameter.

['email_address_1' [, ... 'email_address_2']]

Specifies the array of one or more quoted email addresses that can receive email notifications from the connector. The email addresses in this array must be in the ALLOWED_RECIPIENTS parameter specified in the email notification integration.

To change the configuration of an email notifications, use the above command providing the revised parameters.

Disabling Email Notifications

To disable email notifications, run the following command:

CALL PUBLIC.DISABLE_ALERTS();
Copy

This command removes all email addresses that were added during the initial configuration.

Next steps

After completing these procedures, follow the steps in Setting up the Snowflake Connector for MySQL Agent container

Language: English