promql

Documentation

Overview

promql provides an abstraction on the prometheus HTTP API

Index

• func CreateClient(host string) (v1.API, error)
• func CreateClientWithAuth(host string, authCfg config.Authorization, tlsCfg config.TLSConfig) (v1.API, error)
• type Client
• type PromQL
  • func (p *PromQL) InstantQuery(queryString string) (model.Vector, v1.Warnings, error)
  • func (p *PromQL) LabelsQuery(query string) (model.Vector, v1.Warnings, error)
  • func (p *PromQL) MetaQuery(query string) (map[string][]v1.Metadata, error)
  • func (p *PromQL) RangeQuery(queryString string) (model.Matrix, v1.Warnings, error)
  • func (p *PromQL) SeriesQuery(query string) ([]model.LabelSet, v1.Warnings, error)

Functions

func CreateClient

func CreateClient(host string) (v1.API, error)

CreateClient creates a Client interface for the provided hostname

func CreateClientWithAuth

func CreateClientWithAuth(host string, authCfg config.Authorization, tlsCfg config.TLSConfig) (v1.API, error)

CreateClientWithAuth creates a Client interface witht the provided hostname and auth config

Types

type Client

type Client interface {
	v1.API
}

type PromQL

type PromQL struct {
	Host            string
	Step            string
	Output          string
	TimeoutDuration time.Duration
	CfgFile         string
	Time            time.Time
	Start           string
	End             string
	NoHeaders       bool
	Auth            config.Authorization
	Client          v1.API
	TLSConfig       config.TLSConfig
}

Cfg conatins the final configuration params parsed from a combo of flags, config file values, and env vars.

func (*PromQL) InstantQuery

func (p *PromQL) InstantQuery(queryString string) (model.Vector, v1.Warnings, error)

InstantQuery performs an instant query and returns the result

func (*PromQL) LabelsQuery

func (p *PromQL) LabelsQuery(query string) (model.Vector, v1.Warnings, error)

LabelsQuery runs a labels query and returns the result

func (*PromQL) MetaQuery

func (p *PromQL) MetaQuery(query string) (map[string][]v1.Metadata, error)

MetaQuery returns prometheus metrics metadata. Used for our metrics and meta commands

func (*PromQL) RangeQuery

func (p *PromQL) RangeQuery(queryString string) (model.Matrix, v1.Warnings, error)

rangeQuery performs a range query and writes the results to stdout

func (*PromQL) SeriesQuery

func (p *PromQL) SeriesQuery(query string) ([]model.LabelSet, v1.Warnings, error)

SeriesQuery returns prometheus series data