Alerting: Split grafana and lotex routes (#44742)

* split Lotex and Grafana routes * update template to use authorize function for every route
2022-02-04 12:42:04 -05:00
parent 126ed461b1
commit ddfe2dce74
21 changed files with 2257 additions and 214 deletions
@@ -10,17 +10,26 @@ import (
 	"time"

 	"github.com/go-openapi/strfmt"
-	"github.com/grafana/grafana/pkg/components/simplejson"
-	"github.com/grafana/grafana/pkg/services/secrets"
-	"github.com/grafana/grafana/pkg/util"
 	"github.com/pkg/errors"
 	amv2 "github.com/prometheus/alertmanager/api/v2/models"
 	"github.com/prometheus/alertmanager/config"
 	"github.com/prometheus/alertmanager/pkg/labels"
 	"github.com/prometheus/common/model"
 	"gopkg.in/yaml.v3"
+
+	"github.com/grafana/grafana/pkg/components/simplejson"
+	"github.com/grafana/grafana/pkg/services/secrets"
+	"github.com/grafana/grafana/pkg/util"
 )

+// swagger:route POST /api/alertmanager/grafana/config/api/v1/alerts alertmanager RoutePostGrafanaAlertingConfig
+//
+// sets an Alerting config
+//
+//     Responses:
+//       201: Ack
+//       400: ValidationError
+
 // swagger:route POST /api/alertmanager/{Recipient}/config/api/v1/alerts alertmanager RoutePostAlertingConfig
 //
 // sets an Alerting config
@@ -29,6 +38,14 @@ import (
 //       201: Ack
 //       400: ValidationError

+// swagger:route GET /api/alertmanager/grafana/config/api/v1/alerts alertmanager RouteGetGrafanaAlertingConfig
+//
+// gets an Alerting config
+//
+//     Responses:
+//       200: GettableUserConfig
+//       400: ValidationError
+
 // swagger:route GET /api/alertmanager/{Recipient}/config/api/v1/alerts alertmanager RouteGetAlertingConfig
 //
 // gets an Alerting config
@@ -37,6 +54,14 @@ import (
 //       200: GettableUserConfig
 //       400: ValidationError

+// swagger:route DELETE /api/alertmanager/grafana/config/api/v1/alerts alertmanager RouteDeleteGrafanaAlertingConfig
+//
+// deletes the Alerting config for a tenant
+//
+//     Responses:
+//       200: Ack
+//       400: ValidationError
+
 // swagger:route DELETE /api/alertmanager/{Recipient}/config/api/v1/alerts alertmanager RouteDeleteAlertingConfig
 //
 // deletes the Alerting config for a tenant
@@ -45,6 +70,14 @@ import (
 //       200: Ack
 //       400: ValidationError

+// swagger:route GET /api/alertmanager/grafana/api/v2/status alertmanager RouteGetGrafanaAMStatus
+//
+// get alertmanager status and configuration
+//
+//     Responses:
+//       200: GettableStatus
+//       400: ValidationError
+
 // swagger:route GET /api/alertmanager/{Recipient}/api/v2/status alertmanager RouteGetAMStatus
 //
 // get alertmanager status and configuration
@@ -53,6 +86,14 @@ import (
 //       200: GettableStatus
 //       400: ValidationError

+// swagger:route GET /api/alertmanager/grafana/api/v2/alerts alertmanager RouteGetGrafanaAMAlerts
+//
+// get alertmanager alerts
+//
+//     Responses:
+//       200: gettableAlerts
+//       400: ValidationError
+
 // swagger:route GET /api/alertmanager/{Recipient}/api/v2/alerts alertmanager RouteGetAMAlerts
 //
 // get alertmanager alerts
@@ -61,6 +102,14 @@ import (
 //       200: gettableAlerts
 //       400: ValidationError

+// swagger:route POST /api/alertmanager/grafana/api/v2/alerts alertmanager RoutePostGrafanaAMAlerts
+//
+// create alertmanager alerts
+//
+//     Responses:
+//       200: Ack
+//       400: ValidationError
+
 // swagger:route POST /api/alertmanager/{Recipient}/api/v2/alerts alertmanager RoutePostAMAlerts
 //
 // create alertmanager alerts
@@ -69,6 +118,14 @@ import (
 //       200: Ack
 //       400: ValidationError

+// swagger:route GET /api/alertmanager/grafana/api/v2/alerts/groups alertmanager RouteGetGrafanaAMAlertGroups
+//
+// get alertmanager alerts
+//
+//     Responses:
+//       200: alertGroups
+//       400: ValidationError
+
 // swagger:route GET /api/alertmanager/{Recipient}/api/v2/alerts/groups alertmanager RouteGetAMAlertGroups
 //
 // get alertmanager alerts
@@ -77,6 +134,20 @@ import (
 //       200: alertGroups
 //       400: ValidationError

+// swagger:route POST /api/alertmanager/grafana/config/api/v1/receivers/test alertmanager RoutePostTestGrafanaReceivers
+//
+// Test Grafana managed receivers without saving them.
+//
+//     Responses:
+//
+//       200: Ack
+//       207: MultiStatus
+//       400: ValidationError
+//       403: PermissionDenied
+//       404: AlertManagerNotFound
+//       408: Failure
+//       409: AlertManagerNotReady
+
 // swagger:route POST /api/alertmanager/{Recipient}/config/api/v1/receivers/test alertmanager RoutePostTestReceivers
 //
 // Test Grafana managed receivers without saving them.
@@ -91,6 +162,14 @@ import (
 //       408: Failure
 //       409: AlertManagerNotReady

+// swagger:route GET /api/alertmanager/grafana/api/v2/silences alertmanager RouteGetGrafanaSilences
+//
+// get silences
+//
+//     Responses:
+//       200: gettableSilences
+//       400: ValidationError
+
 // swagger:route GET /api/alertmanager/{Recipient}/api/v2/silences alertmanager RouteGetSilences
 //
 // get silences
@@ -99,6 +178,14 @@ import (
 //       200: gettableSilences
 //       400: ValidationError

+// swagger:route POST /api/alertmanager/grafana/api/v2/silences alertmanager RouteCreateGrafanaSilence
+//
+// create silence
+//
+//     Responses:
+//       201: gettableSilence
+//       400: ValidationError
+
 // swagger:route POST /api/alertmanager/{Recipient}/api/v2/silences alertmanager RouteCreateSilence
 //
 // create silence
@@ -107,6 +194,14 @@ import (
 //       201: gettableSilence
 //       400: ValidationError

+// swagger:route GET /api/alertmanager/grafana/api/v2/silence/{SilenceId} alertmanager RouteGetGrafanaSilence
+//
+// get silence
+//
+//     Responses:
+//       200: gettableSilence
+//       400: ValidationError
+
 // swagger:route GET /api/alertmanager/{Recipient}/api/v2/silence/{SilenceId} alertmanager RouteGetSilence
 //
 // get silence
@@ -115,6 +210,14 @@ import (
 //       200: gettableSilence
 //       400: ValidationError

+// swagger:route DELETE /api/alertmanager/grafana/api/v2/silence/{SilenceId} alertmanager RouteDeleteGrafanaSilence
+//
+// delete silence
+//
+//     Responses:
+//       200: Ack
+//       400: ValidationError
+
 // swagger:route DELETE /api/alertmanager/{Recipient}/api/v2/silence/{SilenceId} alertmanager RouteDeleteSilence
 //
 // delete silence
@@ -135,7 +238,7 @@ type AlertManagerNotReady struct{}
 // swagger:model
 type MultiStatus struct{}

-// swagger:parameters RoutePostTestReceivers
+// swagger:parameters RoutePostTestReceivers RoutePostTestGrafanaReceivers
 type TestReceiversConfigParams struct {
 	// in:body
 	Body TestReceiversConfigBodyParams
@@ -176,25 +279,25 @@ type TestReceiverConfigResult struct {
 	Error  string `json:"error,omitempty"`
 }

-// swagger:parameters RouteCreateSilence
+// swagger:parameters RouteCreateSilence RouteCreateGrafanaSilence
 type CreateSilenceParams struct {
 	// in:body
 	Silence PostableSilence
 }

-// swagger:parameters RouteGetSilence RouteDeleteSilence
+// swagger:parameters RouteGetSilence RouteDeleteSilence RouteGetGrafanaSilence RouteDeleteGrafanaSilence
 type GetDeleteSilenceParams struct {
 	// in:path
 	SilenceId string
 }

-// swagger:parameters RouteGetSilences
+// swagger:parameters RouteGetSilences RouteGetGrafanaSilences
 type GetSilencesParams struct {
 	// in:query
 	Filter []string `json:"filter"`
 }

-// swagger:parameters RouteGetRuleStatuses
+// swagger:parameters RouteGetRuleStatuses RouteGetGrafanaRuleStatuses
 type GetRuleStatusesParams struct {
 	// in: query
 	DashboardUID string
@@ -299,7 +402,7 @@ type AlertGroup = amv2.AlertGroup
 // swagger:model receiver
 type Receiver = amv2.Receiver

-// swagger:parameters RouteGetAMAlerts RouteGetAMAlertGroups
+// swagger:parameters RouteGetAMAlerts RouteGetAMAlertGroups RouteGetGrafanaAMAlerts RouteGetGrafanaAMAlertGroups
 type AlertsParams struct {

 	// Show active alerts
@@ -331,13 +434,13 @@ type AlertsParams struct {
 	Receivers string `json:"receiver"`
 }

-// swagger:parameters RoutePostAMAlerts
+// swagger:parameters RoutePostAMAlerts RoutePostGrafanaAMAlerts
 type PostableAlerts struct {
 	// in:body
 	PostableAlerts []amv2.PostableAlert `yaml:"" json:""`
 }

-// swagger:parameters RoutePostAlertingConfig
+// swagger:parameters RoutePostAlertingConfig RoutePostGrafanaAlertingConfig
 type BodyAlertingConfig struct {
 	// in:body
 	Body PostableUserConfig
@@ -352,10 +455,9 @@ type BodyAlertingConfig struct {
 // testing routes
 // swagger:parameters RouteTestReceiverConfig RouteTestRuleConfig
 type DatasourceReference struct {
-	// Recipient should be "grafana" for requests to be handled by grafana
-	// and the numeric datasource id for requests to be forwarded to a datasource
+	// Recipient should be the numeric datasource id
 	// in:path
-	Recipient string
+	Recipient int
 }

 // swagger:model
@@ -5,10 +5,22 @@ import (
 	"fmt"
 	"time"

-	"github.com/grafana/grafana/pkg/services/ngalert/models"
 	"github.com/prometheus/common/model"
+
+	"github.com/grafana/grafana/pkg/services/ngalert/models"
 )

+// swagger:route Get /api/ruler/grafana/api/v1/rules ruler RouteGetGrafanaRulesConfig
+//
+// List rule groups
+//
+//     Produces:
+//     - application/json
+//
+//     Responses:
+//       202: NamespaceConfigResponse
+//
+
 // swagger:route Get /api/ruler/{Recipient}/api/v1/rules ruler RouteGetRulesConfig
 //
 // List rule groups
@@ -19,6 +31,18 @@ import (
 //     Responses:
 //       202: NamespaceConfigResponse

+// swagger:route POST /api/ruler/grafana/api/v1/rules/{Namespace} ruler RoutePostNameGrafanaRulesConfig
+//
+// Creates or updates a rule group
+//
+//     Consumes:
+//     - application/json
+//     - application/yaml
+//
+//     Responses:
+//       202: Ack
+//
+
 // swagger:route POST /api/ruler/{Recipient}/api/v1/rules/{Namespace} ruler RoutePostNameRulesConfig
 //
 // Creates or updates a rule group
@@ -30,6 +54,16 @@ import (
 //     Responses:
 //       202: Ack

+// swagger:route Get /api/ruler/grafana/api/v1/rules/{Namespace} ruler RouteGetNamespaceGrafanaRulesConfig
+//
+// Get rule groups by namespace
+//
+//     Produces:
+//     - application/json
+//
+//     Responses:
+//       202: NamespaceConfigResponse
+
 // swagger:route Get /api/ruler/{Recipient}/api/v1/rules/{Namespace} ruler RouteGetNamespaceRulesConfig
 //
 // Get rule groups by namespace
@@ -40,6 +74,13 @@ import (
 //     Responses:
 //       202: NamespaceConfigResponse

+// swagger:route Delete /api/ruler/grafana/api/v1/rules/{Namespace} ruler RouteDeleteNamespaceGrafanaRulesConfig
+//
+// Delete namespace
+//
+//     Responses:
+//       202: Ack
+
 // swagger:route Delete /api/ruler/{Recipient}/api/v1/rules/{Namespace} ruler RouteDeleteNamespaceRulesConfig
 //
 // Delete namespace
@@ -47,6 +88,16 @@ import (
 //     Responses:
 //       202: Ack

+// swagger:route Get /api/ruler/grafana/api/v1/rules/{Namespace}/{Groupname} ruler RouteGetGrafanaRuleGroupConfig
+//
+// Get rule group
+//
+//     Produces:
+//     - application/json
+//
+//     Responses:
+//       202: RuleGroupConfigResponse
+
 // swagger:route Get /api/ruler/{Recipient}/api/v1/rules/{Namespace}/{Groupname} ruler RouteGetRulegGroupConfig
 //
 // Get rule group
@@ -57,6 +108,13 @@ import (
 //     Responses:
 //       202: RuleGroupConfigResponse

+// swagger:route Delete /api/ruler/grafana/api/v1/rules/{Namespace}/{Groupname} ruler RouteDeleteGrafanaRuleGroupConfig
+//
+// Delete rule group
+//
+//     Responses:
+//       202: Ack
+
 // swagger:route Delete /api/ruler/{Recipient}/api/v1/rules/{Namespace}/{Groupname} ruler RouteDeleteRuleGroupConfig
 //
 // Delete rule group
@@ -64,7 +122,7 @@ import (
 //     Responses:
 //       202: Ack

-// swagger:parameters RoutePostNameRulesConfig
+// swagger:parameters RoutePostNameRulesConfig RoutePostNameGrafanaRulesConfig
 type NamespaceConfig struct {
 	// in:path
 	Namespace string
@@ -72,13 +130,13 @@ type NamespaceConfig struct {
 	Body PostableRuleGroupConfig
 }

-// swagger:parameters RouteGetNamespaceRulesConfig RouteDeleteNamespaceRulesConfig
+// swagger:parameters RouteGetNamespaceRulesConfig RouteDeleteNamespaceRulesConfig RouteGetNamespaceGrafanaRulesConfig RouteDeleteNamespaceGrafanaRulesConfig
 type PathNamespaceConfig struct {
 	// in: path
 	Namespace string
 }

-// swagger:parameters RouteGetRulegGroupConfig RouteDeleteRuleGroupConfig
+// swagger:parameters RouteGetRulegGroupConfig RouteDeleteRuleGroupConfig RouteGetGrafanaRuleGroupConfig RouteDeleteGrafanaRuleGroupConfig
 type PathRouleGroupConfig struct {
 	// in: path
 	Namespace string
@@ -86,7 +144,7 @@ type PathRouleGroupConfig struct {
 	Groupname string
 }

-// swagger:parameters RouteGetRulesConfig
+// swagger:parameters RouteGetRulesConfig RouteGetGrafanaRulesConfig
 type PathGetRulesParams struct {
 	// in: query
 	DashboardUID string
@@ -6,6 +6,13 @@ import (
 	v1 "github.com/prometheus/client_golang/api/prometheus/v1"
 )

+// swagger:route GET /api/prometheus/grafana/api/v1/rules prometheus RouteGetGrafanaRuleStatuses
+//
+// gets the evaluation statuses of all rules
+//
+//     Responses:
+//       200: RuleResponse
+
 // swagger:route GET /api/prometheus/{Recipient}/api/v1/rules prometheus RouteGetRuleStatuses
 //
 // gets the evaluation statuses of all rules
@@ -13,6 +20,13 @@ import (
 //     Responses:
 //       200: RuleResponse

+// swagger:route GET /api/prometheus/grafana/api/v1/alerts prometheus RouteGetGrafanaAlertStatuses
+//
+// gets the current alerts
+//
+//     Responses:
+//       200: AlertResponse
+
 // swagger:route GET /api/prometheus/{Recipient}/api/v1/alerts prometheus RouteGetAlertStatuses
 //
 // gets the current alerts
@@ -7,14 +7,28 @@ import (

 	"github.com/grafana/grafana-plugin-sdk-go/backend"

-	"github.com/grafana/grafana/pkg/services/ngalert/models"
 	"github.com/prometheus/alertmanager/config"
 	"github.com/prometheus/prometheus/promql"
+
+	"github.com/grafana/grafana/pkg/services/ngalert/models"
 )

+// swagger:route Post /api/v1/rule/test/grafana testing RouteTestRuleGrafanaConfig
+//
+// Test a rule against Grafana ruler
+//
+//     Consumes:
+//     - application/json
+//
+//     Produces:
+//     - application/json
+//
+//     Responses:
+//       200: TestRuleResponse
+
 // swagger:route Post /api/v1/rule/test/{Recipient} testing RouteTestRuleConfig
 //
-// Test rule
+// Test a rule against external data source ruler
 //
 //     Consumes:
 //     - application/json
@@ -44,7 +58,7 @@ type TestReceiverRequest struct {
 	Body ExtendedReceiver
 }

-// swagger:parameters RouteTestRuleConfig
+// swagger:parameters RouteTestRuleConfig RouteTestRuleGrafanaConfig
 type TestRuleRequest struct {
 	// in:body
 	Body TestRulePayload