metrics

Documentation

Overview

Package metrics provides the functionality to create custom metrics for applications

Package metrics is a generated GoMock package.

Index

• func NewCounter(m Metric, name, help string, labels ...string) error
• func NewGauge(m Metric, name, help string, labels ...string) error
• func NewHistogram(m Metric, name, help string, buckets []float64, labels ...string) error
• func NewSummary(m Metric, name, help string, labels ...string) error
• type Metric
  • func NewMetric() Metric
• type MockMetric
  • func NewMockMetric(ctrl *gomock.Controller) *MockMetric
  • func (m *MockMetric) AddCounter(name string, val float64, labels ...string) error
  • func (m *MockMetric) EXPECT() *MockMetricMockRecorder
  • func (m *MockMetric) IncCounter(name string, labels ...string) error
  • func (m *MockMetric) ObserveHistogram(name string, val float64, labels ...string) error
  • func (m *MockMetric) ObserveSummary(name string, val float64, labels ...string) error
  • func (m *MockMetric) SetGauge(name string, val float64, labels ...string) error
• type MockMetricMockRecorder
  • func (mr *MockMetricMockRecorder) AddCounter(name, val interface{}, labels ...interface{}) *gomock.Call
  • func (mr *MockMetricMockRecorder) IncCounter(name interface{}, labels ...interface{}) *gomock.Call
  • func (mr *MockMetricMockRecorder) ObserveHistogram(name, val interface{}, labels ...interface{}) *gomock.Call
  • func (mr *MockMetricMockRecorder) ObserveSummary(name, val interface{}, labels ...interface{}) *gomock.Call
  • func (mr *MockMetricMockRecorder) SetGauge(name, val interface{}, labels ...interface{}) *gomock.Call

Functions

func NewCounter

func NewCounter(m Metric, name, help string, labels ...string) error

NewCounter adds new custom counter metric

func NewGauge

func NewGauge(m Metric, name, help string, labels ...string) error

NewGauge adds new custom Gauge metric

func NewHistogram

func NewHistogram(m Metric, name, help string, buckets []float64, labels ...string) error

NewHistogram adds new custom Histogram metric

func NewSummary

func NewSummary(m Metric, name, help string, labels ...string) error

NewSummary add new custom Summary metric

Types

type Metric

type Metric interface {
	// IncCounter increments the value of counter by one
	IncCounter(name string, labels ...string) error
	// AddCounter adds specified value in counter
	AddCounter(name string, val float64, labels ...string) error
	// ObserveHistogram creates observation of Histogram for specified value
	ObserveHistogram(name string, val float64, labels ...string) error
	// SetGauge sets the specific value in Gauge
	SetGauge(name string, val float64, labels ...string) error
	// ObserveSummary creates observation of Summary for specified value
	ObserveSummary(name string, val float64, labels ...string) error
}

Metric provides support of custom metric

func NewMetric

func NewMetric() Metric

NewMetric factory function for custom metric

type MockMetric

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

MockMetric is a mock of Metric interface.

func NewMockMetric

func NewMockMetric(ctrl *gomock.Controller) *MockMetric

NewMockMetric creates a new mock instance.

func (*MockMetric) AddCounter

func (m *MockMetric) AddCounter(name string, val float64, labels ...string) error

AddCounter mocks base method.

func (*MockMetric) EXPECT

func (m *MockMetric) EXPECT() *MockMetricMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockMetric) IncCounter

func (m *MockMetric) IncCounter(name string, labels ...string) error

IncCounter mocks base method.

func (*MockMetric) ObserveHistogram

func (m *MockMetric) ObserveHistogram(name string, val float64, labels ...string) error

ObserveHistogram mocks base method.

func (*MockMetric) ObserveSummary

func (m *MockMetric) ObserveSummary(name string, val float64, labels ...string) error

ObserveSummary mocks base method.

func (*MockMetric) SetGauge

func (m *MockMetric) SetGauge(name string, val float64, labels ...string) error

SetGauge mocks base method.

type MockMetricMockRecorder

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

MockMetricMockRecorder is the mock recorder for MockMetric.

func (*MockMetricMockRecorder) AddCounter

func (mr *MockMetricMockRecorder) AddCounter(name, val interface{}, labels ...interface{}) *gomock.Call

AddCounter indicates an expected call of AddCounter.

func (*MockMetricMockRecorder) IncCounter

func (mr *MockMetricMockRecorder) IncCounter(name interface{}, labels ...interface{}) *gomock.Call

IncCounter indicates an expected call of IncCounter.

func (*MockMetricMockRecorder) ObserveHistogram

func (mr *MockMetricMockRecorder) ObserveHistogram(name, val interface{}, labels ...interface{}) *gomock.Call

ObserveHistogram indicates an expected call of ObserveHistogram.

func (*MockMetricMockRecorder) ObserveSummary

func (mr *MockMetricMockRecorder) ObserveSummary(name, val interface{}, labels ...interface{}) *gomock.Call

ObserveSummary indicates an expected call of ObserveSummary.

func (*MockMetricMockRecorder) SetGauge

func (mr *MockMetricMockRecorder) SetGauge(name, val interface{}, labels ...interface{}) *gomock.Call

SetGauge indicates an expected call of SetGauge.