grafana/pkg/services/screenshot/option.go
George Robinson 7376eee6ff
Alerting: Support From and To when taking screenshots (#59166)
This commit adds support for the From and To parameters that set the
time range for the graph. The default is 6 hours, which can sometimes
be too large of a time range.
2022-11-23 09:28:24 +00:00

68 lines
1.4 KiB
Go

package screenshot
import (
"hash/fnv"
"strconv"
"time"
"github.com/grafana/grafana/pkg/models"
)
var (
DefaultFrom = "now-1h"
DefaultTo = "now"
DefaultHeight = 500
DefaultWidth = 1000
DefaultTheme = models.ThemeDark
DefaultTimeout = 15 * time.Second
)
// ScreenshotOptions are the options for taking a screenshot.
type ScreenshotOptions struct {
DashboardUID string
PanelID int64
From string
To string
Width int
Height int
Theme models.Theme
Timeout time.Duration
}
// SetDefaults sets default values for missing or invalid options.
func (s ScreenshotOptions) SetDefaults() ScreenshotOptions {
if s.From == "" {
s.From = DefaultFrom
}
if s.To == "" {
s.To = DefaultTo
}
if s.Width <= 0 {
s.Width = DefaultWidth
}
if s.Height <= 0 {
s.Height = DefaultHeight
}
switch s.Theme {
case models.ThemeDark, models.ThemeLight:
default:
s.Theme = DefaultTheme
}
if s.Timeout <= 0 {
s.Timeout = DefaultTimeout
}
return s
}
func (s ScreenshotOptions) Hash() []byte {
h := fnv.New64()
_, _ = h.Write([]byte(s.DashboardUID))
_, _ = h.Write([]byte(strconv.FormatInt(s.PanelID, 10)))
_, _ = h.Write([]byte(s.From))
_, _ = h.Write([]byte(s.To))
_, _ = h.Write([]byte(strconv.FormatInt(int64(s.Width), 10)))
_, _ = h.Write([]byte(strconv.FormatInt(int64(s.Height), 10)))
_, _ = h.Write([]byte(s.Theme))
return h.Sum(nil)
}