promql_sdk

README

promql-sdk

promql-sdk make tsdb can use promql, implemented by prometheus remote-read.

How to use it

1. init

c := &promql_sdk.ReadConfig{
    URL:     "http://127.0.0.1:8086/api/v1/prom/read?db=prometheus",    //influxdb
    Timeout: 1 * time.Minute,
}
configs := []*promql_sdk.ReadConfig{c}
err := promql_sdk.Init(configs)

2. query instant

query := `(1 - avg by(instance) (rate(node_cpu_seconds_total{mode="idle"}[5m])))* 100`
res, err := promql_sdk.Query(query)

query result:

{"resultType":"vector","result":[{"metric":{"instance":"node1"},"value":[1652086175.251,"76.00700000021607"]},{"metric":{"instance":"node2"},"value":[1652086175.251,"72.67599999997765"]}]}

3. query range

query := `(1 - avg by(instance) (rate(node_cpu_seconds_total{mode="idle"}[5m])))* 100`
res, err = promql_sdk.QueryRange(query, startTs, endTs, step)

query range result:

 {"resultType":"matrix","result":[{"metric":{"instance":"node1"},"values":[[1652086115,"88.31412083342268"],[1652086175,"76.00700000021607"]]},{"metric":{"instance":"node2"},"values":[[1652086115,"87.37343999993503"],[1652086175,"72.67599999997765"]]}]}

Documentation

Index

• Constants
• func Init(configs []*ReadConfig, ops ...func()) error
• func InstantQueryTime(ts int64) func(query *InstantQuery)
• func InstantQueryTimeout(timeout time.Duration) func(query *InstantQuery)
• func LookBackDelta(t time.Duration) func()
• func RangeQueryTimeout(timeout time.Duration) func(*RangeQuery)
• type InstantQuery
  • func NewInstantQuery(query string, opts ...func(*InstantQuery)) *InstantQuery
  • func (q *InstantQuery) Do() (*QueryData, error)
• type QueryData
  • func Query(query string) (*QueryData, error)
  • func QueryInstant(query string, ts int64) (*QueryData, error)
  • func QueryRange(query string, startTs int64, endTs int64, step int) (*QueryData, error)
• type RangeQuery
  • func NewRangeQuery(query string, start, end int64, step int, opts ...func(*RangeQuery)) *RangeQuery
  • func (q *RangeQuery) Do() (*QueryData, error)
• type ReadConfig

Constants

const (
	DefaultEngineQueryMaxConcurrency = 20
	DefaultEngineQueryMaxSamples     = 50000000
	DefaultEngineQueryTimeout        = 30 * time.Second

	DefaultAPIInstantQueryTimeout = 10 * time.Second
	DefaultAPIRangeQueryTimeout   = 30 * time.Second
)

Functions

func Init

func Init(configs []*ReadConfig, ops ...func()) error

func InstantQueryTime

func InstantQueryTime(ts int64) func(query *InstantQuery)

func InstantQueryTimeout

func InstantQueryTimeout(timeout time.Duration) func(query *InstantQuery)

func LookBackDelta

func LookBackDelta(t time.Duration) func()

func RangeQueryTimeout

func RangeQueryTimeout(timeout time.Duration) func(*RangeQuery)

Types

type InstantQuery

type InstantQuery struct {
	Query   string
	Ts      int64
	Timeout time.Duration
}

func NewInstantQuery

func NewInstantQuery(query string, opts ...func(*InstantQuery)) *InstantQuery

func (*InstantQuery) Do

func (q *InstantQuery) Do() (*QueryData, error)

type QueryData

type QueryData struct {
	ResultType promql.ValueType  `json:"resultType"`
	Result     promql.Value      `json:"result"`
	Stats      *stats.QueryStats `json:"stats,omitempty"`
}

func Query

func Query(query string) (*QueryData, error)

func QueryInstant

func QueryInstant(query string, ts int64) (*QueryData, error)

func QueryRange

func QueryRange(query string, startTs int64, endTs int64, step int) (*QueryData, error)

type RangeQuery

type RangeQuery struct {
	Query  string
	Start  int64
	End    int64
	Step   int
	Timout time.Duration
}

func NewRangeQuery

func NewRangeQuery(query string, start, end int64, step int, opts ...func(*RangeQuery)) *RangeQuery

func (*RangeQuery) Do

func (q *RangeQuery) Do() (*QueryData, error)

type ReadConfig

type ReadConfig struct {
	URL     string
	Timeout time.Duration
}