-
Notifications
You must be signed in to change notification settings - Fork 2.2k
feat: incident.io Notifier #4372
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
rorymalcolm
wants to merge
2
commits into
prometheus:main
Choose a base branch
from
rorymalcolm:rorymalcolm/incidentio-notifier
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,205 @@ | ||
| // Copyright 2025 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 incidentio | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "log/slog" | ||
| "net/http" | ||
| "os" | ||
| "strings" | ||
|
|
||
| commoncfg "github.com/prometheus/common/config" | ||
|
|
||
| "github.com/prometheus/alertmanager/config" | ||
| "github.com/prometheus/alertmanager/notify" | ||
| "github.com/prometheus/alertmanager/template" | ||
| "github.com/prometheus/alertmanager/types" | ||
| ) | ||
|
|
||
| // Notifier implements a Notifier for incident.io. | ||
| type Notifier struct { | ||
| conf *config.IncidentioConfig | ||
| tmpl *template.Template | ||
| logger *slog.Logger | ||
| client *http.Client | ||
| retrier *notify.Retrier | ||
| } | ||
|
|
||
| // New returns a new incident.io notifier. | ||
| func New(conf *config.IncidentioConfig, t *template.Template, l *slog.Logger, httpOpts ...commoncfg.HTTPClientOption) (*Notifier, error) { | ||
| // Handle authentication configuration | ||
| if conf.HTTPConfig == nil { | ||
| conf.HTTPConfig = &commoncfg.HTTPClientConfig{} | ||
| } | ||
|
|
||
| // Ensure one of AlertSourceToken or AlertSourceTokenFile is provided | ||
| if conf.AlertSourceToken == "" && conf.AlertSourceTokenFile == "" { | ||
| return nil, errors.New("one of alert_source_token or alert_source_token_file must be configured") | ||
| } | ||
|
|
||
| // Error if authorization is already set in HTTPConfig | ||
| if conf.HTTPConfig.Authorization != nil { | ||
| return nil, errors.New("cannot specify both alert_source_token/alert_source_token_file and http_config.authorization") | ||
| } | ||
|
|
||
| // Set authorization from token or token file | ||
| if conf.AlertSourceToken != "" { | ||
| conf.HTTPConfig.Authorization = &commoncfg.Authorization{ | ||
| Type: "Bearer", | ||
| Credentials: commoncfg.Secret(conf.AlertSourceToken), | ||
| } | ||
| } else if conf.AlertSourceTokenFile != "" { | ||
| content, err := os.ReadFile(conf.AlertSourceTokenFile) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to read alert_source_token_file: %w", err) | ||
| } | ||
|
|
||
| conf.HTTPConfig.Authorization = &commoncfg.Authorization{ | ||
| Type: "Bearer", | ||
| Credentials: commoncfg.Secret(strings.TrimSpace(string(content))), | ||
| } | ||
| } | ||
|
|
||
| client, err := commoncfg.NewClientFromConfig(*conf.HTTPConfig, "incidentio", httpOpts...) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &Notifier{ | ||
| conf: conf, | ||
| tmpl: t, | ||
| logger: l, | ||
| client: client, | ||
| // Always retry on 429 (rate limiting) and 5xx response codes. | ||
| retrier: ¬ify.Retrier{ | ||
| RetryCodes: []int{ | ||
| http.StatusTooManyRequests, // 429 | ||
| }, | ||
| CustomDetailsFunc: errDetails, | ||
| }, | ||
| }, nil | ||
| } | ||
|
|
||
| // Message defines the JSON object sent to incident.io endpoints. | ||
| type Message struct { | ||
| *template.Data | ||
|
|
||
| // The protocol version. | ||
| Version string `json:"version"` | ||
| GroupKey string `json:"groupKey"` | ||
| TruncatedAlerts uint64 `json:"truncatedAlerts"` | ||
| } | ||
|
|
||
| func truncateAlerts(maxAlerts uint64, alerts []*types.Alert) ([]*types.Alert, uint64) { | ||
| if maxAlerts != 0 && uint64(len(alerts)) > maxAlerts { | ||
| return alerts[:maxAlerts], uint64(len(alerts)) - maxAlerts | ||
| } | ||
|
|
||
| return alerts, 0 | ||
| } | ||
|
|
||
| // Notify implements the Notifier interface. | ||
| func (n *Notifier) Notify(ctx context.Context, alerts ...*types.Alert) (bool, error) { | ||
| alerts, numTruncated := truncateAlerts(n.conf.MaxAlerts, alerts) | ||
| data := notify.GetTemplateData(ctx, n.tmpl, alerts, n.logger) | ||
|
|
||
| groupKey, err := notify.ExtractGroupKey(ctx) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| n.logger.Debug("incident.io notification", "groupKey", groupKey) | ||
|
|
||
| msg := &Message{ | ||
| Version: "1", | ||
| Data: data, | ||
| GroupKey: groupKey.String(), | ||
| TruncatedAlerts: numTruncated, | ||
| } | ||
|
|
||
| var buf bytes.Buffer | ||
| if err := json.NewEncoder(&buf).Encode(msg); err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| var url string | ||
| if n.conf.URL != nil { | ||
| url = n.conf.URL.String() | ||
| } else { | ||
| content, err := os.ReadFile(n.conf.URLFile) | ||
| if err != nil { | ||
| return false, fmt.Errorf("read url_file: %w", err) | ||
| } | ||
| url = strings.TrimSpace(string(content)) | ||
| } | ||
|
|
||
| if n.conf.Timeout > 0 { | ||
| postCtx, cancel := context.WithTimeoutCause(ctx, n.conf.Timeout, fmt.Errorf("configured incident.io timeout reached (%s)", n.conf.Timeout)) | ||
| defer cancel() | ||
| ctx = postCtx | ||
| } | ||
|
|
||
| resp, err := notify.PostJSON(ctx, n.client, url, &buf) | ||
| if err != nil { | ||
| if ctx.Err() != nil { | ||
| err = fmt.Errorf("%w: %w", err, context.Cause(ctx)) | ||
| } | ||
| return true, notify.RedactURL(err) | ||
| } | ||
| defer notify.Drain(resp) | ||
|
|
||
| shouldRetry, err := n.retrier.Check(resp.StatusCode, resp.Body) | ||
| if err != nil { | ||
| return shouldRetry, notify.NewErrorWithReason(notify.GetFailureReasonFromStatusCode(resp.StatusCode), err) | ||
| } | ||
| return shouldRetry, err | ||
| } | ||
|
|
||
| // errDetails extracts error details from the response for better error messages. | ||
| func errDetails(status int, body io.Reader) string { | ||
| if body == nil { | ||
| return "" | ||
| } | ||
|
|
||
| // Try to decode the error message from JSON response | ||
| var errorResponse struct { | ||
| Message string `json:"message"` | ||
| Errors []string `json:"errors"` | ||
| Error string `json:"error"` | ||
| } | ||
|
|
||
| if err := json.NewDecoder(body).Decode(&errorResponse); err != nil { | ||
| return "" | ||
| } | ||
|
|
||
| // Format the error message | ||
| var parts []string | ||
| if errorResponse.Message != "" { | ||
| parts = append(parts, errorResponse.Message) | ||
| } | ||
| if errorResponse.Error != "" { | ||
| parts = append(parts, errorResponse.Error) | ||
| } | ||
| if len(errorResponse.Errors) > 0 { | ||
| parts = append(parts, strings.Join(errorResponse.Errors, ", ")) | ||
| } | ||
|
|
||
| return strings.Join(parts, ": ") | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about adding a field
Metadatato this struct? Something similar to theDetailsfield in theOpsgenieConfigstruct.This would enable users to define additional data (see incident.io API definition for reference).