alerting.go 8.9 KB

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