alerting.go 8.7 KB

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