RepoMirrors/alertmanager
1
0
Fork 0
mirror of https://github.com/prometheus/alertmanager synced 2025-01-11 16:29:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support for role arn, truncation, dedupe key and env auth

Browse Source 
Signed-off-by: Tyler Reid <tyler.reid@grafana.com>
This commit is contained in:
Tyler Reid 2021-06-11 16:21:15 -05:00
parent 5dcf4f5f91
commit 74d15273c0
3 changed files with 56 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
config/notifiers.go
View File

@ -133,8 +133,9 @@ var (
NotifierConfig: NotifierConfig{
VSendResolved: true,
},
APIVersion: "sns.default.api_version",
Message: `{{ template "sns.default.message" . }}`,
APIVersion: "sns.default.api_version",
Message: `{{ template "sns.default.message" . }}`,
IsFIFOTopic: false,
}
)
@ -612,8 +613,9 @@ type SNSConfig struct {
Sigv4 SigV4Config `yaml:"sigv4" json:"sigv4"`
TopicARN string `yaml:"topic_arn,omitempty" json:"topic_arn,omitempty"`
PhoneNumber string `yaml:"phone_number,omitempty" json:"phone_number,omitempty"`
Subject string `yaml:"subject,omitempty" json:"subject,omitempty"`
TargetARN string `yaml:"target_arn,omitempty" json:"target_arn,omitempty"`
IsFIFOTopic bool `yaml:"is_fifo_topic,omitempty" json:"is_fifo_topic,omitempty"`
Subject string `yaml:"subject,omitempty" json:"subject,omitempty"`
Message string `yaml:"message,omitempty" json:"message,omitempty"`
Attributes map[string]string `yaml:"attributes,omitempty" json:"attributes,omitempty"`
}

1
config/testdata/conf.sns-test.yml vendored
View File

@ -7,6 +7,7 @@ receivers:
sns_configs:
- api_url: https://sns.us-east-2.amazonaws.com
topic_arn: arn:aws:sns:us-east-2:123456789012:My-Topic
is_fifo_topic: true
sigv4:
region: us-east-2
access_key: access_key

62
notify/sns/sns.go
View File

@ -15,7 +15,9 @@ package sns
import (
"context"
"fmt"
"net/http"
"unicode/utf8"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
@ -40,22 +42,24 @@ type Notifier struct {
}
func (n Notifier) Notify(ctx context.Context, alert ...*types.Alert) (bool, error) {
// TODO: get Credentials from env variables if none passed in + api auth
creds := credentials.NewStaticCredentials(n.conf.Sigv4.AccessKey, string(n.conf.Sigv4.SecretKey), "")
credentials := credentials.NewStaticCredentials(n.conf.Sigv4.AccessKey, string(n.conf.Sigv4.SecretKey), "")
if n.conf.Sigv4.AccessKey == "" {
creds = nil
credentials = nil
}
sess, err := session.NewSessionWithOptions(session.Options{
Config: aws.Config{
CredentialsChainVerboseErrors: aws.Bool(true),
Region: aws.String(n.conf.Sigv4.Region),
Credentials: creds,
Credentials: credentials,
Endpoint: aws.String(n.conf.APIUrl),
},
Profile: n.conf.Sigv4.Profile,
})
if _, err := sess.Config.Credentials.Get(); err != nil {
return false, fmt.Errorf("could not get SigV4 credentials: %w", err)
}
if n.conf.Sigv4.RoleARN != "" {
sess.Config.Credentials = stscreds.NewCredentials(sess, n.conf.Sigv4.RoleARN)
}
@ -64,13 +68,19 @@ func (n Notifier) Notify(ctx context.Context, alert ...*types.Alert) (bool, erro
tmpl := notify.TmplText(n.tmpl, data, &err)
message := tmpl(n.conf.Message)
client := sns.New(sess, &aws.Config{Credentials: creds})
client := sns.New(sess, &aws.Config{Credentials: credentials})
publishInput := &sns.PublishInput{}
if n.conf.TopicARN != "" {
publishInput.SetTopicArn(n.conf.TopicARN)
// TODO: Truncate for SNS at 256KB
publishInput.SetMessage(message)
messageToSend, isTrunc, err := validateAndTruncateMessage(message)
if err != nil {
return false, err
}
if isTrunc {
n.conf.Attributes["truncated"] = "true"
}
publishInput.SetMessage(messageToSend)
}
if n.conf.PhoneNumber != "" {
publishInput.SetPhoneNumber(n.conf.PhoneNumber)
@ -84,8 +94,14 @@ func (n Notifier) Notify(ctx context.Context, alert ...*types.Alert) (bool, erro
}
if n.conf.TopicARN != "" {
publishInput.SetTopicArn(n.conf.TopicARN)
// TODO: Truncate for SNS at 256KB
publishInput.SetMessage(message)
messageToSend, isTrunc, err := validateAndTruncateMessage(message)
if err != nil {
return false, err
}
if isTrunc {
n.conf.Attributes["truncated"] = "true"
}
publishInput.SetMessage(messageToSend)
}
if len(n.conf.Attributes) > 0 {
@ -100,9 +116,18 @@ func (n Notifier) Notify(ctx context.Context, alert ...*types.Alert) (bool, erro
publishInput.SetSubject(n.conf.Subject)
}
// Deduplication key is only added if it's a FIFO SNS Topic.
if n.conf.IsFIFOTopic {
key, err := notify.ExtractGroupKey(ctx)
if err != nil {
return false, err
}
publishInput.SetMessageDeduplicationId(key.Hash())
}
publishOutput, err := client.Publish(publishInput)
if err != nil {
// AWS Response is bad, probably a config issue
// AWS Response is bad, probably a config issue.
return false, err
}
@ -111,10 +136,23 @@ func (n Notifier) Notify(ctx context.Context, alert ...*types.Alert) (bool, erro
return false, err
}
// Response is good and does not need to be retried
// Response is good and does not need to be retried.
return false, nil
}
func validateAndTruncateMessage(message string) (string, bool, error) {
if utf8.ValidString(message) {
// if the message is larger than 256KB we have to truncate.
if len(message) > 256*1000 {
truncated := make([]byte, 256*1000, 256*1000)
copy(truncated, message)
return string(truncated), true, nil
}
return message, false, nil
}
return "", false, fmt.Errorf("non utf8 encoded message string")
}
// New returns a new SNS notification handler.
func New(c *config.SNSConfig, t *template.Template, l log.Logger, httpOpts ...commoncfg.HTTPClientOption) (*Notifier, error) {