remoteread

Documentation

Index

• type Client
  • func NewClient(cfg Config) (*Client, error)
  • func (c *Client) Ping() error
  • func (c *Client) Read(ctx context.Context, filter *Filter, streamCb StreamCallback) error
• type Config
• type Filter
• type StreamCallback

Types

type Client

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

Client is an HTTP client for reading time series via remote read protocol.

func NewClient

func NewClient(cfg Config) (*Client, error)

NewClient returns client for reading time series via remote read protocol.

func (*Client) Ping

func (c *Client) Ping() error

Ping checks the health of the read source

func (*Client) Read

func (c *Client) Read(ctx context.Context, filter *Filter, streamCb StreamCallback) error

Read fetch data from remote read source

type Config

type Config struct {
	// Addr of remote storage
	Addr string
	// Timeout defines timeout for HTTP requests
	// made by remote read client
	Timeout time.Duration
	// Username is the remote read username, optional.
	Username string
	// Password is the remote read password, optional.
	Password string
	// UseStream defines whether to use SAMPLES or STREAMED_XOR_CHUNKS mode
	// see https://prometheus.io/docs/prometheus/latest/querying/remote_read_api/#samples
	// https://prometheus.io/docs/prometheus/latest/querying/remote_read_api/#streamed-chunks
	UseStream bool
	// Headers optional HTTP headers to send with each request to the corresponding remote storage
	Headers string
	// LabelName, LabelValue stands for label=~value pair used for read requests.
	// Is optional.
	LabelName, LabelValue string
}

Config is config for remote read.

type Filter

type Filter struct {
	StartTimestampMs int64
	EndTimestampMs   int64
}

Filter defines a list of filters applied to requested data

type StreamCallback

type StreamCallback func(series *vm.TimeSeries) error

StreamCallback is a callback function for processing time series