forked from prometheus/alertmanager
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(prometheus#3920): add msteamsv2 receiver
- Loading branch information
Showing
8 changed files
with
261 additions
and
2 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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
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
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,192 @@ | ||
// Copyright 2024 Prometheus Team | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package msteamsv2 | ||
|
||
import ( | ||
"bytes" | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"io" | ||
"net/http" | ||
"os" | ||
"strings" | ||
|
||
"github.com/go-kit/log" | ||
"github.com/go-kit/log/level" | ||
commoncfg "github.com/prometheus/common/config" | ||
"github.com/prometheus/common/model" | ||
|
||
"github.com/prometheus/alertmanager/config" | ||
"github.com/prometheus/alertmanager/notify" | ||
"github.com/prometheus/alertmanager/template" | ||
"github.com/prometheus/alertmanager/types" | ||
) | ||
|
||
const ( | ||
colorRed = "Attention" | ||
colorGreen = "Good" | ||
colorGrey = "Warning" | ||
) | ||
|
||
type Notifier struct { | ||
conf *config.MSTeamsV2Config | ||
tmpl *template.Template | ||
logger log.Logger | ||
client *http.Client | ||
retrier *notify.Retrier | ||
webhookURL *config.SecretURL | ||
postJSONFunc func(ctx context.Context, client *http.Client, url string, body io.Reader) (*http.Response, error) | ||
} | ||
|
||
// https://learn.microsoft.com/en-us/connectors/teams/?tabs=text1#adaptivecarditemschema | ||
type Content struct { | ||
Schema string `json:"$schema"` | ||
Type string `json:"type"` | ||
Version string `json:"version"` | ||
Body []Body `json:"body"` | ||
} | ||
|
||
type Body struct { | ||
Type string `json:"type"` | ||
Text string `json:"text"` | ||
Weight string `json:"weigth,omitempty"` | ||
Size string `json:"size,omitempty"` | ||
Wrap bool `json:"wrap,omitempty"` | ||
Style string `json:"style,omitempty"` | ||
Color string `json:"color,omitempty"` | ||
} | ||
|
||
type Attachment struct { | ||
ContentType string `json:"contentType"` | ||
ContentURL *string `json:"contentUrl"` // Use a pointer to handle null values | ||
Content Content `json:"content"` | ||
} | ||
|
||
type teamsMessage struct { | ||
Type string `json:"type"` | ||
Attachments []Attachment `json:"attachments"` | ||
} | ||
|
||
// New returns a new notifier that uses the Microsoft Teams Power Platform connector. | ||
func New(c *config.MSTeamsV2Config, t *template.Template, l log.Logger, httpOpts ...commoncfg.HTTPClientOption) (*Notifier, error) { | ||
client, err := commoncfg.NewClientFromConfig(*c.HTTPConfig, "msteamsv2", httpOpts...) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
n := &Notifier{ | ||
conf: c, | ||
tmpl: t, | ||
logger: l, | ||
client: client, | ||
retrier: ¬ify.Retrier{}, | ||
webhookURL: c.WebhookURL, | ||
postJSONFunc: notify.PostJSON, | ||
} | ||
|
||
return n, nil | ||
} | ||
|
||
func (n *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error) { | ||
key, err := notify.ExtractGroupKey(ctx) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
level.Debug(n.logger).Log("incident", key) | ||
|
||
data := notify.GetTemplateData(ctx, n.tmpl, as, n.logger) | ||
tmpl := notify.TmplText(n.tmpl, data, &err) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
title := tmpl(n.conf.Title) | ||
if err != nil { | ||
return false, err | ||
} | ||
text := tmpl(n.conf.Text) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
alerts := types.Alerts(as...) | ||
color := colorGrey | ||
switch alerts.Status() { | ||
case model.AlertFiring: | ||
color = colorRed | ||
case model.AlertResolved: | ||
color = colorGreen | ||
} | ||
|
||
var url string | ||
if n.conf.WebhookURL != nil { | ||
url = n.conf.WebhookURL.String() | ||
} else { | ||
content, err := os.ReadFile(n.conf.WebhookURLFile) | ||
if err != nil { | ||
return false, fmt.Errorf("read webhook_url_file: %w", err) | ||
} | ||
url = strings.TrimSpace(string(content)) | ||
} | ||
|
||
t := teamsMessage{ | ||
Type: "message", | ||
Attachments: []Attachment{ | ||
{ | ||
ContentType: "application/vnd.microsoft.card.adaptive", | ||
ContentURL: nil, | ||
Content: Content{ | ||
Schema: "http://adaptivecards.io/schemas/adaptive-card.json", | ||
Type: "AdaptiveCard", | ||
Version: "1.2", | ||
Body: []Body{ | ||
{ | ||
Type: "TextBlock", | ||
Text: title, | ||
Weight: "Bolder", | ||
Size: "Medium", | ||
Wrap: true, | ||
Style: "heading", | ||
Color: color, | ||
}, | ||
{ | ||
Type: "TextBlock", | ||
Text: text, | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
} | ||
|
||
var payload bytes.Buffer | ||
if err = json.NewEncoder(&payload).Encode(t); err != nil { | ||
return false, err | ||
} | ||
|
||
resp, err := n.postJSONFunc(ctx, n.client, url, &payload) | ||
if err != nil { | ||
return true, notify.RedactURL(err) | ||
} | ||
defer notify.Drain(resp) | ||
|
||
// https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using?tabs=cURL#rate-limiting-for-connectors | ||
shouldRetry, err := n.retrier.Check(resp.StatusCode, resp.Body) | ||
if err != nil { | ||
return shouldRetry, notify.NewErrorWithReason(notify.GetFailureReasonFromStatusCode(resp.StatusCode), err) | ||
} | ||
return shouldRetry, err | ||
} |
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
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