alerting.go 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  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. }
  45. states := c.QueryStrings("state")
  46. if len(states) > 0 {
  47. query.State = states
  48. }
  49. if err := bus.Dispatch(&query); err != nil {
  50. return ApiError(500, "List alerts failed", err)
  51. }
  52. dashboardIds := make([]int64, 0)
  53. alertDTOs := make([]*dtos.AlertRule, 0)
  54. for _, alert := range query.Result {
  55. dashboardIds = append(dashboardIds, alert.DashboardId)
  56. alertDTOs = append(alertDTOs, &dtos.AlertRule{
  57. Id: alert.Id,
  58. DashboardId: alert.DashboardId,
  59. PanelId: alert.PanelId,
  60. Name: alert.Name,
  61. Message: alert.Message,
  62. State: alert.State,
  63. NewStateDate: alert.NewStateDate,
  64. ExecutionError: alert.ExecutionError,
  65. EvalData: alert.EvalData,
  66. })
  67. }
  68. dashboardsQuery := models.GetDashboardsQuery{
  69. DashboardIds: dashboardIds,
  70. }
  71. if len(alertDTOs) > 0 {
  72. if err := bus.Dispatch(&dashboardsQuery); err != nil {
  73. return ApiError(500, "List alerts failed", err)
  74. }
  75. }
  76. //TODO: should be possible to speed this up with lookup table
  77. for _, alert := range alertDTOs {
  78. for _, dash := range dashboardsQuery.Result {
  79. if alert.DashboardId == dash.Id {
  80. alert.DashbboardUri = "db/" + dash.Slug
  81. }
  82. }
  83. }
  84. return Json(200, alertDTOs)
  85. }
  86. // POST /api/alerts/test
  87. func AlertTest(c *middleware.Context, dto dtos.AlertTestCommand) Response {
  88. if _, idErr := dto.Dashboard.Get("id").Int64(); idErr != nil {
  89. return ApiError(400, "The dashboard needs to be saved at least once before you can test an alert rule", nil)
  90. }
  91. backendCmd := alerting.AlertTestCommand{
  92. OrgId: c.OrgId,
  93. Dashboard: dto.Dashboard,
  94. PanelId: dto.PanelId,
  95. }
  96. if err := bus.Dispatch(&backendCmd); err != nil {
  97. if validationErr, ok := err.(alerting.ValidationError); ok {
  98. return ApiError(422, validationErr.Error(), nil)
  99. }
  100. return ApiError(500, "Failed to test rule", err)
  101. }
  102. res := backendCmd.Result
  103. dtoRes := &dtos.AlertTestResult{
  104. Firing: res.Firing,
  105. ConditionEvals: res.ConditionEvals,
  106. State: res.Rule.State,
  107. }
  108. if res.Error != nil {
  109. dtoRes.Error = res.Error.Error()
  110. }
  111. for _, log := range res.Logs {
  112. dtoRes.Logs = append(dtoRes.Logs, &dtos.AlertTestResultLog{Message: log.Message, Data: log.Data})
  113. }
  114. for _, match := range res.EvalMatches {
  115. dtoRes.EvalMatches = append(dtoRes.EvalMatches, &dtos.EvalMatch{Metric: match.Metric, Value: match.Value})
  116. }
  117. dtoRes.TimeMs = fmt.Sprintf("%1.3fms", res.GetDurationMs())
  118. return Json(200, dtoRes)
  119. }
  120. // GET /api/alerts/:id
  121. func GetAlert(c *middleware.Context) Response {
  122. id := c.ParamsInt64(":alertId")
  123. query := models.GetAlertByIdQuery{Id: id}
  124. if err := bus.Dispatch(&query); err != nil {
  125. return ApiError(500, "List alerts failed", err)
  126. }
  127. return Json(200, &query.Result)
  128. }
  129. func GetAlertNotifiers(c *middleware.Context) Response {
  130. return Json(200, alerting.GetNotifiers())
  131. }
  132. func GetAlertNotifications(c *middleware.Context) Response {
  133. query := &models.GetAllAlertNotificationsQuery{OrgId: c.OrgId}
  134. if err := bus.Dispatch(query); err != nil {
  135. return ApiError(500, "Failed to get alert notifications", err)
  136. }
  137. result := make([]*dtos.AlertNotification, 0)
  138. for _, notification := range query.Result {
  139. result = append(result, &dtos.AlertNotification{
  140. Id: notification.Id,
  141. Name: notification.Name,
  142. Type: notification.Type,
  143. IsDefault: notification.IsDefault,
  144. Created: notification.Created,
  145. Updated: notification.Updated,
  146. })
  147. }
  148. return Json(200, result)
  149. }
  150. func GetAlertNotificationById(c *middleware.Context) Response {
  151. query := &models.GetAlertNotificationsQuery{
  152. OrgId: c.OrgId,
  153. Id: c.ParamsInt64("notificationId"),
  154. }
  155. if err := bus.Dispatch(query); err != nil {
  156. return ApiError(500, "Failed to get alert notifications", err)
  157. }
  158. return Json(200, query.Result)
  159. }
  160. func CreateAlertNotification(c *middleware.Context, cmd models.CreateAlertNotificationCommand) Response {
  161. cmd.OrgId = c.OrgId
  162. if err := bus.Dispatch(&cmd); err != nil {
  163. return ApiError(500, "Failed to create alert notification", err)
  164. }
  165. return Json(200, cmd.Result)
  166. }
  167. func UpdateAlertNotification(c *middleware.Context, cmd models.UpdateAlertNotificationCommand) Response {
  168. cmd.OrgId = c.OrgId
  169. if err := bus.Dispatch(&cmd); err != nil {
  170. return ApiError(500, "Failed to update alert notification", err)
  171. }
  172. return Json(200, cmd.Result)
  173. }
  174. func DeleteAlertNotification(c *middleware.Context) Response {
  175. cmd := models.DeleteAlertNotificationCommand{
  176. OrgId: c.OrgId,
  177. Id: c.ParamsInt64("notificationId"),
  178. }
  179. if err := bus.Dispatch(&cmd); err != nil {
  180. return ApiError(500, "Failed to delete alert notification", err)
  181. }
  182. return ApiSuccess("Notification deleted")
  183. }
  184. //POST /api/alert-notifications/test
  185. func NotificationTest(c *middleware.Context, dto dtos.NotificationTestCommand) Response {
  186. cmd := &alerting.NotificationTestCommand{
  187. Name: dto.Name,
  188. Type: dto.Type,
  189. Settings: dto.Settings,
  190. }
  191. if err := bus.Dispatch(cmd); err != nil {
  192. if err == models.ErrSmtpNotEnabled {
  193. return ApiError(412, err.Error(), err)
  194. }
  195. return ApiError(500, "Failed to send alert notifications", err)
  196. }
  197. return ApiSuccess("Test notification sent")
  198. }
  199. //POST /api/alerts/:alertId/pause
  200. func PauseAlert(c *middleware.Context, dto dtos.PauseAlertCommand) Response {
  201. alertId := c.ParamsInt64("alertId")
  202. query := models.GetAlertByIdQuery{Id: alertId}
  203. if err := bus.Dispatch(&query); err != nil {
  204. return ApiError(500, "Get Alert failed", err)
  205. }
  206. guardian := guardian.NewDashboardGuardian(query.Result.DashboardId, c.OrgId, c.SignedInUser)
  207. if canEdit, err := guardian.CanEdit(); err != nil || !canEdit {
  208. if err != nil {
  209. return ApiError(500, "Error while checking permissions for Alert", err)
  210. }
  211. return ApiError(403, "Access denied to this dashboard and alert", nil)
  212. }
  213. cmd := models.PauseAlertCommand{
  214. OrgId: c.OrgId,
  215. AlertIds: []int64{alertId},
  216. Paused: dto.Paused,
  217. }
  218. if err := bus.Dispatch(&cmd); err != nil {
  219. return ApiError(500, "", err)
  220. }
  221. var response models.AlertStateType = models.AlertStatePending
  222. pausedState := "un-paused"
  223. if cmd.Paused {
  224. response = models.AlertStatePaused
  225. pausedState = "paused"
  226. }
  227. result := map[string]interface{}{
  228. "alertId": alertId,
  229. "state": response,
  230. "message": "Alert " + pausedState,
  231. }
  232. return Json(200, result)
  233. }
  234. //POST /api/admin/pause-all-alerts
  235. func PauseAllAlerts(c *middleware.Context, dto dtos.PauseAllAlertsCommand) Response {
  236. updateCmd := models.PauseAllAlertCommand{
  237. Paused: dto.Paused,
  238. }
  239. if err := bus.Dispatch(&updateCmd); err != nil {
  240. return ApiError(500, "Failed to pause alerts", err)
  241. }
  242. var response models.AlertStateType = models.AlertStatePending
  243. pausedState := "un paused"
  244. if updateCmd.Paused {
  245. response = models.AlertStatePaused
  246. pausedState = "paused"
  247. }
  248. result := map[string]interface{}{
  249. "state": response,
  250. "message": "alerts " + pausedState,
  251. "alertsAffected": updateCmd.ResultCount,
  252. }
  253. return Json(200, result)
  254. }