alerting.go 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. package api
  2. import (
  3. "fmt"
  4. "github.com/grafana/grafana/pkg/api/dtos"
  5. "github.com/grafana/grafana/pkg/bus"
  6. "github.com/grafana/grafana/pkg/middleware"
  7. "github.com/grafana/grafana/pkg/models"
  8. "github.com/grafana/grafana/pkg/services/alerting"
  9. "github.com/grafana/grafana/pkg/services/guardian"
  10. )
  11. func ValidateOrgAlert(c *middleware.Context) {
  12. id := c.ParamsInt64(":alertId")
  13. query := models.GetAlertByIdQuery{Id: id}
  14. if err := bus.Dispatch(&query); err != nil {
  15. c.JsonApiErr(404, "Alert not found", nil)
  16. return
  17. }
  18. if c.OrgId != query.Result.OrgId {
  19. c.JsonApiErr(403, "You are not allowed to edit/view alert", nil)
  20. return
  21. }
  22. }
  23. func GetAlertStatesForDashboard(c *middleware.Context) Response {
  24. dashboardId := c.QueryInt64("dashboardId")
  25. if dashboardId == 0 {
  26. return ApiError(400, "Missing query parameter dashboardId", nil)
  27. }
  28. query := models.GetAlertStatesForDashboardQuery{
  29. OrgId: c.OrgId,
  30. DashboardId: c.QueryInt64("dashboardId"),
  31. }
  32. if err := bus.Dispatch(&query); err != nil {
  33. return ApiError(500, "Failed to fetch alert states", err)
  34. }
  35. return Json(200, query.Result)
  36. }
  37. // GET /api/alerts
  38. func GetAlerts(c *middleware.Context) Response {
  39. query := models.GetAlertsQuery{
  40. OrgId: c.OrgId,
  41. DashboardId: c.QueryInt64("dashboardId"),
  42. PanelId: c.QueryInt64("panelId"),
  43. Limit: c.QueryInt64("limit"),
  44. User: c.SignedInUser,
  45. }
  46. states := c.QueryStrings("state")
  47. if len(states) > 0 {
  48. query.State = states
  49. }
  50. if err := bus.Dispatch(&query); err != nil {
  51. return ApiError(500, "List alerts failed", err)
  52. }
  53. for _, alert := range query.Result {
  54. alert.Url = models.GetDashboardUrl(alert.DashboardUid, alert.DashboardSlug)
  55. }
  56. return Json(200, query.Result)
  57. }
  58. // POST /api/alerts/test
  59. func AlertTest(c *middleware.Context, dto dtos.AlertTestCommand) Response {
  60. if _, idErr := dto.Dashboard.Get("id").Int64(); idErr != nil {
  61. return ApiError(400, "The dashboard needs to be saved at least once before you can test an alert rule", nil)
  62. }
  63. backendCmd := alerting.AlertTestCommand{
  64. OrgId: c.OrgId,
  65. Dashboard: dto.Dashboard,
  66. PanelId: dto.PanelId,
  67. }
  68. if err := bus.Dispatch(&backendCmd); err != nil {
  69. if validationErr, ok := err.(alerting.ValidationError); ok {
  70. return ApiError(422, validationErr.Error(), nil)
  71. }
  72. return ApiError(500, "Failed to test rule", err)
  73. }
  74. res := backendCmd.Result
  75. dtoRes := &dtos.AlertTestResult{
  76. Firing: res.Firing,
  77. ConditionEvals: res.ConditionEvals,
  78. State: res.Rule.State,
  79. }
  80. if res.Error != nil {
  81. dtoRes.Error = res.Error.Error()
  82. }
  83. for _, log := range res.Logs {
  84. dtoRes.Logs = append(dtoRes.Logs, &dtos.AlertTestResultLog{Message: log.Message, Data: log.Data})
  85. }
  86. for _, match := range res.EvalMatches {
  87. dtoRes.EvalMatches = append(dtoRes.EvalMatches, &dtos.EvalMatch{Metric: match.Metric, Value: match.Value})
  88. }
  89. dtoRes.TimeMs = fmt.Sprintf("%1.3fms", res.GetDurationMs())
  90. return Json(200, dtoRes)
  91. }
  92. // GET /api/alerts/:id
  93. func GetAlert(c *middleware.Context) Response {
  94. id := c.ParamsInt64(":alertId")
  95. query := models.GetAlertByIdQuery{Id: id}
  96. if err := bus.Dispatch(&query); err != nil {
  97. return ApiError(500, "List alerts failed", err)
  98. }
  99. return Json(200, &query.Result)
  100. }
  101. func GetAlertNotifiers(c *middleware.Context) Response {
  102. return Json(200, alerting.GetNotifiers())
  103. }
  104. func GetAlertNotifications(c *middleware.Context) Response {
  105. query := &models.GetAllAlertNotificationsQuery{OrgId: c.OrgId}
  106. if err := bus.Dispatch(query); err != nil {
  107. return ApiError(500, "Failed to get alert notifications", err)
  108. }
  109. result := make([]*dtos.AlertNotification, 0)
  110. for _, notification := range query.Result {
  111. result = append(result, &dtos.AlertNotification{
  112. Id: notification.Id,
  113. Name: notification.Name,
  114. Type: notification.Type,
  115. IsDefault: notification.IsDefault,
  116. Created: notification.Created,
  117. Updated: notification.Updated,
  118. })
  119. }
  120. return Json(200, result)
  121. }
  122. func GetAlertNotificationById(c *middleware.Context) Response {
  123. query := &models.GetAlertNotificationsQuery{
  124. OrgId: c.OrgId,
  125. Id: c.ParamsInt64("notificationId"),
  126. }
  127. if err := bus.Dispatch(query); err != nil {
  128. return ApiError(500, "Failed to get alert notifications", err)
  129. }
  130. return Json(200, query.Result)
  131. }
  132. func CreateAlertNotification(c *middleware.Context, cmd models.CreateAlertNotificationCommand) Response {
  133. cmd.OrgId = c.OrgId
  134. if err := bus.Dispatch(&cmd); err != nil {
  135. return ApiError(500, "Failed to create alert notification", err)
  136. }
  137. return Json(200, cmd.Result)
  138. }
  139. func UpdateAlertNotification(c *middleware.Context, cmd models.UpdateAlertNotificationCommand) Response {
  140. cmd.OrgId = c.OrgId
  141. if err := bus.Dispatch(&cmd); err != nil {
  142. return ApiError(500, "Failed to update alert notification", err)
  143. }
  144. return Json(200, cmd.Result)
  145. }
  146. func DeleteAlertNotification(c *middleware.Context) Response {
  147. cmd := models.DeleteAlertNotificationCommand{
  148. OrgId: c.OrgId,
  149. Id: c.ParamsInt64("notificationId"),
  150. }
  151. if err := bus.Dispatch(&cmd); err != nil {
  152. return ApiError(500, "Failed to delete alert notification", err)
  153. }
  154. return ApiSuccess("Notification deleted")
  155. }
  156. //POST /api/alert-notifications/test
  157. func NotificationTest(c *middleware.Context, dto dtos.NotificationTestCommand) Response {
  158. cmd := &alerting.NotificationTestCommand{
  159. Name: dto.Name,
  160. Type: dto.Type,
  161. Settings: dto.Settings,
  162. }
  163. if err := bus.Dispatch(cmd); err != nil {
  164. if err == models.ErrSmtpNotEnabled {
  165. return ApiError(412, err.Error(), err)
  166. }
  167. return ApiError(500, "Failed to send alert notifications", err)
  168. }
  169. return ApiSuccess("Test notification sent")
  170. }
  171. //POST /api/alerts/:alertId/pause
  172. func PauseAlert(c *middleware.Context, dto dtos.PauseAlertCommand) Response {
  173. alertId := c.ParamsInt64("alertId")
  174. query := models.GetAlertByIdQuery{Id: alertId}
  175. if err := bus.Dispatch(&query); err != nil {
  176. return ApiError(500, "Get Alert failed", err)
  177. }
  178. guardian := guardian.New(query.Result.DashboardId, c.OrgId, c.SignedInUser)
  179. if canEdit, err := guardian.CanEdit(); err != nil || !canEdit {
  180. if err != nil {
  181. return ApiError(500, "Error while checking permissions for Alert", err)
  182. }
  183. return ApiError(403, "Access denied to this dashboard and alert", nil)
  184. }
  185. cmd := models.PauseAlertCommand{
  186. OrgId: c.OrgId,
  187. AlertIds: []int64{alertId},
  188. Paused: dto.Paused,
  189. }
  190. if err := bus.Dispatch(&cmd); err != nil {
  191. return ApiError(500, "", err)
  192. }
  193. var response models.AlertStateType = models.AlertStatePending
  194. pausedState := "un-paused"
  195. if cmd.Paused {
  196. response = models.AlertStatePaused
  197. pausedState = "paused"
  198. }
  199. result := map[string]interface{}{
  200. "alertId": alertId,
  201. "state": response,
  202. "message": "Alert " + pausedState,
  203. }
  204. return Json(200, result)
  205. }
  206. //POST /api/admin/pause-all-alerts
  207. func PauseAllAlerts(c *middleware.Context, dto dtos.PauseAllAlertsCommand) Response {
  208. updateCmd := models.PauseAllAlertCommand{
  209. Paused: dto.Paused,
  210. }
  211. if err := bus.Dispatch(&updateCmd); err != nil {
  212. return ApiError(500, "Failed to pause alerts", err)
  213. }
  214. var response models.AlertStateType = models.AlertStatePending
  215. pausedState := "un paused"
  216. if updateCmd.Paused {
  217. response = models.AlertStatePaused
  218. pausedState = "paused"
  219. }
  220. result := map[string]interface{}{
  221. "state": response,
  222. "message": "alerts " + pausedState,
  223. "alertsAffected": updateCmd.ResultCount,
  224. }
  225. return Json(200, result)
  226. }