alerting.go 8.9 KB

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