client

Documentation

Index

• type Client
  • func New(connector connector.Connector, opts ...OptionFunc) (*Client, error)
  • func (c *Client) MetricFamiliesGetFunc() prometheus.FetchAndFilterMetricsFamilies
• type OptionFunc
  • func WithLogger(logger *log.Logger) OptionFunc
  • func WithMaxRetries(retries int) OptionFunc

Types

type Client

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

Client implements a client for ControlPlane component.

func New

func New(connector connector.Connector, opts ...OptionFunc) (*Client, error)

New builds a Client using the given options.

func (*Client) MetricFamiliesGetFunc

func (c *Client) MetricFamiliesGetFunc() prometheus.FetchAndFilterMetricsFamilies

MetricFamiliesGetFunc returns a function that obtains metric families from a list of prometheus queries. Notice that it does not satisfy prometheus.MetricFamiliesGetFunc, since the url path is injected by the connector

type OptionFunc

type OptionFunc func(c *Client) error

func WithLogger

func WithLogger(logger *log.Logger) OptionFunc

WithLogger returns an OptionFunc to change the logger from the default noop logger.

func WithMaxRetries

func WithMaxRetries(retries int) OptionFunc

WithMaxRetries returns an OptionFunc to change the number of retries used int Pester Client.