metricsdebug

Documentation

Overview

Package metricsdebug contains the implementation of an api endpoint for metrics debug functionality.

Index

• type MetricsDebug
• type MetricsDebugAPI
  • func NewMetricsDebugAPI(st *state.State, resources facade.Resources, authorizer facade.Authorizer) (*MetricsDebugAPI, error)
  • func (api *MetricsDebugAPI) GetMetrics(args params.Entities) (params.MetricResults, error)
  • func (api *MetricsDebugAPI) SetMeterStatus(args params.MeterStatusParams) (params.ErrorResults, error)

Types

type MetricsDebug

type MetricsDebug interface {
	// GetMetrics returns all metrics stored by the state server.
	GetMetrics(arg params.Entities) (params.MetricResults, error)

	// SetMeterStatus will set the meter status on the given entity tag.
	SetMeterStatus(params.MeterStatusParams) (params.ErrorResults, error)
}

MetricsDebug defines the methods on the metricsdebug API end point.

type MetricsDebugAPI

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

MetricsDebugAPI implements the metricsdebug interface and is the concrete implementation of the api end point.

func NewMetricsDebugAPI

func NewMetricsDebugAPI(
	st *state.State,
	resources facade.Resources,
	authorizer facade.Authorizer,
) (*MetricsDebugAPI, error)

NewMetricsDebugAPI creates a new API endpoint for calling metrics debug functions.

func (*MetricsDebugAPI) GetMetrics

func (api *MetricsDebugAPI) GetMetrics(args params.Entities) (params.MetricResults, error)

GetMetrics returns all metrics stored by the state server.

func (*MetricsDebugAPI) SetMeterStatus

func (api *MetricsDebugAPI) SetMeterStatus(args params.MeterStatusParams) (params.ErrorResults, error)

SetMeterStatus sets meter statuses for entities.