-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: alertmanager sink Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * feat: alertmanager sink Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * refactor: reduce VR update error verbosity Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * feat: alertmanager sink Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * docs: add screenshot to README.md Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * docs: clarify detail & failure annotations Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * feat: add basic auth support Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * feat: add TLS support Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * refactor: remove unused var from sink.Configure; add unit tests Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * test: increase coverage Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * test: increase coverage Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * refactor: misc. tidying Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * docs: update README Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> * chore: log removal of path from alertmanager endpoint Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com> --------- Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
- Loading branch information
1 parent
36ce4a1
commit 855e70e
Showing
13 changed files
with
442 additions
and
12 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 |
|---|---|---|
|
|
@@ -65,6 +65,7 @@ spec: | |
| type: string | ||
| type: | ||
| enum: | ||
| - alertmanager | ||
| - slack | ||
| type: string | ||
| required: | ||
|
|
||
This file contains 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 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 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 |
|---|---|---|
|
|
@@ -65,6 +65,7 @@ spec: | |
| type: string | ||
| type: | ||
| enum: | ||
| - alertmanager | ||
| - slack | ||
| type: string | ||
| required: | ||
|
|
||
This file contains 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 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,161 @@ | ||
| package sinks | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "crypto/tls" | ||
| "crypto/x509" | ||
| "encoding/base64" | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| "github.com/pkg/errors" | ||
|
|
||
| "github.com/spectrocloud-labs/validator/api/v1alpha1" | ||
| ) | ||
|
|
||
| type AlertmanagerSink struct { | ||
| client Client | ||
| log logr.Logger | ||
|
|
||
| endpoint string | ||
| username string | ||
| password string | ||
| } | ||
|
|
||
| type Alert struct { | ||
| Annotations map[string]string `json:"annotations"` | ||
| Labels map[string]string `json:"labels"` | ||
| } | ||
|
|
||
| var ( | ||
| InvalidEndpoint = errors.New("invalid Alertmanager config: endpoint scheme and host are required") | ||
| EndpointRequired = errors.New("invalid Alertmanager config: endpoint required") | ||
| ) | ||
|
|
||
| func (s *AlertmanagerSink) Configure(c Client, config map[string][]byte) error { | ||
| // endpoint | ||
| endpoint, ok := config["endpoint"] | ||
| if !ok { | ||
| return EndpointRequired | ||
| } | ||
| u, err := url.Parse(string(endpoint)) | ||
| if err != nil { | ||
| return errors.Wrap(err, "invalid Alertmanager config: failed to parse endpoint") | ||
| } | ||
| if u.Scheme == "" || u.Host == "" { | ||
| return InvalidEndpoint | ||
| } | ||
| if u.Path != "" { | ||
| s.log.V(1).Info("stripping path from Alertmanager endpoint", "path", u.Path) | ||
| u.Path = "" | ||
| } | ||
| s.endpoint = fmt.Sprintf("%s/api/v2/alerts", u.String()) | ||
|
|
||
| // basic auth | ||
| s.username = string(config["username"]) | ||
| s.password = string(config["password"]) | ||
|
|
||
| // tls | ||
| var caCertPool *x509.CertPool | ||
| var insecureSkipVerify bool | ||
|
|
||
| insecure, ok := config["insecureSkipVerify"] | ||
| if ok { | ||
| insecureSkipVerify, err = strconv.ParseBool(string(insecure)) | ||
| if err != nil { | ||
| return errors.Wrap(err, "invalid Alertmanager config: failed to parse insecureSkipVerify") | ||
| } | ||
| } | ||
| caCert, ok := config["caCert"] | ||
| if ok { | ||
| caCertPool, err = x509.SystemCertPool() | ||
| if err != nil { | ||
| return errors.Wrap(err, "invalid Alertmanager config: failed to get system cert pool") | ||
| } | ||
| caCertPool.AppendCertsFromPEM(caCert) | ||
| } | ||
|
|
||
| c.hclient.Transport = &http.Transport{ | ||
| TLSClientConfig: &tls.Config{ | ||
| InsecureSkipVerify: insecureSkipVerify, | ||
| MinVersion: tls.VersionTLS12, | ||
| RootCAs: caCertPool, | ||
| }, | ||
| } | ||
| s.client = c | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (s *AlertmanagerSink) Emit(r v1alpha1.ValidationResult) error { | ||
| alerts := make([]Alert, 0, len(r.Status.Conditions)) | ||
|
|
||
| for i, c := range r.Status.Conditions { | ||
| alerts = append(alerts, Alert{ | ||
| Labels: map[string]string{ | ||
| "alertname": r.Name, | ||
| "plugin": r.Spec.Plugin, | ||
| "validation_result": strconv.Itoa(i + 1), | ||
| "expected_results": strconv.Itoa(r.Spec.ExpectedResults), | ||
| }, | ||
| Annotations: map[string]string{ | ||
| "state": string(r.Status.State), | ||
| "validation_rule": c.ValidationRule, | ||
| "validation_type": c.ValidationType, | ||
| "message": c.Message, | ||
| "status": string(c.Status), | ||
| "detail": strings.Join(c.Details, "|"), | ||
| "failure": strings.Join(c.Failures, "|"), | ||
| "last_validation_time": c.LastValidationTime.String(), | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| body, err := json.Marshal(alerts) | ||
| if err != nil { | ||
| s.log.Error(err, "failed to marshal alerts", "alerts", alerts) | ||
| return err | ||
| } | ||
| s.log.V(1).Info("Alertmanager message", "payload", body) | ||
|
|
||
| req, err := http.NewRequest(http.MethodPost, s.endpoint, bytes.NewReader(body)) | ||
| if err != nil { | ||
| s.log.Error(err, "failed to create HTTP POST request", "endpoint", s.endpoint) | ||
| return err | ||
| } | ||
| req.Header.Add("Content-Type", "application/json") | ||
|
|
||
| if s.username != "" && s.password != "" { | ||
| req.Header.Add(basicAuthHeader(s.username, s.password)) | ||
| } | ||
|
|
||
| resp, err := s.client.hclient.Do(req) | ||
| defer func() { | ||
| if resp != nil { | ||
| _ = resp.Body.Close() | ||
| } | ||
| }() | ||
| if err != nil { | ||
| s.log.Error(err, "failed to post alert", "endpoint", s.endpoint) | ||
| return err | ||
| } | ||
| if resp.StatusCode != 200 { | ||
| s.log.V(0).Info("failed to post alert", "endpoint", s.endpoint, "status", resp.Status, "code", resp.StatusCode) | ||
| return SinkEmissionFailed | ||
| } | ||
|
|
||
| s.log.V(0).Info("Successfully posted alert to Alertmanager", "endpoint", s.endpoint, "status", resp.Status, "code", resp.StatusCode) | ||
| return nil | ||
| } | ||
|
|
||
| func basicAuthHeader(username, password string) (string, string) { | ||
| auth := base64.StdEncoding.EncodeToString( | ||
| bytes.Join([][]byte{[]byte(username), []byte(password)}, []byte(":")), | ||
| ) | ||
| return "Authorization", fmt.Sprintf("Basic %s", auth) | ||
| } |
Oops, something went wrong.