-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2948 from metalmatze/discord
notify/discord: Create Discord integration
- Loading branch information
Showing
7 changed files
with
321 additions
and
3 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| // Copyright 2021 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 discord | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "net/http" | ||
|
|
||
| "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 = 0x992D22 | ||
| colorGreen = 0x2ECC71 | ||
| colorGrey = 0x95A5A6 | ||
| ) | ||
|
|
||
| // Notifier implements a Notifier for Discord notifications. | ||
| type Notifier struct { | ||
| conf *config.DiscordConfig | ||
| tmpl *template.Template | ||
| logger log.Logger | ||
| client *http.Client | ||
| retrier *notify.Retrier | ||
| webhookURL *config.SecretURL | ||
| } | ||
|
|
||
| // New returns a new Discord notifier. | ||
| func New(c *config.DiscordConfig, t *template.Template, l log.Logger, httpOpts ...commoncfg.HTTPClientOption) (*Notifier, error) { | ||
| client, err := commoncfg.NewClientFromConfig(*c.HTTPConfig, "discord", httpOpts...) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| n := &Notifier{ | ||
| conf: c, | ||
| tmpl: t, | ||
| logger: l, | ||
| client: client, | ||
| retrier: ¬ify.Retrier{}, | ||
| webhookURL: c.WebhookURL, | ||
| } | ||
| return n, nil | ||
| } | ||
|
|
||
| type webhook struct { | ||
| Content string `json:"content"` | ||
| Embeds []webhookEmbed `json:"embeds"` | ||
| } | ||
|
|
||
| type webhookEmbed struct { | ||
| Title string `json:"title"` | ||
| Description string `json:"description"` | ||
| Color int `json:"color"` | ||
| } | ||
|
|
||
| // Notify implements the Notifier interface. | ||
| 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) | ||
|
|
||
| alerts := types.Alerts(as...) | ||
| 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 | ||
| } | ||
| description := tmpl(n.conf.Message) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| color := colorGrey | ||
| if alerts.Status() == model.AlertFiring { | ||
| color = colorRed | ||
| } | ||
| if alerts.Status() == model.AlertResolved { | ||
| color = colorGreen | ||
| } | ||
|
|
||
| w := webhook{ | ||
| Embeds: []webhookEmbed{{ | ||
| Title: title, | ||
| Description: description, | ||
| Color: color, | ||
| }}, | ||
| } | ||
|
|
||
| var payload bytes.Buffer | ||
| if err = json.NewEncoder(&payload).Encode(w); err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| resp, err := notify.PostJSON(ctx, n.client, n.webhookURL.String(), &payload) | ||
| if err != nil { | ||
| return true, notify.RedactURL(err) | ||
| } | ||
|
|
||
| shouldRetry, err := n.retrier.Check(resp.StatusCode, resp.Body) | ||
| if err != nil { | ||
| return shouldRetry, err | ||
| } | ||
| return false, nil | ||
| } |
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,129 @@ | ||
| // Copyright 2021 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 discord | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/url" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/go-kit/log" | ||
| commoncfg "github.com/prometheus/common/config" | ||
| "github.com/prometheus/common/model" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/prometheus/alertmanager/config" | ||
| "github.com/prometheus/alertmanager/notify" | ||
| "github.com/prometheus/alertmanager/notify/test" | ||
| "github.com/prometheus/alertmanager/types" | ||
| ) | ||
|
|
||
| // This is a test URL that has been modified to not be valid. | ||
| var testWebhookURL, _ = url.Parse("https://discord.com/api/webhooks/971139602272503183/78ZWZ4V3xwZUBKRFF-G9m1nRtDtNTChl_WzW6Q4kxShjSB02oLSiPTPa8TS2tTGO9EYf") | ||
|
|
||
| func TestDiscordRetry(t *testing.T) { | ||
| notifier, err := New( | ||
| &config.DiscordConfig{ | ||
| WebhookURL: &config.SecretURL{URL: testWebhookURL}, | ||
| HTTPConfig: &commoncfg.HTTPClientConfig{}, | ||
| }, | ||
| test.CreateTmpl(t), | ||
| log.NewNopLogger(), | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
| for statusCode, expected := range test.RetryTests(test.DefaultRetryCodes()) { | ||
| actual, _ := notifier.retrier.Check(statusCode, nil) | ||
| require.Equal(t, expected, actual, fmt.Sprintf("retry - error on status %d", statusCode)) | ||
| } | ||
| } | ||
|
|
||
| func TestDiscordTemplating(t *testing.T) { | ||
| srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| dec := json.NewDecoder(r.Body) | ||
| out := make(map[string]interface{}) | ||
| err := dec.Decode(&out) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| })) | ||
| defer srv.Close() | ||
| u, _ := url.Parse(srv.URL) | ||
|
|
||
| for _, tc := range []struct { | ||
| title string | ||
| cfg *config.DiscordConfig | ||
|
|
||
| retry bool | ||
| errMsg string | ||
| }{ | ||
| { | ||
| title: "full-blown message", | ||
| cfg: &config.DiscordConfig{ | ||
| Title: `{{ template "discord.default.title" . }}`, | ||
| Message: `{{ template "discord.default.message" . }}`, | ||
| }, | ||
| retry: false, | ||
| }, | ||
| { | ||
| title: "title with templating errors", | ||
| cfg: &config.DiscordConfig{ | ||
| Title: "{{ ", | ||
| }, | ||
| errMsg: "template: :1: unclosed action", | ||
| }, | ||
| { | ||
| title: "message with templating errors", | ||
| cfg: &config.DiscordConfig{ | ||
| Title: `{{ template "discord.default.title" . }}`, | ||
| Message: "{{ ", | ||
| }, | ||
| errMsg: "template: :1: unclosed action", | ||
| }, | ||
| } { | ||
| t.Run(tc.title, func(t *testing.T) { | ||
| tc.cfg.WebhookURL = &config.SecretURL{URL: u} | ||
| tc.cfg.HTTPConfig = &commoncfg.HTTPClientConfig{} | ||
| pd, err := New(tc.cfg, test.CreateTmpl(t), log.NewNopLogger()) | ||
| require.NoError(t, err) | ||
|
|
||
| ctx := context.Background() | ||
| ctx = notify.WithGroupKey(ctx, "1") | ||
|
|
||
| ok, err := pd.Notify(ctx, []*types.Alert{ | ||
| { | ||
| Alert: model.Alert{ | ||
| Labels: model.LabelSet{ | ||
| "lbl1": "val1", | ||
| }, | ||
| StartsAt: time.Now(), | ||
| EndsAt: time.Now().Add(time.Hour), | ||
| }, | ||
| }, | ||
| }...) | ||
| if tc.errMsg == "" { | ||
| require.NoError(t, err) | ||
| } else { | ||
| require.Error(t, err) | ||
| require.Contains(t, err.Error(), tc.errMsg) | ||
| } | ||
| require.Equal(t, tc.retry, ok) | ||
| }) | ||
| } | ||
| } |
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