Inhouse alerting api (#33129)
* init
* autogens AM route
* POST dashboards/db spec
* POST alert-notifications spec
* fix description
* re inits vendor, updates grafana to master
* go mod updates
* alerting routes
* renames to receivers
* prometheus endpoints
* align config endpoint with cortex, include templates
* Change grafana receiver type
* Update receivers.go
* rename struct to stop swagger thrashing
* add rules API
* index html
* standalone swagger ui html page
* Update README.md
* Expose GrafanaManagedAlert properties
* Some fixes
- /api/v1/rules/{Namespace} should return a map
- update ExtendedUpsertAlertDefinitionCommand properties
* am alerts routes
* rename prom swagger section for clarity, remove example endpoints
* Add missing json and yaml tags
* folder perms
* make folders POST again
* fix grafana receiver type
* rename fodler->namespace for perms
* make ruler json again
* PR fixes
* silences
* fix Ok -> Ack
* Add id to POST /api/v1/silences (#9)
Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in>
* Add POST /api/v1/alerts (#10)
Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in>
* fix silences
* Add testing endpoints
* removes grpc replace directives
* [wip] starts validation
* pkg cleanup
* go mod tidy
* ignores vendor dir
* Change response type for Cortex/Loki alerts
* receiver unmarshaling tests
* ability to split routes between AM & Grafana
* api marshaling & validation
* begins work on routing lib
* [hack] ignores embedded field in generation
* path specific datasource for alerting
* align endpoint names with cloud
* single route per Alerting config
* removes unused routing pkg
* regens spec
* adds datasource param to ruler/prom route paths
* Modifications for supporting migration
* Apply suggestions from code review
* hack for cleaning circular refs in swagger definition
* generates files
* minor fixes for prom endpoints
* decorate prom apis with required: true where applicable
* Revert "generates files"
This reverts commit ef7e975584.
* removes server autogen
* Update imported structs from ngalert
* Fix listing rules response
* Update github.com/prometheus/common dependency
* Update get silence response
* Update get silences response
* adds ruler validation & backend switching
* Fix GET /alertmanager/{DatasourceId}/config/api/v1/alerts response
* Distinct gettable and postable grafana receivers
* Remove permissions routes
* Latest JSON specs
* Fix testing routes
* inline yaml annotation on apirulenode
* yaml test & yamlv3 + comments
* Fix yaml annotations for embedded type
* Rename DatasourceId path parameter
* Implement Backend.String()
* backend zero value is a real backend
* exports DiscoveryBase
* Fix GO initialisms
* Silences: Use PostableSilence as the base struct for creating silences
* Use type alias instead of struct embedding
* More fixes to alertmanager silencing routes
* post and spec JSONs
* Split rule config to postable/gettable
* Fix empty POST /silences payload
Recreating the generated JSON specs fixes the issue
without further modifications
* better yaml unmarshaling for nested yaml docs in cortex-am configs
* regens spec
* re-adds config.receivers
* omitempty to align with prometheus API behavior
* Prefix routes with /api
* Update Alertmanager models
* Make adjustments to follow the Alertmanager API
* ruler: add for and annotations to grafana alert (#45)
* Modify testing API routes
* Fix grafana rule for field type
* Move PostableUserConfig validation to this library
* Fix PostableUserConfig YAML encoding/decoding
* Use common fields for grafana and lotex rules
* Add namespace id in GettableGrafanaRule
* Apply suggestions from code review
* fixup
* more changes
* Apply suggestions from code review
* aligns structure pre merge
* fix new imports & tests
* updates tooling readme
* goimports
* lint
* more linting!!
* revive lint
Co-authored-by: Sofia Papagiannaki <papagian@gmail.com>
Co-authored-by: Domas <domasx2@gmail.com>
Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>
Co-authored-by: gotjosh <josue@grafana.com>
Co-authored-by: David Parrott <stomp.box.yo@gmail.com>
Co-authored-by: Kyle Brandt <kyle@grafana.com>
This commit is contained in:
Owen Diehl
co-authored by
Sofia Papagiannaki
Domas
Sofia Papagiannaki
Ganesh Vernekar
gotjosh
David Parrott
Kyle Brandt
Sofia Papagiannaki
Domas
Sofia Papagiannaki
Ganesh Vernekar
gotjosh
David Parrott
Kyle Brandt
parent
6238a7c4c4
commit
e37a780e14
@@ -0,0 +1,378 @@
|
||||
package api
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"testing"
|
||||
|
||||
"github.com/prometheus/alertmanager/config"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
func Test_ApiReceiver_Marshaling(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
desc string
|
||||
input PostableApiReceiver
|
||||
err bool
|
||||
}{
|
||||
{
|
||||
desc: "success AM",
|
||||
input: PostableApiReceiver{
|
||||
Receiver: config.Receiver{
|
||||
Name: "foo",
|
||||
EmailConfigs: []*config.EmailConfig{{}},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "success GM",
|
||||
input: PostableApiReceiver{
|
||||
Receiver: config.Receiver{
|
||||
Name: "foo",
|
||||
},
|
||||
PostableGrafanaReceivers: PostableGrafanaReceivers{
|
||||
GrafanaManagedReceivers: []*PostableGrafanaReceiver{{}},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "failure mixed",
|
||||
input: PostableApiReceiver{
|
||||
Receiver: config.Receiver{
|
||||
Name: "foo",
|
||||
EmailConfigs: []*config.EmailConfig{{}},
|
||||
},
|
||||
PostableGrafanaReceivers: PostableGrafanaReceivers{
|
||||
GrafanaManagedReceivers: []*PostableGrafanaReceiver{{}},
|
||||
},
|
||||
},
|
||||
err: true,
|
||||
},
|
||||
} {
|
||||
t.Run(tc.desc, func(t *testing.T) {
|
||||
encoded, err := json.Marshal(tc.input)
|
||||
require.Nil(t, err)
|
||||
|
||||
var out PostableApiReceiver
|
||||
err = json.Unmarshal(encoded, &out)
|
||||
|
||||
if tc.err {
|
||||
require.Error(t, err)
|
||||
} else {
|
||||
require.Nil(t, err)
|
||||
require.Equal(t, tc.input, out)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_AllReceivers(t *testing.T) {
|
||||
input := &config.Route{
|
||||
Receiver: "foo",
|
||||
Routes: []*config.Route{
|
||||
{
|
||||
Receiver: "bar",
|
||||
Routes: []*config.Route{
|
||||
{
|
||||
Receiver: "bazz",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Receiver: "buzz",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
require.Equal(t, []string{"foo", "bar", "bazz", "buzz"}, AllReceivers(input))
|
||||
}
|
||||
|
||||
func Test_ApiAlertingConfig_Marshaling(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
desc string
|
||||
input PostableApiAlertingConfig
|
||||
err bool
|
||||
}{
|
||||
{
|
||||
desc: "success am",
|
||||
input: PostableApiAlertingConfig{
|
||||
Config: Config{
|
||||
Route: &config.Route{
|
||||
Receiver: "am",
|
||||
Routes: []*config.Route{
|
||||
{
|
||||
Receiver: "am",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
Receivers: []*PostableApiReceiver{
|
||||
{
|
||||
Receiver: config.Receiver{
|
||||
Name: "am",
|
||||
EmailConfigs: []*config.EmailConfig{{}},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "success graf",
|
||||
input: PostableApiAlertingConfig{
|
||||
Config: Config{
|
||||
Route: &config.Route{
|
||||
Receiver: "graf",
|
||||
Routes: []*config.Route{
|
||||
{
|
||||
Receiver: "graf",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
Receivers: []*PostableApiReceiver{
|
||||
{
|
||||
Receiver: config.Receiver{
|
||||
Name: "graf",
|
||||
},
|
||||
PostableGrafanaReceivers: PostableGrafanaReceivers{
|
||||
GrafanaManagedReceivers: []*PostableGrafanaReceiver{{}},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "failure undefined am receiver",
|
||||
input: PostableApiAlertingConfig{
|
||||
Config: Config{
|
||||
Route: &config.Route{
|
||||
Receiver: "am",
|
||||
Routes: []*config.Route{
|
||||
{
|
||||
Receiver: "unmentioned",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
Receivers: []*PostableApiReceiver{
|
||||
{
|
||||
Receiver: config.Receiver{
|
||||
Name: "am",
|
||||
EmailConfigs: []*config.EmailConfig{{}},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
err: true,
|
||||
},
|
||||
{
|
||||
desc: "failure undefined graf receiver",
|
||||
input: PostableApiAlertingConfig{
|
||||
Config: Config{
|
||||
Route: &config.Route{
|
||||
Receiver: "graf",
|
||||
Routes: []*config.Route{
|
||||
{
|
||||
Receiver: "unmentioned",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
Receivers: []*PostableApiReceiver{
|
||||
{
|
||||
Receiver: config.Receiver{
|
||||
Name: "graf",
|
||||
},
|
||||
PostableGrafanaReceivers: PostableGrafanaReceivers{
|
||||
GrafanaManagedReceivers: []*PostableGrafanaReceiver{{}},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
err: true,
|
||||
},
|
||||
} {
|
||||
t.Run(tc.desc, func(t *testing.T) {
|
||||
encoded, err := json.Marshal(tc.input)
|
||||
require.Nil(t, err)
|
||||
|
||||
var out PostableApiAlertingConfig
|
||||
err = json.Unmarshal(encoded, &out)
|
||||
|
||||
if tc.err {
|
||||
require.Error(t, err)
|
||||
} else {
|
||||
require.Nil(t, err)
|
||||
require.Equal(t, tc.input, out)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_PostableApiReceiver_Unmarshaling_YAML(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
desc string
|
||||
input string
|
||||
rtype ReceiverType
|
||||
}{
|
||||
{
|
||||
desc: "grafana receivers",
|
||||
input: `
|
||||
name: grafana_managed
|
||||
grafana_managed_receiver_configs:
|
||||
- uid: alertmanager UID
|
||||
name: an alert manager receiver
|
||||
type: prometheus-alertmanager
|
||||
sendreminder: false
|
||||
disableresolvemessage: false
|
||||
frequency: 5m
|
||||
isdefault: false
|
||||
settings: {}
|
||||
securesettings:
|
||||
basicAuthPassword: <basicAuthPassword>
|
||||
- uid: dingding UID
|
||||
name: a dingding receiver
|
||||
type: dingding
|
||||
sendreminder: false
|
||||
disableresolvemessage: false
|
||||
frequency: 5m
|
||||
isdefault: false`,
|
||||
rtype: GrafanaReceiverType,
|
||||
},
|
||||
{
|
||||
desc: "receiver",
|
||||
input: `
|
||||
name: example-email
|
||||
email_configs:
|
||||
- to: 'youraddress@example.org'`,
|
||||
rtype: AlertmanagerReceiverType,
|
||||
},
|
||||
} {
|
||||
t.Run(tc.desc, func(t *testing.T) {
|
||||
var r PostableApiReceiver
|
||||
err := yaml.Unmarshal([]byte(tc.input), &r)
|
||||
require.Nil(t, err)
|
||||
assert.Equal(t, tc.rtype, r.Type())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_GettableUserConfigUnmarshaling(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
desc, input string
|
||||
output GettableUserConfig
|
||||
err bool
|
||||
}{
|
||||
{
|
||||
desc: "empty",
|
||||
input: ``,
|
||||
output: GettableUserConfig{},
|
||||
},
|
||||
{
|
||||
desc: "empty-ish",
|
||||
input: `
|
||||
template_files: {}
|
||||
alertmanager_config: ""
|
||||
`,
|
||||
output: GettableUserConfig{
|
||||
TemplateFiles: map[string]string{},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "bad type for template",
|
||||
input: `
|
||||
template_files: abc
|
||||
alertmanager_config: ""
|
||||
`,
|
||||
err: true,
|
||||
},
|
||||
{
|
||||
desc: "existing templates",
|
||||
input: `
|
||||
template_files:
|
||||
foo: bar
|
||||
alertmanager_config: ""
|
||||
`,
|
||||
output: GettableUserConfig{
|
||||
TemplateFiles: map[string]string{"foo": "bar"},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "existing templates inline",
|
||||
input: `
|
||||
template_files: {foo: bar}
|
||||
alertmanager_config: ""
|
||||
`,
|
||||
output: GettableUserConfig{
|
||||
TemplateFiles: map[string]string{"foo": "bar"},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "existing am config",
|
||||
input: `
|
||||
template_files: {foo: bar}
|
||||
alertmanager_config: |
|
||||
route:
|
||||
receiver: am
|
||||
continue: false
|
||||
routes:
|
||||
- receiver: am
|
||||
continue: false
|
||||
templates: []
|
||||
receivers:
|
||||
- name: am
|
||||
email_configs:
|
||||
- to: foo
|
||||
from: bar
|
||||
headers:
|
||||
Bazz: buzz
|
||||
text: hi
|
||||
html: there
|
||||
`,
|
||||
output: GettableUserConfig{
|
||||
TemplateFiles: map[string]string{"foo": "bar"},
|
||||
AlertmanagerConfig: GettableApiAlertingConfig{
|
||||
Config: Config{
|
||||
Templates: []string{},
|
||||
Route: &config.Route{
|
||||
Receiver: "am",
|
||||
Routes: []*config.Route{
|
||||
{
|
||||
Receiver: "am",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
Receivers: []*GettableApiReceiver{
|
||||
{
|
||||
Receiver: config.Receiver{
|
||||
Name: "am",
|
||||
EmailConfigs: []*config.EmailConfig{{
|
||||
To: "foo",
|
||||
From: "bar",
|
||||
Headers: map[string]string{
|
||||
"Bazz": "buzz",
|
||||
},
|
||||
Text: "hi",
|
||||
HTML: "there",
|
||||
}},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
} {
|
||||
t.Run(tc.desc, func(t *testing.T) {
|
||||
var out GettableUserConfig
|
||||
err := yaml.Unmarshal([]byte(tc.input), &out)
|
||||
if tc.err {
|
||||
require.Error(t, err)
|
||||
return
|
||||
}
|
||||
require.Nil(t, err)
|
||||
require.Equal(t, tc.output, out)
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user