metrics

Documentation

Index

• Variables
• func InitializeMetrics(metric string, ci bool) error
• type Metrics
  • func (m *Metrics) Start(location string)
  • func (m *Metrics) Stop()

Variables

var (
	// Metric is the global metrics object
	Metric = &Metrics{
		Disable: true,
	}
)

Functions

func InitializeMetrics

func InitializeMetrics(metric string, ci bool) error

InitializeMetrics - creates a new instance of a Metrics based on the type of metrics specified

Types

type Metrics

type Metrics struct {
	Disable bool
	// contains filtered or unexported fields
}

Metrics - structure to keep information relevant to the metrics calculation Disable - disables metric calculations

func (*Metrics) Start

func (m *Metrics) Start(location string)

Start - starts gathering metrics for the location specified

func (*Metrics) Stop

func (m *Metrics) Stop()

Stop - stops gathering metrics and logs the result