metrics

Documentation

Overview

Package metrics collects performance metrics.

Index

• type Metric
  • func Start(tag string) *Metric
  • func (t *Metric) AddTag(tag string)
  • func (t *Metric) Done()
• type Metrics
  • func List() Metrics

Types

type Metric

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

Metric is a single metric that's being recorded.

func Start

func Start(tag string) *Metric

Start recording performance metrics with the given tag.

func (*Metric) AddTag

func (t *Metric) AddTag(tag string)

AddTag adds another part to this metric's tag, for example:

m := Start("hello")
defer m.Done()

if isCached {
    m.AddTag("cached")
    return cachedItem
}

This will record the cached entries as "hello.cached", separate from the regular "hello" entries.

func (*Metric) Done

func (t *Metric) Done()

Done finishes recording this performance metrics, and actually records it.

type Metrics

type Metrics []struct {
	Tag   string
	Times ztime.Durations
}

func List

func List() Metrics