Documentation

Overview

The metricsdebug package contains the implementation of a client to access metrics debug functions within state.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	base.ClientFacade
	// contains filtered or unexported fields
}

Client provides access to the metric debug api

func NewClient

func NewClient(st base.APICallCloser) *Client

NewClient creates a new client for accessing the metricsdebug api

func (*Client) GetMetrics

func (c *Client) GetMetrics(tags ...string) ([]params.MetricResult, error)

GetMetrics will receive metrics collected by the given entity

func (*Client) SetMeterStatus

func (c *Client) SetMeterStatus(tag, code, info string) error

SetMeterStatus will set the meter status on the given entity tag.

type MeterStatusClient

type MeterStatusClient interface {
	// SetMeterStatus will set the meter status on the given entity tag.
	SetMeterStatus(tag, code, info string) error
}

MeterStatusClient defines methods on the metricsdebug API end point.

type MetricsDebugClient

type MetricsDebugClient interface {
	// GetMetrics will receive metrics collected by the given entity tags
	// The tags act as a filter over what is to be returned. If no tags are
	// supplied GetMetrics will return all the metrics recorded in the
	// current model.
	GetMetrics(tags ...string) ([]params.MetricResult, error)
}

MetricsDebugClient defines the methods on the metricsdebug API end point.

Source Files