prometheus

Documentation

Index

• type FormatMode
• type Option
  • func Format(format FormatMode) Option
  • func Hide() Option
  • func Instant() Option
  • func IntervalFactor(factor int) Option
  • func Legend(legend string) Option
  • func Ref(ref string) Option
• type Prometheus
  • func New(query string, options ...Option) *Prometheus

Types

type FormatMode

type FormatMode string

Format switches between Table, Time series, or Heatmap. Table will only work in the Table panel. Heatmap is suitable for displaying metrics of the Histogram type on a Heatmap panel. Under the hood, it converts cumulative histograms to regular ones and sorts series by the bucket bound.

const (
	FormatTable      FormatMode = "table"
	FormatHeatmap    FormatMode = "heatmap"
	FormatTimeSeries FormatMode = "time_series"
)

type Option

type Option func(target *Prometheus)

Option represents an option that can be used to configure a prometheus query.

func Format

func Format(format FormatMode) Option

Format indicates how the data should be returned.

func Hide

func Hide() Option

Hide the query. Grafana does not send hidden queries to the data source, but they can still be referenced in alerts.

func Instant

func Instant() Option

Instant marks the query as "instant, which means Prometheus will only return the latest scrapped value.

func IntervalFactor

func IntervalFactor(factor int) Option

IntervalFactor sets the resolution factor.

func Legend

func Legend(legend string) Option

Legend sets the legend format.

func Ref

func Ref(ref string) Option

Ref sets the reference ID for this query.

type Prometheus

type Prometheus struct {
	Ref            string
	Hidden         bool
	Expr           string
	IntervalFactor int
	Interval       string
	Step           int
	LegendFormat   string
	Instant        bool
	Format         string
}

Prometheus represents a prometheus query.

func New

func New(query string, options ...Option) *Prometheus

New creates a new prometheus query.