diff --git a/alerting/provider/opsgenie/opsgenie.go b/alerting/provider/opsgenie/opsgenie.go index a24eff2b..a4b5746b 100644 --- a/alerting/provider/opsgenie/opsgenie.go +++ b/alerting/provider/opsgenie/opsgenie.go @@ -4,62 +4,54 @@ import ( "bytes" "encoding/json" "fmt" - "github.com/TwiN/gatus/v3/alerting/alert" - "github.com/TwiN/gatus/v3/client" - "github.com/TwiN/gatus/v3/core" "io" "net/http" "strconv" "strings" + + "github.com/TwiN/gatus/v3/alerting/alert" + "github.com/TwiN/gatus/v3/client" + "github.com/TwiN/gatus/v3/core" ) const ( restAPI = "https://api.opsgenie.com/v2/alerts" ) -type opsgenieAlertCreateRequest struct { - Message string `json:"message"` - Priority string `json:"priority"` - Source string `json:"source"` - Entity string `json:"entity"` - Alias string `json:"alias"` - Description string `json:"description"` - Tags []string `json:"tags,omitempty"` - Details map[string]string `json:"details"` -} - -type opsgenieAlertCloseRequest struct { - Source string `json:"source"` - Note string `json:"note"` -} - type AlertProvider struct { + // APIKey to use for APIKey string `yaml:"api-key"` - //Priority define priority to be used in opsgenie alert payload - // defaults: P1 + // Priority to be used in Opsgenie alert payload + // + // default: P1 Priority string `yaml:"priority"` - //Source define source to be used in opsgenie alert payload - // defaults: gatus + // Source define source to be used in Opsgenie alert payload + // + // default: gatus Source string `yaml:"source"` - //EntityPrefix is a prefix to be used in entity argument in opsgenie alert payload - // defaults: gatus- + // EntityPrefix is a prefix to be used in entity argument in Opsgenie alert payload + // + // default: gatus- EntityPrefix string `yaml:"entity-prefix"` - //AliasPrefix is a prefix to be used in alias argument in opsgenie alert payload - // defaults: gatus-healthcheck- + //AliasPrefix is a prefix to be used in alias argument in Opsgenie alert payload + // + // default: gatus-healthcheck- AliasPrefix string `yaml:"alias-prefix"` - //tags define tags to be used in opsgenie alert payload - // defaults: [] + // Tags to be used in Opsgenie alert payload + // + // default: [] Tags []string `yaml:"tags"` // DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"` } +// IsValid returns whether the provider's configuration is valid func (provider *AlertProvider) IsValid() bool { return len(provider.APIKey) > 0 } @@ -69,19 +61,15 @@ func (provider *AlertProvider) IsValid() bool { // Relevant: https://docs.opsgenie.com/docs/alert-api func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error { err := provider.createAlert(endpoint, alert, result, resolved) - if err != nil { return err } - if resolved { err = provider.closeAlert(endpoint, alert) - if err != nil { return err } } - if alert.IsSendingOnResolved() { if resolved { // The alert has been resolved and there's no error, so we can clear the alert's ResolveKey @@ -90,61 +78,46 @@ func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, alert.ResolveKey = provider.alias(buildKey(endpoint)) } } - return nil } func (provider *AlertProvider) createAlert(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error { payload := provider.buildCreateRequestBody(endpoint, alert, result, resolved) - _, err := provider.sendRequest(restAPI, http.MethodPost, payload) - return err } func (provider *AlertProvider) closeAlert(endpoint *core.Endpoint, alert *alert.Alert) error { payload := provider.buildCloseRequestBody(endpoint, alert) url := restAPI + "/" + provider.alias(buildKey(endpoint)) + "/close?identifierType=alias" - _, err := provider.sendRequest(url, http.MethodPost, payload) - return err } func (provider *AlertProvider) sendRequest(url, method string, payload interface{}) (*http.Response, error) { - body, err := json.Marshal(payload) - if err != nil { return nil, fmt.Errorf("fail to build alert payload: %v", payload) } - request, err := http.NewRequest(method, url, bytes.NewBuffer(body)) - if err != nil { return nil, err } - request.Header.Set("Content-Type", "application/json") request.Header.Set("Authorization", "GenieKey "+provider.APIKey) - res, err := client.GetHTTPClient(nil).Do(request) - if err != nil { return nil, err } - if res.StatusCode > 399 { rBody, _ := io.ReadAll(res.Body) return nil, fmt.Errorf("call to provider alert returned status code %d: %s", res.StatusCode, string(rBody)) } - return res, nil } -func (provider *AlertProvider) buildCreateRequestBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) opsgenieAlertCreateRequest { +func (provider *AlertProvider) buildCreateRequestBody(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) alertCreateRequest { var message, description, results string - if resolved { message = fmt.Sprintf("RESOLVED: %s - %s", endpoint.Name, alert.GetDescription()) description = fmt.Sprintf("An alert for *%s* has been resolved after passing successfully %d time(s) in a row", endpoint.Name, alert.SuccessThreshold) @@ -152,12 +125,9 @@ func (provider *AlertProvider) buildCreateRequestBody(endpoint *core.Endpoint, a message = fmt.Sprintf("%s - %s", endpoint.Name, alert.GetDescription()) description = fmt.Sprintf("An alert for *%s* has been triggered due to having failed %d time(s) in a row", endpoint.Name, alert.FailureThreshold) } - - if endpoint.Group != "" { message = fmt.Sprintf("[%s] %s", endpoint.Group, message) } - for _, conditionResult := range result.ConditionResults { var prefix string if conditionResult.Success { @@ -167,9 +137,7 @@ func (provider *AlertProvider) buildCreateRequestBody(endpoint *core.Endpoint, a } results += fmt.Sprintf("%s - `%s`\n", prefix, conditionResult.Condition) } - description = description + "\n" + results - key := buildKey(endpoint) details := map[string]string{ "endpoint:url": endpoint.URL, @@ -179,18 +147,15 @@ func (provider *AlertProvider) buildCreateRequestBody(endpoint *core.Endpoint, a "result:dns_code": result.DNSRCode, "result:errors": strings.Join(result.Errors, ","), } - for k, v := range details { if v == "" { delete(details, k) } } - if result.HTTPStatus > 0 { details["result:http_status"] = strconv.Itoa(result.HTTPStatus) } - - return opsgenieAlertCreateRequest{ + return alertCreateRequest{ Message: message, Description: description, Source: provider.source(), @@ -202,8 +167,8 @@ func (provider *AlertProvider) buildCreateRequestBody(endpoint *core.Endpoint, a } } -func (provider *AlertProvider) buildCloseRequestBody(endpoint *core.Endpoint, alert *alert.Alert) opsgenieAlertCloseRequest { - return opsgenieAlertCloseRequest{ +func (provider *AlertProvider) buildCloseRequestBody(endpoint *core.Endpoint, alert *alert.Alert) alertCloseRequest { + return alertCloseRequest{ Source: buildKey(endpoint), Note: fmt.Sprintf("RESOLVED: %s - %s", endpoint.Name, alert.GetDescription()), } @@ -211,21 +176,17 @@ func (provider *AlertProvider) buildCloseRequestBody(endpoint *core.Endpoint, al func (provider *AlertProvider) source() string { source := provider.Source - if source == "" { return "gatus" } - return source } func (provider *AlertProvider) alias(key string) string { alias := provider.AliasPrefix - if alias == "" { alias = "gatus-healthcheck-" } - return alias + key } @@ -234,34 +195,46 @@ func (provider *AlertProvider) entity(key string) string { if alias == "" { alias = "gatus-" } - return alias + key } func (provider *AlertProvider) priority() string { priority := provider.Priority - if priority == "" { return "P1" } - return priority } +// GetDefaultAlert returns the provider's default alert configuration func (provider AlertProvider) GetDefaultAlert() *alert.Alert { return provider.DefaultAlert } func buildKey(endpoint *core.Endpoint) string { name := toKebabCase(endpoint.Name) - if endpoint.Group == "" { return name } - return toKebabCase(endpoint.Group) + "-" + name } func toKebabCase(val string) string { return strings.ToLower(strings.ReplaceAll(val, " ", "-")) } + +type alertCreateRequest struct { + Message string `json:"message"` + Priority string `json:"priority"` + Source string `json:"source"` + Entity string `json:"entity"` + Alias string `json:"alias"` + Description string `json:"description"` + Tags []string `json:"tags,omitempty"` + Details map[string]string `json:"details"` +} + +type alertCloseRequest struct { + Source string `json:"source"` + Note string `json:"note"` +} diff --git a/alerting/provider/opsgenie/opsgenie_test.go b/alerting/provider/opsgenie/opsgenie_test.go index b9d65f5c..d6b9cd95 100644 --- a/alerting/provider/opsgenie/opsgenie_test.go +++ b/alerting/provider/opsgenie/opsgenie_test.go @@ -1,13 +1,14 @@ package opsgenie import ( + "net/http" + "reflect" + "testing" + "github.com/TwiN/gatus/v3/alerting/alert" "github.com/TwiN/gatus/v3/client" "github.com/TwiN/gatus/v3/core" "github.com/TwiN/gatus/v3/test" - "net/http" - "reflect" - "testing" ) func TestAlertProvider_IsValid(t *testing.T) { @@ -23,9 +24,7 @@ func TestAlertProvider_IsValid(t *testing.T) { func TestAlertProvider_Send(t *testing.T) { defer client.InjectHTTPClient(nil) - description := "my bad alert description" - scenarios := []struct { Name string Provider AlertProvider @@ -79,7 +78,6 @@ func TestAlertProvider_Send(t *testing.T) { for _, scenario := range scenarios { t.Run(scenario.Name, func(t *testing.T) { client.InjectHTTPClient(&http.Client{Transport: scenario.MockRoundTripper}) - err := scenario.Provider.Send( &core.Endpoint{Name: "endpoint-name"}, &scenario.Alert, @@ -103,9 +101,7 @@ func TestAlertProvider_Send(t *testing.T) { func TestAlertProvider_buildCreateRequestBody(t *testing.T) { t.Parallel() - description := "alert description" - scenarios := []struct { Name string Provider *AlertProvider @@ -113,7 +109,7 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { Endpoint *core.Endpoint Result *core.Result Resolved bool - want opsgenieAlertCreateRequest + want alertCreateRequest }{ { Name: "missing all params (unresolved)", @@ -122,7 +118,7 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { Endpoint: &core.Endpoint{}, Result: &core.Result{}, Resolved: false, - want: opsgenieAlertCreateRequest{ + want: alertCreateRequest{ Message: " - ", Priority: "P1", Source: "gatus", @@ -140,7 +136,7 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { Endpoint: &core.Endpoint{}, Result: &core.Result{}, Resolved: true, - want: opsgenieAlertCreateRequest{ + want: alertCreateRequest{ Message: "RESOLVED: - ", Priority: "P1", Source: "gatus", @@ -174,7 +170,7 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { }, }, Resolved: false, - want: opsgenieAlertCreateRequest{ + want: alertCreateRequest{ Message: "my supper app - " + description, Priority: "P1", Source: "gatus", @@ -212,7 +208,7 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { }, }, Resolved: true, - want: opsgenieAlertCreateRequest{ + want: alertCreateRequest{ Message: "RESOLVED: my mega app - " + description, Priority: "P5", Source: "gatus-hc", @@ -251,7 +247,7 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { }, }, Resolved: false, - want: opsgenieAlertCreateRequest{ + want: alertCreateRequest{ Message: "[end game] my app - " + description, Priority: "P1", Source: "gatus", @@ -270,7 +266,6 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { }, }, } - for _, scenario := range scenarios { actual := scenario t.Run(actual.Name, func(t *testing.T) { @@ -283,27 +278,24 @@ func TestAlertProvider_buildCreateRequestBody(t *testing.T) { func TestAlertProvider_buildCloseRequestBody(t *testing.T) { t.Parallel() - description := "alert description" - scenarios := []struct { Name string Provider *AlertProvider Alert *alert.Alert Endpoint *core.Endpoint - want opsgenieAlertCloseRequest + want alertCloseRequest }{ { Name: "Missing all values", Provider: &AlertProvider{}, Alert: &alert.Alert{}, Endpoint: &core.Endpoint{}, - want: opsgenieAlertCloseRequest{ + want: alertCloseRequest{ Source: "", Note: "RESOLVED: - ", }, }, - { Name: "Basic values", Provider: &AlertProvider{}, @@ -313,7 +305,7 @@ func TestAlertProvider_buildCloseRequestBody(t *testing.T) { Endpoint: &core.Endpoint{ Name: "endpoint name", }, - want: opsgenieAlertCloseRequest{ + want: alertCloseRequest{ Source: "endpoint-name", Note: "RESOLVED: endpoint name - alert description", },