dashboard_snapshot.go 3.5 KB

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