promclient

Documentation

Index

• Constants
• Variables
• func IsDirAccessible(dir string) error
• func IsWALDirAccessible(dir string) error
• type Client
  • func NewClient(c HTTPClient, logger log.Logger, userAgent string) *Client
  • func NewDefaultClient() *Client
  • func NewWithTracingClient(logger log.Logger, httpClient *http.Client, userAgent string) *Client
  • func (c *Client) AlertmanagerAlerts(ctx context.Context, base *url.URL) ([]*model.Alert, error)
  • func (c *Client) AlertsInGRPC(ctx context.Context, base *url.URL) ([]*rulespb.AlertInstance, error)
  • func (c *Client) BuildVersion(ctx context.Context, base *url.URL) (string, error)
  • func (c *Client) ConfiguredFlags(ctx context.Context, base *url.URL) (Flags, error)
  • func (c *Client) ExemplarsInGRPC(ctx context.Context, base *url.URL, query string, startTime, endTime int64) ([]*exemplarspb.ExemplarData, error)
  • func (c *Client) ExternalLabels(ctx context.Context, base *url.URL) (labels.Labels, error)
  • func (c *Client) LabelNamesInGRPC(ctx context.Context, base *url.URL, matchers []*labels.Matcher, ...) ([]string, error)
  • func (c *Client) LabelValuesInGRPC(ctx context.Context, base *url.URL, label string, matchers []*labels.Matcher, ...) ([]string, error)
  • func (c *Client) MetricMetadataInGRPC(ctx context.Context, base *url.URL, metric string, limit int) (map[string][]metadatapb.Meta, error)
  • func (c *Client) PromqlQueryInstant(ctx context.Context, base *url.URL, query string, t time.Time, ...) (promql.Vector, []string, error)
  • func (c *Client) QueryInstant(ctx context.Context, base *url.URL, query string, t time.Time, ...) (model.Vector, []string, *Explanation, error)
  • func (c *Client) QueryRange(ctx context.Context, base *url.URL, query string, ...) (model.Matrix, []string, *Explanation, error)
  • func (c *Client) RulesInGRPC(ctx context.Context, base *url.URL, typeRules string) ([]*rulespb.RuleGroup, error)
  • func (c *Client) SeriesInGRPC(ctx context.Context, base *url.URL, matchers []*labels.Matcher, ...) ([]map[string]string, error)
  • func (c *Client) Snapshot(ctx context.Context, base *url.URL, skipHead bool) (string, error)
  • func (c *Client) TargetsInGRPC(ctx context.Context, base *url.URL, stateTargets string) (*targetspb.TargetDiscovery, error)
• type Explanation
• type Flags
  • func (f *Flags) UnmarshalJSON(b []byte) error
• type HTTPClient
• type QueryOptions
  • func (p *QueryOptions) AddTo(values url.Values) error

Constants

const (
	SUCCESS = "success"
)

Variables

var (
	ErrFlagEndpointNotFound = errors.New("no flag endpoint found")
)

Functions

func IsDirAccessible

func IsDirAccessible(dir string) error

IsDirAccessible returns no error if dir can be found.

func IsWALDirAccessible

func IsWALDirAccessible(dir string) error

IsWALDirAccessible returns no error if WAL dir can be found. This helps to tell if we have access to Prometheus TSDB directory.

Types

type Client

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

Client represents a Prometheus API client.

func NewClient

func NewClient(c HTTPClient, logger log.Logger, userAgent string) *Client

NewClient returns a new Prometheus API client.

func NewDefaultClient

func NewDefaultClient() *Client

NewDefaultClient returns Client with tracing tripperware.

func NewWithTracingClient

func NewWithTracingClient(logger log.Logger, httpClient *http.Client, userAgent string) *Client

NewWithTracingClient returns client with tracing tripperware.

func (*Client) AlertmanagerAlerts

func (c *Client) AlertmanagerAlerts(ctx context.Context, base *url.URL) ([]*model.Alert, error)

AlertmanagerAlerts returns alerts from Alertmanager.

func (*Client) AlertsInGRPC

func (c *Client) AlertsInGRPC(ctx context.Context, base *url.URL) ([]*rulespb.AlertInstance, error)

AlertsInGRPC returns the rules from Prometheus alerts API. It uses gRPC errors. NOTE: This method is tested in pkg/store/prometheus_test.go against Prometheus.

func (*Client) BuildVersion

func (c *Client) BuildVersion(ctx context.Context, base *url.URL) (string, error)

BuildVersion returns Prometheus version from /api/v1/status/buildinfo Prometheus endpoint. For Prometheus versions < 2.14.0 it returns "0" as Prometheus version.

func (*Client) ConfiguredFlags

func (c *Client) ConfiguredFlags(ctx context.Context, base *url.URL) (Flags, error)

ConfiguredFlags returns configured flags from /api/v1/status/flags Prometheus endpoint. Added to Prometheus from v2.2.

func (*Client) ExemplarsInGRPC

func (c *Client) ExemplarsInGRPC(ctx context.Context, base *url.URL, query string, startTime, endTime int64) ([]*exemplarspb.ExemplarData, error)

