-
-
Notifications
You must be signed in to change notification settings - Fork 611
feat(alerting): Implement new Teams Workflow alert #847
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
fb6a71e
POC Teams Workflow Alerting
JamesHillyard 6c548c7
Document Teams Workflow Alert
JamesHillyard 93afd46
Rename 'teamsworkflow' to 'teams-workflows'
JamesHillyard b80463e
Fix README Table Format
JamesHillyard da1194f
Merge branch 'master' into TeamsWorkflowAlert
TwiN e218697
Fix Test to Expect Correct Emoji
JamesHillyard 0b560fc
Merge branch 'master' into TeamsWorkflowAlert
JamesHillyard 7cc5bd3
Merge branch 'master' into TeamsWorkflowAlert
TwiN 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,182 @@ | ||
| package teamsworkflows | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
|
|
||
| "github.com/TwiN/gatus/v5/alerting/alert" | ||
| "github.com/TwiN/gatus/v5/client" | ||
| "github.com/TwiN/gatus/v5/config/endpoint" | ||
| ) | ||
|
|
||
| // AlertProvider is the configuration necessary for sending an alert using Teams | ||
| type AlertProvider struct { | ||
| WebhookURL string `yaml:"webhook-url"` | ||
|
|
||
| // DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type | ||
| DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"` | ||
|
|
||
| // Overrides is a list of Override that may be prioritized over the default configuration | ||
| Overrides []Override `yaml:"overrides,omitempty"` | ||
|
|
||
| // Title is the title of the message that will be sent | ||
| Title string `yaml:"title,omitempty"` | ||
| } | ||
|
|
||
| // Override is a case under which the default integration is overridden | ||
| type Override struct { | ||
| Group string `yaml:"group"` | ||
| WebhookURL string `yaml:"webhook-url"` | ||
| } | ||
|
|
||
| // IsValid returns whether the provider's configuration is valid | ||
| func (provider *AlertProvider) IsValid() bool { | ||
| registeredGroups := make(map[string]bool) | ||
| if provider.Overrides != nil { | ||
| for _, override := range provider.Overrides { | ||
| if isAlreadyRegistered := registeredGroups[override.Group]; isAlreadyRegistered || override.Group == "" || len(override.WebhookURL) == 0 { | ||
| return false | ||
| } | ||
| registeredGroups[override.Group] = true | ||
| } | ||
| } | ||
| return len(provider.WebhookURL) > 0 | ||
| } | ||
|
|
||
| // Send an alert using the provider | ||
| func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error { | ||
| buffer := bytes.NewBuffer(provider.buildRequestBody(ep, alert, result, resolved)) | ||
| request, err := http.NewRequest(http.MethodPost, provider.getWebhookURLForGroup(ep.Group), buffer) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| request.Header.Set("Content-Type", "application/json") | ||
| response, err := client.GetHTTPClient(nil).Do(request) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer response.Body.Close() | ||
| if response.StatusCode > 399 { | ||
| body, _ := io.ReadAll(response.Body) | ||
| return fmt.Errorf("call to provider alert returned status code %d: %s", response.StatusCode, string(body)) | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| // AdaptiveCardBody represents the structure of an Adaptive Card | ||
| type AdaptiveCardBody struct { | ||
| Type string `json:"type"` | ||
| Version string `json:"version"` | ||
| Body []CardBody `json:"body"` | ||
| } | ||
|
|
||
| // CardBody represents the body of the Adaptive Card | ||
| type CardBody struct { | ||
| Type string `json:"type"` | ||
| Text string `json:"text,omitempty"` | ||
| Wrap bool `json:"wrap"` | ||
| Separator bool `json:"separator,omitempty"` | ||
| Size string `json:"size,omitempty"` | ||
| Weight string `json:"weight,omitempty"` | ||
| Items []CardBody `json:"items,omitempty"` | ||
| Facts []Fact `json:"facts,omitempty"` | ||
| FactSet *FactSetBody `json:"factSet,omitempty"` | ||
| } | ||
|
|
||
| // FactSetBody represents the FactSet in the Adaptive Card | ||
| type FactSetBody struct { | ||
| Type string `json:"type"` | ||
| Facts []Fact `json:"facts"` | ||
| } | ||
|
|
||
| // Fact represents an individual fact in the FactSet | ||
| type Fact struct { | ||
| Title string `json:"title"` | ||
| Value string `json:"value"` | ||
| } | ||
|
|
||
| // buildRequestBody builds the request body for the provider | ||
| func (provider *AlertProvider) buildRequestBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) []byte { | ||
| var message string | ||
| if resolved { | ||
| message = fmt.Sprintf("An alert for **%s** has been resolved after passing successfully %d time(s) in a row.", ep.DisplayName(), alert.SuccessThreshold) | ||
| } else { | ||
| message = fmt.Sprintf("An alert for **%s** has been triggered due to having failed %d time(s) in a row.", ep.DisplayName(), alert.FailureThreshold) | ||
| } | ||
|
|
||
| // Configure default title if it's not provided | ||
| title := "⛑ Gatus" | ||
| if provider.Title != "" { | ||
| title = provider.Title | ||
| } | ||
|
|
||
| // Build the facts from the condition results | ||
| var facts []Fact | ||
| for _, conditionResult := range result.ConditionResults { | ||
| var key string | ||
| if conditionResult.Success { | ||
| key = "✅" | ||
| } else { | ||
| key = "❌" | ||
| } | ||
| facts = append(facts, Fact{ | ||
| Title: key, | ||
| Value: conditionResult.Condition, | ||
| }) | ||
| } | ||
|
|
||
| cardContent := AdaptiveCardBody{ | ||
| Type: "AdaptiveCard", | ||
| Version: "1.4", // Version 1.5 and 1.6 doesn't seem to be supported by Teams as of 27/08/2024 | ||
| Body: []CardBody{ | ||
| { | ||
| Type: "TextBlock", | ||
| Text: title, | ||
| Size: "Medium", | ||
| Weight: "Bolder", | ||
| }, | ||
| { | ||
| Type: "TextBlock", | ||
| Text: message, | ||
| Wrap: true, | ||
| }, | ||
| { | ||
| Type: "FactSet", | ||
| Facts: facts, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| attachment := map[string]interface{}{ | ||
| "contentType": "application/vnd.microsoft.card.adaptive", | ||
| "content": cardContent, | ||
| } | ||
|
|
||
| payload := map[string]interface{}{ | ||
| "type": "message", | ||
| "attachments": []interface{}{attachment}, | ||
| } | ||
|
|
||
| bodyAsJSON, _ := json.Marshal(payload) | ||
| return bodyAsJSON | ||
| } | ||
|
|
||
| // getWebhookURLForGroup returns the appropriate Webhook URL integration to for a given group | ||
| func (provider *AlertProvider) getWebhookURLForGroup(group string) string { | ||
| if provider.Overrides != nil { | ||
| for _, override := range provider.Overrides { | ||
| if group == override.Group { | ||
| return override.WebhookURL | ||
| } | ||
| } | ||
| } | ||
| return provider.WebhookURL | ||
| } | ||
|
|
||
| // GetDefaultAlert returns the provider's default alert configuration | ||
| func (provider *AlertProvider) GetDefaultAlert() *alert.Alert { | ||
| return provider.DefaultAlert | ||
| } |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.