client

Documentation

Overview

Package client provides a client interface to the Agent HTTP API.

Index

• type Client
  • func New(addr string) *Client
• type PrometheusClient

Types

type Client

type Client struct {
	PrometheusClient
}

Client is a collection of all subsystem clients.

func New

func New(addr string) *Client

New creates a new Client.

type PrometheusClient

type PrometheusClient interface {
	// Instances runs the list of currently running instances.
	Instances(ctx context.Context) ([]string, error)

	// ListConfigs runs the list of instance configs stored in the config
	// management KV store.
	ListConfigs(ctx context.Context) (*configapi.ListConfigurationsResponse, error)

	// GetConfiguration returns a named configuration from the config
	// management KV store.
	GetConfiguration(ctx context.Context, name string) (*instance.Config, error)

	// PutConfiguration adds or updates a named configuration into the
	// config management KV store.
	PutConfiguration(ctx context.Context, name string, cfg *instance.Config) error

	// DeleteConfiguration removes a named configuration from the config
	// management KV store.
	DeleteConfiguration(ctx context.Context, name string) error
}

PrometheusClient is the client interface to the API exposed by the Prometheus subsystem of the Grafana Agent.