ExemplarsInGRPC returns the exemplars from Prometheus exemplars API. It uses gRPC errors. NOTE: This method is tested in pkg/store/prometheus_test.go against Prometheus.

func (*Client) ExternalLabels

func (c *Client) ExternalLabels(ctx context.Context, base *url.URL) (labels.Labels, error)

ExternalLabels returns sorted external labels from /api/v1/status/config Prometheus endpoint. Note that configuration can be hot reloadable on Prometheus, so this config might change in runtime.

func (*Client) LabelNamesInGRPC

func (c *Client) LabelNamesInGRPC(ctx context.Context, base *url.URL, matchers []*labels.Matcher, startTime, endTime int64) ([]string, error)

LabelNamesInGRPC returns all known label names constrained by the given matchers. It uses gRPC errors. NOTE: This method is tested in pkg/store/prometheus_test.go against Prometheus.

func (*Client) LabelValuesInGRPC

func (c *Client) LabelValuesInGRPC(ctx context.Context, base *url.URL, label string, matchers []*labels.Matcher, startTime, endTime int64) ([]string, error)

LabelValuesInGRPC returns all known label values for a given label name. It uses gRPC errors. NOTE: This method is tested in pkg/store/prometheus_test.go against Prometheus.

func (*Client) MetricMetadataInGRPC

func (c *Client) MetricMetadataInGRPC(ctx context.Context, base *url.URL, metric string, limit int) (map[string][]metadatapb.Meta, error)

MetricMetadataInGRPC returns the metadata from Prometheus metric metadata API. It uses gRPC errors.

func (*Client) PromqlQueryInstant

func (c *Client) PromqlQueryInstant(ctx context.Context, base *url.URL, query string, t time.Time, opts QueryOptions) (promql.Vector, []string, error)

PromqlQueryInstant performs instant query and returns results in promql.Vector type that is compatible with promql package.

func (*Client) QueryInstant

func (c *Client) QueryInstant(ctx context.Context, base *url.URL, query string, t time.Time, opts QueryOptions) (model.Vector, []string, *Explanation, error)

QueryInstant performs an instant query using a default HTTP client and returns results in model.Vector type.

func (*Client) QueryRange

func (c *Client) QueryRange(ctx context.Context, base *url.URL, query string, startTime, endTime, step int64, opts QueryOptions) (model.Matrix, []string, *Explanation, error)

QueryRange performs a range query using a default HTTP client and returns results in model.Matrix type.

func (*Client) RulesInGRPC

func (c *Client) RulesInGRPC(ctx context.Context, base *url.URL, typeRules string) ([]*rulespb.RuleGroup, error)

RulesInGRPC returns the rules from Prometheus rules API. It uses gRPC errors. NOTE: This method is tested in pkg/store/prometheus_test.go against Prometheus.

func (*Client) SeriesInGRPC

func (c *Client) SeriesInGRPC(ctx context.Context, base *url.URL, matchers []*labels.Matcher, startTime, endTime int64) ([]map[string]string, error)

SeriesInGRPC returns the labels from Prometheus series API. It uses gRPC errors. NOTE: This method is tested in pkg/store/prometheus_test.go against Prometheus.

func (*Client) Snapshot

func (c *Client) Snapshot(ctx context.Context, base *url.URL, skipHead bool) (string, error)

Snapshot will request Prometheus to perform snapshot in directory returned by this function. Returned directory is relative to Prometheus data-dir. NOTE: `--web.enable-admin-api` flag has to be set on Prometheus. Added to Prometheus from v2.1. TODO(bwplotka): Add metrics.

func (*Client) TargetsInGRPC

func (c *Client) TargetsInGRPC(ctx context.Context, base *url.URL, stateTargets string) (*targetspb.TargetDiscovery, error)

type Explanation

type Explanation struct {
	Name     string         `json:"name"`
	Children []*Explanation `json:"children,omitempty"`
}

type Flags

type Flags struct {
	TSDBPath           string         `json:"storage.tsdb.path"`
	TSDBRetention      model.Duration `json:"storage.tsdb.retention"`
	TSDBMinTime        model.Duration `json:"storage.tsdb.min-block-duration"`
	TSDBMaxTime        model.Duration `json:"storage.tsdb.max-block-duration"`
	WebEnableAdminAPI  bool           `json:"web.enable-admin-api"`
	WebEnableLifecycle bool           `json:"web.enable-lifecycle"`
}

func (*Flags) UnmarshalJSON

func (f *Flags) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

HTTPClient sends an HTTP request and returns the response.

type QueryOptions

type QueryOptions struct {
	DoNotAddThanosParams    bool
	Deduplicate             bool
	PartialResponseStrategy storepb.PartialResponseStrategy
	Method                  string
	MaxSourceResolution     string
	Engine                  string
	Explain                 bool
	Analyze                 bool
	HTTPHeaders             http.Header
}

func (*QueryOptions) AddTo

func (p *QueryOptions) AddTo(values url.Values) error