Skip to content

ENH: Adds alert persistent feature #36

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.

Sign up for GitHub

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 1 commit into from
Feb 21, 2018
Merged

ENH: Adds alert persistent feature #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ You can find more about scrapeType's on [Scrape Config](https://prometheus.io/do
|alertLabels |This parameter is translated to Prometheus alert `LABELS` statement. It allows specifying a set of additional labels to be attached to the alert. Multiple labels can be separated with comma (`,`).<br>**Example:** `severity=high,receiver=system`|No|
|alertName |The name of the alert. It is combined with the `serviceName` thus producing an unique identifier.<br>**Example:** `memoryAlert`|Yes|
|serviceName |The name of the service. It is combined with the `alertName` thus producing an unique identifier.<br>**Example:** `go-demo`|Yes|
|alertPersistent|When set to *true*, the alert will persist when the service is scaled to zero replicas.<br>**Example:** `true`|No|

Those parameters can be indexed so that multiple alerts can be defined for a service. Indexing is sequential and starts from 1. An example of indexed `alertName` could be `alertName.1=memload` and `alertName.2=diskload`.

Expand Down
1 change: 1 addition & 0 deletions prometheus/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ type Alert struct {
AlertIf string `json:"alertIf,omitempty"`
AlertLabels map[string]string `json:"alertLabels,omitempty"`
AlertName string `json:"alertName"`
AlertPersistent bool `json:"alertPersistent"`
AlertNameFormatted string
ServiceName string `json:"serviceName"`
Replicas int `json:"replicas"`
Expand Down
17 changes: 11 additions & 6 deletions server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ func (s *serve) ReconfigureHandler(w http.ResponseWriter, req *http.Request) {
logPrintf("Processing " + req.URL.String())
req.ParseForm()
scrape := s.getScrape(req)
s.deleteAlerts(scrape.ServiceName)
s.deleteAlerts(scrape.ServiceName, false)
alerts := s.getAlerts(req)
prometheus.WriteConfig(s.configPath, s.scrapes, s.alerts)
err := prometheus.Reload()
Expand All @@ -115,7 +115,7 @@ func (s *serve) RemoveHandler(w http.ResponseWriter, req *http.Request) {
serviceName := req.URL.Query().Get("serviceName")
scrape := s.scrapes[serviceName]
delete(s.scrapes, serviceName)
alerts := s.deleteAlerts(serviceName)
alerts := s.deleteAlerts(serviceName, true)
prometheus.WriteConfig(s.configPath, s.scrapes, s.alerts)
err := prometheus.Reload()
statusCode := http.StatusOK
Expand Down Expand Up @@ -241,6 +241,8 @@ func (s *serve) getAlerts(req *http.Request) []prometheus.Alert {
alertName := req.URL.Query().Get(fmt.Sprintf("alertName.%d", i))
annotations := s.getMapFromString(req.URL.Query().Get(fmt.Sprintf("alertAnnotations.%d", i)))
labels := s.getMapFromString(req.URL.Query().Get(fmt.Sprintf("alertLabels.%d", i)))
persistant := req.URL.Query().Get(fmt.Sprintf("alertPersistent.%d", i)) == "true"
Copy link
Contributor

@patrickleet patrickleet Feb 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not a big deal functionally, but there is a typo here:

persistant should be persistent

Copy link
Collaborator Author

@thomasjpfan thomasjpfan Feb 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! PR in #37


alert := prometheus.Alert{
ServiceName: alertDecode.ServiceName,
AlertName: alertName,
Expand All @@ -249,6 +251,7 @@ func (s *serve) getAlerts(req *http.Request) []prometheus.Alert {
AlertAnnotations: annotations,
AlertLabels: labels,
Replicas: replicas,
AlertPersistent: persistant,
}
s.formatAlert(&alert)
if !s.isValidAlert(&alert) {
Expand Down Expand Up @@ -322,7 +325,6 @@ func GetShortcuts() map[string]AlertIfShortcut {
logPrintf("YAML decoding reading %s, error: %v", path, err)
continue
}
fmt.Println(secretShortcuts)

for k, v := range secretShortcuts {
shortcuts[k] = v
Expand Down Expand Up @@ -483,13 +485,16 @@ func (s *serve) isValidAlert(alert *prometheus.Alert) bool {
return len(alert.AlertName) > 0 && len(alert.AlertIf) > 0
}

func (s *serve) deleteAlerts(serviceName string) []prometheus.Alert {
func (s *serve) deleteAlerts(
serviceName string, keepPersistantAlerts bool) []prometheus.Alert {
alerts := []prometheus.Alert{}
serviceNameFormatted := s.getNameFormatted(serviceName)
for k, v := range s.alerts {
if strings.HasPrefix(k, serviceNameFormatted) {
alerts = append(alerts, v)
delete(s.alerts, k)
if !keepPersistantAlerts || !v.AlertPersistent {
alerts = append(alerts, v)
delete(s.alerts, k)
}
}
}
return alerts
Expand Down
69 changes: 68 additions & 1 deletion server/server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,57 @@ func (s *ServerTestSuite) Test_ReconfigureHandler_AddsAlert() {
s.Equal(expected, serve.alerts[expected.AlertNameFormatted])
}

func (s *ServerTestSuite) Test_ReconfigureHandler_UpdatesPersistantAlert() {
// When service is reconfigured, all alert, including persistant alerts, will be removed
// and queried again.
expected := prometheus.Alert{
ServiceName: "my-service",
AlertName: "my-alert",
AlertIf: "a>b",
AlertFor: "my-for",
AlertNameFormatted: "myservice_myalert",
AlertAnnotations: map[string]string{"a1": "v1", "a2": "v2"},
AlertLabels: map[string]string{"l1": "v1"},
AlertPersistent: true,
}
rwMock := ResponseWriterMock{}
addr := fmt.Sprintf(
"/v1/docker-flow-monitor?serviceName=%s&alertName=%s&alertIf=%s&alertFor=%s&alertAnnotations=%s&alertLabels=%s&alertPersistent=%t",
expected.ServiceName,
expected.AlertName,
url.QueryEscape(expected.AlertIf),
expected.AlertFor,
url.QueryEscape("a1=v1,a2=v2"),
url.QueryEscape("l1=v1"),
expected.AlertPersistent,
)
req, _ := http.NewRequest("GET", addr, nil)

serve := New()
serve.ReconfigureHandler(rwMock, req)

s.Equal(expected, serve.alerts[expected.AlertNameFormatted])

// Change alert slightly
expected.AlertIf = "a<b"
rwMock = ResponseWriterMock{}
addr = fmt.Sprintf(
"/v1/docker-flow-monitor?serviceName=%s&alertName=%s&alertIf=%s&alertFor=%s&alertAnnotations=%s&alertLabels=%s&alertPersistent=%t",
expected.ServiceName,
expected.AlertName,
url.QueryEscape(expected.AlertIf),
expected.AlertFor,
url.QueryEscape("a1=v1,a2=v2"),
url.QueryEscape("l1=v1"),
expected.AlertPersistent,
)
req, _ = http.NewRequest("GET", addr, nil)

serve.ReconfigureHandler(rwMock, req)

s.Equal(expected, serve.alerts[expected.AlertNameFormatted])
}

func (s *ServerTestSuite) Test_ReconfigureHandler_ExpandsShortcuts() {
testData := []struct {
expected string
Expand Down Expand Up @@ -604,11 +655,12 @@ func (s *ServerTestSuite) Test_ReconfigureHandler_AddsMultipleAlerts() {
AlertAnnotations: map[string]string{"annotation": fmt.Sprintf("annotation-value-%d", i)},
AlertLabels: map[string]string{"label": fmt.Sprintf("label-value-%d", i)},
Replicas: 3,
AlertPersistent: i == 2,
})
}
rwMock := ResponseWriterMock{}
addr := fmt.Sprintf(
"/v1/docker-flow-monitor?serviceName=%s&alertName.1=%s&alertIf.1=%s&alertFor.1=%s&alertName.2=%s&alertIf.2=%s&alertFor.2=%s&alertAnnotations.1=%s&alertAnnotations.2=%s&alertLabels.1=%s&alertLabels.2=%s&replicas=3",
"/v1/docker-flow-monitor?serviceName=%s&alertName.1=%s&alertIf.1=%s&alertFor.1=%s&alertName.2=%s&alertIf.2=%s&alertFor.2=%s&alertAnnotations.1=%s&alertAnnotations.2=%s&alertLabels.1=%s&alertLabels.2=%s&replicas=3&alertPersistent.2=true",
expected[0].ServiceName,
expected[0].AlertName,
expected[0].AlertIf,
Expand Down Expand Up @@ -1123,6 +1175,21 @@ func (s *ServerTestSuite) Test_RemoveHandler_RemovesAlerts() {
s.Len(serve.alerts, 1)
}

func (s *ServerTestSuite) Test_RemoveHandler_KeepsPersistantAlerts() {

rwMock := ResponseWriterMock{}
addr := "/v1/docker-flow-monitor?serviceName=my-service-1"
req, _ := http.NewRequest("DELETE", addr, nil)

serve := New()
serve.alerts["myservice1alert1"] = prometheus.Alert{ServiceName: "my-service-1", AlertName: "my-alert-1", AlertPersistent: true}
serve.alerts["myservice1alert2"] = prometheus.Alert{ServiceName: "my-service-1", AlertName: "my-alert-2"}
serve.alerts["myservice2alert1"] = prometheus.Alert{ServiceName: "my-service-2", AlertName: "my-alert-1"}
serve.RemoveHandler(rwMock, req)

s.Len(serve.alerts, 2)
}

func (s *ServerTestSuite) Test_RemoveHandler_ReturnsJson() {
reloadOrig := prometheus.Reload
defer func() { prometheus.Reload = reloadOrig }()
Expand Down