searchutils

Documentation

Index

• func GetBool(r *http.Request, argKey string) bool
• func GetDuration(r *http.Request, argKey string, defaultValue int64) (int64, error)
• func GetMaxQueryDuration(r *http.Request) time.Duration
• func GetTime(r *http.Request, argKey string, defaultMs int64) (int64, error)
• type Deadline
  • func GetDeadlineForExport(r *http.Request, startTime time.Time) Deadline
  • func GetDeadlineForQuery(r *http.Request, startTime time.Time) Deadline
  • func NewDeadline(startTime time.Time, timeout time.Duration, flagHint string) Deadline
  • func (d *Deadline) Deadline() uint64
  • func (d *Deadline) Exceeded() bool
  • func (d *Deadline) String() string

Functions

func GetBool

func GetBool(r *http.Request, argKey string) bool

GetBool returns boolean value from the given argKey query arg.

func GetDuration

func GetDuration(r *http.Request, argKey string, defaultValue int64) (int64, error)

GetDuration returns duration from the given argKey query arg.

func GetMaxQueryDuration

func GetMaxQueryDuration(r *http.Request) time.Duration

GetMaxQueryDuration returns the maximum duration for query from r.

func GetTime

func GetTime(r *http.Request, argKey string, defaultMs int64) (int64, error)

GetTime returns time from the given argKey query arg.

If argKey is missing in r, then defaultMs rounded to seconds is returned. The rounding is needed in order to align query results in Grafana executed at different times. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/720

Types

type Deadline

type Deadline struct {
	// contains filtered or unexported fields
}

Deadline contains deadline with the corresponding timeout for pretty error messages.

func GetDeadlineForExport

func GetDeadlineForExport(r *http.Request, startTime time.Time) Deadline

GetDeadlineForExport returns deadline for the given request to /api/v1/export.

func GetDeadlineForQuery

func GetDeadlineForQuery(r *http.Request, startTime time.Time) Deadline

GetDeadlineForQuery returns deadline for the given query r.

func NewDeadline

func NewDeadline(startTime time.Time, timeout time.Duration, flagHint string) Deadline

NewDeadline returns deadline for the given timeout.

flagHint must contain a hit for command-line flag, which could be used in order to increase timeout.

func (*Deadline) Deadline

func (d *Deadline) Deadline() uint64

Deadline returns deadline in unix timestamp seconds.

func (*Deadline) Exceeded

func (d *Deadline) Exceeded() bool

Exceeded returns true if deadline is exceeded.

func (*Deadline) String

func (d *Deadline) String() string

String returns human-readable string representation for d.