dashboard_snapshot.go 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. package api
  2. import (
  3. "time"
  4. "github.com/grafana/grafana/pkg/api/dtos"
  5. "github.com/grafana/grafana/pkg/bus"
  6. "github.com/grafana/grafana/pkg/metrics"
  7. "github.com/grafana/grafana/pkg/middleware"
  8. m "github.com/grafana/grafana/pkg/models"
  9. "github.com/grafana/grafana/pkg/setting"
  10. "github.com/grafana/grafana/pkg/util"
  11. )
  12. func GetSharingOptions(c *middleware.Context) {
  13. c.JSON(200, util.DynMap{
  14. "externalSnapshotURL": setting.ExternalSnapshotUrl,
  15. "externalSnapshotName": setting.ExternalSnapshotName,
  16. "externalEnabled": setting.ExternalEnabled,
  17. })
  18. }
  19. func CreateDashboardSnapshot(c *middleware.Context, cmd m.CreateDashboardSnapshotCommand) {
  20. if cmd.External {
  21. // external snapshot ref requires key and delete key
  22. if cmd.Key == "" || cmd.DeleteKey == "" {
  23. c.JsonApiErr(400, "Missing key and delete key for external snapshot", nil)
  24. return
  25. }
  26. cmd.OrgId = -1
  27. cmd.UserId = -1
  28. metrics.M_Api_Dashboard_Snapshot_External.Inc(1)
  29. } else {
  30. cmd.Key = util.GetRandomString(32)
  31. cmd.DeleteKey = util.GetRandomString(32)
  32. cmd.OrgId = c.OrgId
  33. cmd.UserId = c.UserId
  34. metrics.M_Api_Dashboard_Snapshot_Create.Inc(1)
  35. }
  36. if err := bus.Dispatch(&cmd); err != nil {
  37. c.JsonApiErr(500, "Failed to create snaphost", err)
  38. return
  39. }
  40. c.JSON(200, util.DynMap{
  41. "key": cmd.Key,
  42. "deleteKey": cmd.DeleteKey,
  43. "url": setting.ToAbsUrl("dashboard/snapshot/" + cmd.Key),
  44. "deleteUrl": setting.ToAbsUrl("api/snapshots-delete/" + cmd.DeleteKey),
  45. })
  46. }
  47. func GetDashboardSnapshot(c *middleware.Context) {
  48. key := c.Params(":key")
  49. query := &m.GetDashboardSnapshotQuery{Key: key}
  50. err := bus.Dispatch(query)
  51. if err != nil {
  52. c.JsonApiErr(500, "Failed to get dashboard snapshot", err)
  53. return
  54. }
  55. snapshot := query.Result
  56. // expired snapshots should also be removed from db
  57. if snapshot.Expires.Before(time.Now()) {
  58. c.JsonApiErr(404, "Dashboard snapshot not found", err)
  59. return
  60. }
  61. dto := dtos.DashboardFullWithMeta{
  62. Dashboard: snapshot.Dashboard,
  63. Meta: dtos.DashboardMeta{
  64. Type: m.DashTypeSnapshot,
  65. IsSnapshot: true,
  66. Created: snapshot.Created,
  67. Expires: snapshot.Expires,
  68. },
  69. }
  70. metrics.M_Api_Dashboard_Snapshot_Get.Inc(1)
  71. c.Resp.Header().Set("Cache-Control", "public, max-age=3600")
  72. c.JSON(200, dto)
  73. }
  74. func DeleteDashboardSnapshot(c *middleware.Context) {
  75. key := c.Params(":key")
  76. cmd := &m.DeleteDashboardSnapshotCommand{DeleteKey: key}
  77. if err := bus.Dispatch(cmd); err != nil {
  78. c.JsonApiErr(500, "Failed to delete dashboard snapshot", err)
  79. return
  80. }
  81. c.JSON(200, util.DynMap{"message": "Snapshot deleted. It might take an hour before it's cleared from a CDN cache."})
  82. }
  83. func SearchDashboardSnapshots(c *middleware.Context) Response {
  84. query := c.Query("query")
  85. limit := c.QueryInt("limit")
  86. if limit == 0 {
  87. limit = 1000
  88. }
  89. searchQuery := m.GetDashboardSnapshotsQuery{
  90. Name: query,
  91. Limit: limit,
  92. OrgId: c.OrgId,
  93. }
  94. err := bus.Dispatch(&searchQuery)
  95. if err != nil {
  96. return ApiError(500, "Search failed", err)
  97. }
  98. dtos := make([]*m.DashboardSnapshotDTO, len(searchQuery.Result))
  99. for i, snapshot := range searchQuery.Result {
  100. dtos[i] = &m.DashboardSnapshotDTO{
  101. Id: snapshot.Id,
  102. Name: snapshot.Name,
  103. Key: snapshot.Key,
  104. DeleteKey: snapshot.DeleteKey,
  105. OrgId: snapshot.OrgId,
  106. UserId: snapshot.UserId,
  107. External: snapshot.External,
  108. ExternalUrl: snapshot.ExternalUrl,
  109. Expires: snapshot.Expires,
  110. Created: snapshot.Created,
  111. Updated: snapshot.Updated,
  112. }
  113. }
  114. return Json(200, dtos)
  115. }