feat(alerting): Add new providers for Datadog, IFTTT, Line, NewRelic, Plivo, RocketChat, SendGrid, Signal, SIGNL4, Splunk, Squadcast, Vonage, Webex and Zapier (#1224)
* feat(alerting): Add new providers for Datadog, IFTTT, Line, NewRelic, Plivo, RocketChat, SendGrid, Signal, SIGNL4, Splunk, Squadcast, Vonage, Webex and Zapier Relevant: https://github.com/TwiN/gatus/discussions/1223 Fixes #1073 Fixes #1074 * chore: Clean up code * docs: Fix table formatting * Update alerting/provider/datadog/datadog.go * Update alerting/provider/signal/signal.go * Update alerting/provider/ifttt/ifttt.go * Update alerting/provider/newrelic/newrelic.go * Update alerting/provider/squadcast/squadcast.go * Update alerting/provider/squadcast/squadcast.go
This commit is contained in:
TwiN
220
alerting/provider/splunk/splunk.go
Normal file
220
alerting/provider/splunk/splunk.go
Normal file
@@ -0,0 +1,220 @@
|
||||
package splunk
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"github.com/TwiN/gatus/v5/alerting/alert"
|
||||
"github.com/TwiN/gatus/v5/client"
|
||||
"github.com/TwiN/gatus/v5/config/endpoint"
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
var (
|
||||
ErrHecURLNotSet = errors.New("hec-url not set")
|
||||
ErrHecTokenNotSet = errors.New("hec-token not set")
|
||||
ErrDuplicateGroupOverride = errors.New("duplicate group override")
|
||||
)
|
||||
|
||||
type Config struct {
|
||||
HecURL string `yaml:"hec-url"` // Splunk HEC (HTTP Event Collector) URL
|
||||
HecToken string `yaml:"hec-token"` // Splunk HEC token
|
||||
Source string `yaml:"source,omitempty"` // Event source
|
||||
SourceType string `yaml:"sourcetype,omitempty"` // Event source type
|
||||
Index string `yaml:"index,omitempty"` // Splunk index
|
||||
}
|
||||
|
||||
func (cfg *Config) Validate() error {
|
||||
if len(cfg.HecURL) == 0 {
|
||||
return ErrHecURLNotSet
|
||||
}
|
||||
if len(cfg.HecToken) == 0 {
|
||||
return ErrHecTokenNotSet
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (cfg *Config) Merge(override *Config) {
|
||||
if len(override.HecURL) > 0 {
|
||||
cfg.HecURL = override.HecURL
|
||||
}
|
||||
if len(override.HecToken) > 0 {
|
||||
cfg.HecToken = override.HecToken
|
||||
}
|
||||
if len(override.Source) > 0 {
|
||||
cfg.Source = override.Source
|
||||
}
|
||||
if len(override.SourceType) > 0 {
|
||||
cfg.SourceType = override.SourceType
|
||||
}
|
||||
if len(override.Index) > 0 {
|
||||
cfg.Index = override.Index
|
||||
}
|
||||
}
|
||||
|
||||
// AlertProvider is the configuration necessary for sending an alert using Splunk
|
||||
type AlertProvider struct {
|
||||
DefaultConfig Config `yaml:",inline"`
|
||||
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// Override is a case under which the default integration is overridden
|
||||
type Override struct {
|
||||
Group string `yaml:"group"`
|
||||
Config `yaml:",inline"`
|
||||
}
|
||||
|
||||
// Validate the provider's configuration
|
||||
func (provider *AlertProvider) Validate() error {
|
||||
registeredGroups := make(map[string]bool)
|
||||
if provider.Overrides != nil {
|
||||
for _, override := range provider.Overrides {
|
||||
if isAlreadyRegistered := registeredGroups[override.Group]; isAlreadyRegistered || override.Group == "" {
|
||||
return ErrDuplicateGroupOverride
|
||||
}
|
||||
registeredGroups[override.Group] = true
|
||||
}
|
||||
}
|
||||
return provider.DefaultConfig.Validate()
|
||||
}
|
||||
|
||||
// Send an alert using the provider
|
||||
func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
|
||||
cfg, err := provider.GetConfig(ep.Group, alert)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
body, err := provider.buildRequestBody(cfg, ep, alert, result, resolved)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
buffer := bytes.NewBuffer(body)
|
||||
request, err := http.NewRequest(http.MethodPost, fmt.Sprintf("%s/services/collector/event", cfg.HecURL), buffer)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
request.Header.Set("Content-Type", "application/json")
|
||||
request.Header.Set("Authorization", fmt.Sprintf("Splunk %s", cfg.HecToken))
|
||||
response, err := client.GetHTTPClient(nil).Do(request)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer response.Body.Close()
|
||||
if response.StatusCode >= 400 {
|
||||
body, _ := io.ReadAll(response.Body)
|
||||
return fmt.Errorf("call to splunk alert returned status code %d: %s", response.StatusCode, string(body))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
type Body struct {
|
||||
Time int64 `json:"time"`
|
||||
Source string `json:"source,omitempty"`
|
||||
SourceType string `json:"sourcetype,omitempty"`
|
||||
Index string `json:"index,omitempty"`
|
||||
Event Event `json:"event"`
|
||||
}
|
||||
|
||||
type Event struct {
|
||||
AlertType string `json:"alert_type"`
|
||||
Endpoint string `json:"endpoint"`
|
||||
Group string `json:"group,omitempty"`
|
||||
Status string `json:"status"`
|
||||
Message string `json:"message"`
|
||||
Description string `json:"description,omitempty"`
|
||||
Conditions []*endpoint.ConditionResult `json:"conditions,omitempty"`
|
||||
}
|
||||
|
||||
// buildRequestBody builds the request body for the provider
|
||||
func (provider *AlertProvider) buildRequestBody(cfg *Config, ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) ([]byte, error) {
|
||||
var alertType, status, message string
|
||||
if resolved {
|
||||
alertType = "resolved"
|
||||
status = "ok"
|
||||
message = fmt.Sprintf("Alert for %s has been resolved after passing successfully %d time(s) in a row", ep.DisplayName(), alert.SuccessThreshold)
|
||||
} else {
|
||||
alertType = "triggered"
|
||||
status = "critical"
|
||||
message = fmt.Sprintf("Alert for %s has been triggered due to having failed %d time(s) in a row", ep.DisplayName(), alert.FailureThreshold)
|
||||
}
|
||||
event := Event{
|
||||
AlertType: alertType,
|
||||
Endpoint: ep.DisplayName(),
|
||||
Group: ep.Group,
|
||||
Status: status,
|
||||
Message: message,
|
||||
Description: alert.GetDescription(),
|
||||
}
|
||||
if len(result.ConditionResults) > 0 {
|
||||
event.Conditions = result.ConditionResults
|
||||
}
|
||||
body := Body{
|
||||
Time: time.Now().Unix(),
|
||||
Event: event,
|
||||
}
|
||||
// Set optional fields
|
||||
if cfg.Source != "" {
|
||||
body.Source = cfg.Source
|
||||
} else {
|
||||
body.Source = "gatus"
|
||||
}
|
||||
if cfg.SourceType != "" {
|
||||
body.SourceType = cfg.SourceType
|
||||
} else {
|
||||
body.SourceType = "gatus:alert"
|
||||
}
|
||||
if cfg.Index != "" {
|
||||
body.Index = cfg.Index
|
||||
}
|
||||
bodyAsJSON, err := json.Marshal(body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return bodyAsJSON, nil
|
||||
}
|
||||
|
||||
// GetDefaultAlert returns the provider's default alert configuration
|
||||
func (provider *AlertProvider) GetDefaultAlert() *alert.Alert {
|
||||
return provider.DefaultAlert
|
||||
}
|
||||
|
||||
// GetConfig returns the configuration for the provider with the overrides applied
|
||||
func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error) {
|
||||
cfg := provider.DefaultConfig
|
||||
// Handle group overrides
|
||||
if provider.Overrides != nil {
|
||||
for _, override := range provider.Overrides {
|
||||
if group == override.Group {
|
||||
cfg.Merge(&override.Config)
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
// Handle alert overrides
|
||||
if len(alert.ProviderOverride) != 0 {
|
||||
overrideConfig := Config{}
|
||||
if err := yaml.Unmarshal(alert.ProviderOverrideAsBytes(), &overrideConfig); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
cfg.Merge(&overrideConfig)
|
||||
}
|
||||
// Validate the configuration
|
||||
err := cfg.Validate()
|
||||
return &cfg, err
|
||||
}
|
||||
|
||||
// ValidateOverrides validates the alert's provider override and, if present, the group override
|
||||
func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
|
||||
_, err := provider.GetConfig(group, alert)
|
||||
return err
|
||||
}
|
||||
155
alerting/provider/splunk/splunk_test.go
Normal file
155
alerting/provider/splunk/splunk_test.go
Normal file
@@ -0,0 +1,155 @@
|
||||
package splunk
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"testing"
|
||||
|
||||
"github.com/TwiN/gatus/v5/alerting/alert"
|
||||
"github.com/TwiN/gatus/v5/client"
|
||||
"github.com/TwiN/gatus/v5/config/endpoint"
|
||||
"github.com/TwiN/gatus/v5/test"
|
||||
)
|
||||
|
||||
func TestAlertProvider_Validate(t *testing.T) {
|
||||
scenarios := []struct {
|
||||
name string
|
||||
provider AlertProvider
|
||||
expected error
|
||||
}{
|
||||
{
|
||||
name: "valid",
|
||||
provider: AlertProvider{DefaultConfig: Config{HecURL: "https://splunk.example.com:8088", HecToken: "token123"}},
|
||||
expected: nil,
|
||||
},
|
||||
{
|
||||
name: "valid-with-index",
|
||||
provider: AlertProvider{DefaultConfig: Config{HecURL: "https://splunk.example.com:8088", HecToken: "token123", Index: "main"}},
|
||||
expected: nil,
|
||||
},
|
||||
{
|
||||
name: "invalid-hec-url",
|
||||
provider: AlertProvider{DefaultConfig: Config{HecToken: "token123"}},
|
||||
expected: ErrHecURLNotSet,
|
||||
},
|
||||
{
|
||||
name: "invalid-hec-token",
|
||||
provider: AlertProvider{DefaultConfig: Config{HecURL: "https://splunk.example.com:8088"}},
|
||||
expected: ErrHecTokenNotSet,
|
||||
},
|
||||
}
|
||||
for _, scenario := range scenarios {
|
||||
t.Run(scenario.name, func(t *testing.T) {
|
||||
err := scenario.provider.Validate()
|
||||
if err != scenario.expected {
|
||||
t.Errorf("expected %v, got %v", scenario.expected, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAlertProvider_Send(t *testing.T) {
|
||||
defer client.InjectHTTPClient(nil)
|
||||
firstDescription := "description-1"
|
||||
secondDescription := "description-2"
|
||||
scenarios := []struct {
|
||||
name string
|
||||
provider AlertProvider
|
||||
alert alert.Alert
|
||||
resolved bool
|
||||
mockRoundTripper test.MockRoundTripper
|
||||
expectedError bool
|
||||
}{
|
||||
{
|
||||
name: "triggered",
|
||||
provider: AlertProvider{DefaultConfig: Config{HecURL: "https://splunk.example.com:8088", HecToken: "token123"}},
|
||||
alert: alert.Alert{Description: &firstDescription, SuccessThreshold: 5, FailureThreshold: 3},
|
||||
resolved: false,
|
||||
mockRoundTripper: test.MockRoundTripper(func(r *http.Request) *http.Response {
|
||||
if r.URL.Path != "/services/collector/event" {
|
||||
t.Errorf("expected path /services/collector/event, got %s", r.URL.Path)
|
||||
}
|
||||
if r.Header.Get("Authorization") != "Splunk token123" {
|
||||
t.Errorf("expected Authorization header to be 'Splunk token123', got %s", r.Header.Get("Authorization"))
|
||||
}
|
||||
body := make(map[string]interface{})
|
||||
json.NewDecoder(r.Body).Decode(&body)
|
||||
if body["time"] == nil {
|
||||
t.Error("expected 'time' field in request body")
|
||||
}
|
||||
event := body["event"].(map[string]interface{})
|
||||
if event["alert_type"] != "triggered" {
|
||||
t.Errorf("expected alert_type to be 'triggered', got %v", event["alert_type"])
|
||||
}
|
||||
if event["status"] != "critical" {
|
||||
t.Errorf("expected status to be 'critical', got %v", event["status"])
|
||||
}
|
||||
return &http.Response{StatusCode: http.StatusOK, Body: http.NoBody}
|
||||
}),
|
||||
expectedError: false,
|
||||
},
|
||||
{
|
||||
name: "resolved",
|
||||
provider: AlertProvider{DefaultConfig: Config{HecURL: "https://splunk.example.com:8088", HecToken: "token123", Index: "main"}},
|
||||
alert: alert.Alert{Description: &secondDescription, SuccessThreshold: 5, FailureThreshold: 3},
|
||||
resolved: true,
|
||||
mockRoundTripper: test.MockRoundTripper(func(r *http.Request) *http.Response {
|
||||
body := make(map[string]interface{})
|
||||
json.NewDecoder(r.Body).Decode(&body)
|
||||
if body["index"] != "main" {
|
||||
t.Errorf("expected index to be 'main', got %v", body["index"])
|
||||
}
|
||||
event := body["event"].(map[string]interface{})
|
||||
if event["alert_type"] != "resolved" {
|
||||
t.Errorf("expected alert_type to be 'resolved', got %v", event["alert_type"])
|
||||
}
|
||||
if event["status"] != "ok" {
|
||||
t.Errorf("expected status to be 'ok', got %v", event["status"])
|
||||
}
|
||||
return &http.Response{StatusCode: http.StatusOK, Body: http.NoBody}
|
||||
}),
|
||||
expectedError: false,
|
||||
},
|
||||
{
|
||||
name: "error-response",
|
||||
provider: AlertProvider{DefaultConfig: Config{HecURL: "https://splunk.example.com:8088", HecToken: "token123"}},
|
||||
alert: alert.Alert{Description: &firstDescription, SuccessThreshold: 5, FailureThreshold: 3},
|
||||
resolved: false,
|
||||
mockRoundTripper: test.MockRoundTripper(func(r *http.Request) *http.Response {
|
||||
return &http.Response{StatusCode: http.StatusForbidden, Body: http.NoBody}
|
||||
}),
|
||||
expectedError: true,
|
||||
},
|
||||
}
|
||||
for _, scenario := range scenarios {
|
||||
t.Run(scenario.name, func(t *testing.T) {
|
||||
client.InjectHTTPClient(&http.Client{Transport: scenario.mockRoundTripper})
|
||||
err := scenario.provider.Send(
|
||||
&endpoint.Endpoint{Name: "endpoint-name"},
|
||||
&scenario.alert,
|
||||
&endpoint.Result{
|
||||
ConditionResults: []*endpoint.ConditionResult{
|
||||
{Condition: "[CONNECTED] == true", Success: scenario.resolved},
|
||||
{Condition: "[STATUS] == 200", Success: scenario.resolved},
|
||||
},
|
||||
},
|
||||
scenario.resolved,
|
||||
)
|
||||
if scenario.expectedError && err == nil {
|
||||
t.Error("expected error, got none")
|
||||
}
|
||||
if !scenario.expectedError && err != nil {
|
||||
t.Error("expected no error, got", err.Error())
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAlertProvider_GetDefaultAlert(t *testing.T) {
|
||||
if (&AlertProvider{DefaultAlert: &alert.Alert{}}).GetDefaultAlert() == nil {
|
||||
t.Error("expected default alert to be not nil")
|
||||
}
|
||||
if (&AlertProvider{DefaultAlert: nil}).GetDefaultAlert() != nil {
|
||||
t.Error("expected default alert to be nil")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user