Skip to content

Commit

Permalink
Add timeout option for webhook notifier.
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Simpson <steve@grafana.com>
  • Loading branch information
stevesg committed Nov 28, 2024
1 parent 82b89dc commit b6d1f67
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 0 deletions.
3 changes: 3 additions & 0 deletions config/notifiers.go
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,9 @@ type WebhookConfig struct {
// Alerts exceeding this threshold will be truncated. Setting this to 0
// allows an unlimited number of alerts.
MaxAlerts uint64 `yaml:"max_alerts" json:"max_alerts"`

// Timeout is the maximum time allowed to invoke the webhook.
Timeout *time.Duration `yaml:"timeout" json:"timeout"`
}

// UnmarshalYAML implements the yaml.Unmarshaler interface.
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1594,6 +1594,12 @@ url_file: <filepath>
# above this threshold are truncated. When leaving this at its default value of
# 0, all alerts are included.
[ max_alerts: <int> | default = 0 ]
# The maximum time to wait for a webhook request to complete, before failing the
# request and allowing it to be retried.
# NOTE: This will have no effect if set higher than the group_interval.
[ timeout: <duration> | default = <none> ]
```

The Alertmanager
Expand Down
10 changes: 10 additions & 0 deletions notify/webhook/webhook.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"log/slog"
"net/http"
Expand Down Expand Up @@ -112,8 +113,17 @@ func (n *Notifier) Notify(ctx context.Context, alerts ...*types.Alert) (bool, er
url = strings.TrimSpace(string(content))
}

if n.conf.Timeout != nil {
postCtx, cancel := context.WithTimeoutCause(ctx, *n.conf.Timeout, fmt.Errorf("configured webhook timeout (%s) reached", *n.conf.Timeout))
defer cancel()
ctx = postCtx
}

resp, err := notify.PostJSON(ctx, n.client, url, &buf)
if err != nil {
if errors.Is(err, context.DeadlineExceeded) && ctx.Err() != nil {
err = context.Cause(ctx)
}
return true, notify.RedactURL(err)
}
defer notify.Drain(resp)
Expand Down
49 changes: 49 additions & 0 deletions test/with_api_v2/acceptance/send_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -464,3 +464,52 @@ receivers:

t.Log(co.Check())
}

func TestWebhookTimeout(t *testing.T) {
t.Parallel()

// This integration test uses an extended group_interval to check that
// the webhook level timeout has the desired effect, and that notification
// sending is retried in this case.
conf := `
route:
receiver: "default"
group_by: [alertname]
group_wait: 1s
group_interval: 1m
repeat_interval: 1m
receivers:
- name: "default"
webhook_configs:
- url: 'http://%s'
timeout: 500ms
`

at := NewAcceptanceTest(t, &AcceptanceOpts{
Tolerance: 150 * time.Millisecond,
})

co := at.Collector("webhook")
wh := NewWebhook(t, co)

wh.Func = func(ts float64) bool {
// Make some webhook requests slow enough to hit the webhook
// timeout, but not so slow as to hit the dispatcher timeout.
if ts < 3 {
time.Sleep(time.Second)
return true
}
return false
}

am := at.AlertmanagerCluster(fmt.Sprintf(conf, wh.Address()), 1)

am.Push(At(1), Alert("alertname", "test1"))

co.Want(Between(3, 4), Alert("alertname", "test1").Active(1))

at.Run()

t.Log(co.Check())
}

0 comments on commit b6d1f67

Please sign in to comment.