Documentation Grafana documentation Alerting Configure notifications Configure contact points Amazon SNS

Configure Amazon SNS for Alerting

Use the Grafana Alerting - Amazon SNS integration to send notifications to Amazon SNS when your alerts are firing. You can receive notifications via the various subscriber channels supported by SNS.

Before you begin

Before you begin, ensure you have the following:

• AWS SNS Topic: An SNS topic to send notifications to.
• AWS IAM Identity with necessary access: An IAM identity (e.g. user, role) with the necessary permissions to publish messages to the SNS topic.

For an example setup, see Example Minimal Setup Using Assumed IAM Role.

Adding the SNS Contact Point in Grafana

With AWS resources configured, proceed to add SNS as a contact point in Grafana.

• Navigate to Alerts & IRM -> Alerting -> Contact points.
• Click on “Add contact point”.
• Name: Enter a descriptive name (e.g., AWS SNS).
• Choose “AWS SNS” from the list of contact point types.

2. Configure SNS Settings

SNS Settings

• The Amazon SNS API URL: (Optional) The SNS API URL, e.g., https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used.
• Signature Version (sigv4): Configures AWS’s Signature Verification 4 signing process to sign requests.
  • Region: (Optional) The AWS region. If blank, the region from the default credentials chain is used.
  • Access Key: The AWS API access key.
  • Secret Key: The AWS API secret key.
  • Profile: (Optional) Named AWS profile used to authenticate.
  • Role ARN: (Optional) The ARN of an AWS IAM role to assume for authentication, serving as an alternative to using AWS API keys.
• SNS topic ARN: (Optional) If you don’t specify this value, you must specify a value for the Phone number or Target ARN. If you are using a FIFO SNS topic you should set a message group interval longer than 5 minutes to prevent messages with the same group key being deduplicated by the SNS default deduplication window.
• Phone number: (Optional) Phone number if message is delivered via SMS in E.164 format. If you don’t specify this value, you must specify a value for the SNS topic ARN or Target ARN.
• Target ARN: (Optional) The mobile platform endpoint ARN if message is delivered via mobile notifications. If you don’t specify this value, you must specify a value for the SNS topic ARN or Phone number.
• Subject: (Optional) Customize the subject line or use the default template. This field is templateable.
• Message: (Optional) Customize the message content or use the default template. This field is templateable.
• Attributes: (Optional) Add any SNS message attributes.

3. Test & Save the Contact Point

• Click “Test” to verify that the SNS configuration is working correctly.
• After the test is successful, click “Save contact point” to add the SNS contact point.

4. Next steps

The SNS contact point is ready to receive alert notifications.

To add this contact point to your alert, complete the following steps.

1. In Grafana, navigate to Alerting > Alert rules.
2. Edit or create a new alert rule.
3. Scroll down to the Configure labels and notifications section.
4. Under Notifications click Select contact point.
5. From the drop-down menu, select the previously created contact point.
6. Click Save rule and exit.

Example Minimal Setup Using Assumed IAM Role

This section outlines a minimal setup to configure SNS with Grafana using an assumed IAM Role.

1. Create an SNS Topic

1. Navigate to SNS in AWS Console:

   • Go to the Amazon SNS Console.

2. Create a new topic [AWS Documentation]:

   • On the Topics page, choose “Create topic”.
   • Select “Standard” as the type.
   • Enter a Name for your topic, e.g., My-Topic.
   • Encryption: Leave disabled for this minimal setup.
   • Click “Create topic”.

3. (Optional) Add an email subscriber to help test [AWS Documentation]:

   • Within your newly created topic, click on “Create subscription”.
   • Protocol: Choose Email.
   • Endpoint: Enter your email address to receive test notifications.
   • Click “Create subscription”.
   • Confirm Subscription: Check your email and confirm the subscription by clicking the provided link.

2. Create an IAM Role

1. Navigate to IAM in AWS Console:

   • Go to the IAM Console.

2. Create a new role [AWS Documentation]:

   • On the Roles page, choose “Create role”.
   • Trusted Entity: Select “This account”.
   • Click “Next” until the end, name it (e.g., GrafanaSNSRole), and click “Create role”.

3. Attach Inline Policy:

   • After creating the role, select it and navigate to the “Permissions” tab.
   • Click on “Add permission” > “Create inline policy”.
   • Switch to the “JSON” tab and paste the following policy, replacing Resource with your SNS topic ARN:
   json Copy

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": ["sns:Publish", "sns:GetTopicAttributes"],
         "Resource": "arn:aws:sns:<region>:<account_id>:<topic_name>"
       }
     ]
   }

   • Click “Next”, name it (e.g., SNSPublishPolicy), and click “Create policy”.

3. Create an IAM Policy

1. Create a new policy to allow assuming the above IAM role [AWS Documentation]:

   • In the IAM Console, on the Policies page, choose “Create policy”.
   • Switch to the “JSON” tab and paste the following policy, replacing Resource with the ARN of the role you created earlier:
   json Copy

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": "sts:AssumeRole",
         "Resource": "arn:aws:iam::<account_id>:role/GrafanaSNSRole"
       }
     ]
   }

2. Review and Create:

   • Click “Next”, name it (e.g., AssumeSNSRolePolicy), and click “Create policy”.

4. Create an IAM User

1. Create a new IAM user to assume the above role [AWS Documentation]:

   • In the IAM Console, on the Users page, choose “Create user”.
   • Enter a User name, e.g., grafana-sns-user.
   • Click “Next”.
   • Select “Attach policies directly”.
   • Search for the policy you created earlier (AssumeSNSRolePolicy) and select it.
   • Click “Next” , and click “Create user”.

2. Generate credentials:

   • Within your newly created user, click on “Create access key”.
   • Select an appropriate use-case, e.g., Application running outside AWS.
   • Click “Next” , and click “Create access key”.
   • Save Credentials: Note the Access key ID and Secret access key. You’ll need these for Grafana’s configuration.

5. Add the SNS Contact Point in Grafana

After creating the IAM user and obtaining the necessary credentials, proceed to configure the SNS contact point in Grafana using the following details:

• The Amazon SNS API URL: https://sns.us-east-1.amazonaws.com
• Signature Version (sigv4):
  • Region: us-east-1
  • Access Key: <YOUR_ACCESS_KEY>.
  • Secret Key: <YOUR_SECRET_ACCESS_KEY>
  • Role ARN: arn:aws:iam::<account_id>:role/GrafanaSNSRole
• SNS topic ARN: arn:aws:sns:<region>:<account_id>:My-Topic

Additional Resources

• Amazon SNS Documentation
• AWS IAM Documentation
• Prometheus Alertmanager SNS Integration
• Cloudwatch AWS Authentication