metrics

Documentation

Overview

Package metrics provides metric reporting for TestGrid components.

Index

• type Counter
• type CycleReporter
  • func (pr *CycleReporter) Fail()
  • func (pr *CycleReporter) Skip()
  • func (pr *CycleReporter) Success()
• type Cyclic
  • func (p *Cyclic) Start() *CycleReporter
• type Duration
• type Factory
  • func (f Factory) NewCyclic(componentName string) Cyclic
• type Int64
• type Metric

Types

type Counter

type Counter interface {
	Metric
	Add(int64, ...string)
}

Counter is a strictly-increasing metric.

type CycleReporter

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

CycleReporter reports the status of the task that spawned it and how long it took.

func (*CycleReporter) Fail

func (pr *CycleReporter) Fail()

Fail reports a failure or unexpected error

func (*CycleReporter) Skip

func (pr *CycleReporter) Skip()

Skip reports a cycle that was skipped due to an expected condition, flag, or configuration

func (*CycleReporter) Success

func (pr *CycleReporter) Success()

Success reports success

type Cyclic

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

Cyclic is a collection of metrics that measures how long a task takes to complete

func (*Cyclic) Start

func (p *Cyclic) Start() *CycleReporter

Start returns a PeriodicReporter that logs metrics when one of its methods are called.

type Duration

type Duration interface {
	Metric
	Set(time.Duration, ...string)
}

Duration is a metric describing a length of time

type Factory

type Factory struct {
	NewInt64    func(name, desc string, fields ...string) Int64
	NewCounter  func(name, desc string, fields ...string) Counter
	NewDuration func(name, desc string, fields ...string) Duration
}

Factory is a collection of functions that create metrics

func (Factory) NewCyclic

func (f Factory) NewCyclic(componentName string) Cyclic

NewCyclic derives a cycle metric from the given metrics

type Int64

type Int64 interface {
	Metric
	Set(int64, ...string)
}

Int64 is an int64 metric.

type Metric

type Metric interface {
	Name() string
}

Metric contains common metric functions.