-
Notifications
You must be signed in to change notification settings - Fork 11.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
alerting: integrations > small update (#87538) * added links to list * changed heading (cherry picked from commit 3a2c9f4)
- Loading branch information
Showing
2 changed files
with
103 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
...g/configure-notifications/manage-contact-points/integrations/configure-email.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| canonical: https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/configure-email/ | ||
| description: Configure email integration to send email notifications when your alerts are firing | ||
| keywords: | ||
| - grafana | ||
| - alerting | ||
| - integration | ||
| labels: | ||
| products: | ||
| - cloud | ||
| - enterprise | ||
| - oss | ||
| menuTitle: Email | ||
| title: Configure email for Alerting | ||
| weight: 300 | ||
| --- | ||
|
|
||
| # Configure email for Alerting | ||
|
|
||
| Use the Grafana Alerting - email integration to send email notifications when your alerts are firing. An email is sent when an alert fires and when an alert gets resolved. | ||
|
|
||
| ## Before you begin | ||
|
|
||
| {{<admonition type="note">}} | ||
| This section is for Grafana OSS only. For Grafana Cloud, SMTP configuration is not required. | ||
| {{</admonition>}} | ||
|
|
||
| For Grafana OSS, you enable email notifications by first configuring [SMTP settings](https://grafana.com/docs/grafana/next/setup-grafana/configure-grafana/#smtp) in the Grafana configuration settings. | ||
|
|
||
| ### SMTP configuration | ||
|
|
||
| 1. Access the configuration file. | ||
|
|
||
| Locate the Grafana configuration file. This file is typically named `grafana.ini` or `custom.ini` and is located in the `conf` directory within the Grafana installation directory. | ||
|
|
||
| 1. Open the configuration file: | ||
|
|
||
| Open the configuration file using a text editor. | ||
|
|
||
| 1. Locate SMTP settings section. | ||
|
|
||
| Search for the [SMTP settings section](https://grafana.com/docs/grafana/next/setup-grafana/configure-grafana/#smtp) in the configuration file. It starts with `[smtp]`. | ||
|
|
||
| 1. Configure SMTP settings. | ||
|
|
||
| Within the `[smtp]` settings section, specify the following parameters: | ||
|
|
||
| - `enabled = true`: Enables SMTP. | ||
| - `host`: The hostname or IP address of your SMTP server, and the port number of your SMTP server (commonly 25, 465, or 587). Default is `localhost:25`. | ||
| - `user`: Your SMTP username (if authentication is required). | ||
| - `password`: Your SMTP password (if authentication is required). | ||
| - `from_address`: The email address from which Grafana notifications will be sent. | ||
| - `from_name`: The name associated with the from_address. | ||
| - `skip_verify = true`: Skip SSL/TLS certificate verification (useful for testing, but not recommended for production). | ||
|
|
||
| 1. Save and close the configuration file. | ||
|
|
||
| After configuring the SMTP settings, save the changes to the configuration file and close the text editor. | ||
|
|
||
| 1. Restart Grafana. | ||
|
|
||
| Restart the Grafana service to apply the changes made to the configuration file. The method for restarting Grafana depends on your operating system and how Grafana was installed (e.g., `systemctl restart grafana-server` for systems using systemd). | ||
|
|
||
| 1. Test email notifications. | ||
|
|
||
| After restarting Grafana, test the email notification functionality by creating an email contact point. | ||
|
|
||
| ## Procedure | ||
|
|
||
| To set up email integration, complete the following steps. | ||
|
|
||
| 1. Navigate to **Alerts & IRM** -> **Alerting** -> **Contact points**. | ||
| 1. Click **+ Add contact point**. | ||
| 1. Enter a contact point name. | ||
| 1. From the Integration list, select **Email**. | ||
| 1. Enter the email addresses you want to send notifications to. | ||
| 1. Click **Test** to check that your integration works. | ||
| 1. Click **Save contact point**. | ||
|
|
||
| ## Next steps | ||
|
|
||
| To add the contact point and integration you created to your default notification policy, complete the following steps. | ||
|
|
||
| 1. Navigate to **Alerts & IRM** -> **Alerting** -> **Notification policies**. | ||
| 1. In the **Default policy**, click the ellipsis icon (…) and then **Edit**. | ||
| 1. Change the default policy to the contact point you created. | ||
| 1. Click **Update default policy**. | ||
|
|
||
| {{% admonition type="note" %}} | ||
| If you have more than one contact point, add a new child notification policy rather than edit the default one, so you can route specific alerts to one or multiple email addresses. | ||
| {{% /admonition %}} |