mimir

Documentation

Overview

Package mimir provides a simple client for the required Mimir API resources.

Index

• type BasicAuthTransport
  • func (t *BasicAuthTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type Client
  • func NewClient(config Config) (*Client, error)
  • func (c *Client) DeleteNamespace(ctx context.Context, namespace string) error
  • func (c *Client) Ready(ctx context.Context) error
  • func (c *Client) SetRuleGroup(ctx context.Context, namespace string, ruleGroup rulefmt.RuleGroup) error
• type Config

Types

type BasicAuthTransport

type BasicAuthTransport struct {
	Username  string
	Password  string
	Transport http.RoundTripper
}

BasicAuthTransport is a transport that adds basic auth to the request.

func (*BasicAuthTransport) RoundTrip

func (t *BasicAuthTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip adds basic auth to the request.

type Client

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

Client is a simple client for the required Mimir API resources.

func NewClient

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

NewClient creates a new client with the given configuration.

func (*Client) DeleteNamespace

func (c *Client) DeleteNamespace(ctx context.Context, namespace string) error

DeleteNamespace deletes all the rule groups in a namespace (including the namespace itself).

func (*Client) Ready

func (c *Client) Ready(ctx context.Context) error

Ready checks if mimir is ready to serve traffic.

func (*Client) SetRuleGroup

func (c *Client) SetRuleGroup(ctx context.Context, namespace string, ruleGroup rulefmt.RuleGroup) error

SetRuleGroup creates or updates a rule group.

type Config

type Config struct {
	Address           string
	PrometheusPrefix  string
	BasicAuthUsername string
	BasicAuthPassword string
}

Config is used to configure the client.