api

Documentation

Overview

Package api contains the public interface

Index

• type Distribution
• type Facade
• type Snapshot
• type Stopwatch

Types

type Distribution

type Distribution interface {
	SampleCount() int64
	Min() float64
	Max() float64
	Avg() float64
	StdDev() float64
}

Distribution models a statistical distribution this interface is not json.Marshalled, it's the underlying type, see common.distribution

type Facade

type Facade interface {
	StartStopwatch() Stopwatch

	// Records the elapsed time of the stopwatch and adds that to the distribution identified by key.
	// Returns the recorded millis
	RecordElapsedTime(key string, stopwatch Stopwatch) float64

	// Records duration of the subject function and adds that to the distribution identified by key.
	// Returns the recorded millis
	MeasureFunc(key string, subject func()) float64

	// MeasureFuncCanPanic runs the subject function and records it's execution duration under the distribution identified
	// with key. When subject() panics, the measurement is recorded under the same key with .panic appended. This function
	// itself will panic with the same error as the inner function.
	MeasureFuncCanPanic(key string, subject func()) float64

	// Increments the counter identified with key by 1. If the counter does not yet exist, it will be created
	// with initial value of 1
	IncrementCounter(key string)

	// Decrements the counter identified with key by 1. If the counter does not yet exist, it will be created
	// with initial value of -1
	DecrementCounter(key string)

	// Adds value to the counter identified with key with key, if the counter does not yet exist, it will be created
	// and initialized to value. Value can be negative.
	AddToCounter(key string, value int64)

	// Adds a value to the sample distribution identified by key. If the distribution does not yet exist, value will be it's initial value.
	AddSample(key string, value float64)

	// Clears all durations, counters and samples
	Reset()

	// Creates a snapshot containing all currently registered durations, counters and samples
	Snapshot() Snapshot

	// Creates a snapshot and then calls Reset()
	// Also, see documentation above
	SnapshotAndReset() Snapshot
}

Facade is the end-user interface for adding, removing and querying data

type Snapshot

type Snapshot interface {
	CreatedTimestamp() int64
	StartedTimestamp() int64
	Durations() map[string]Distribution
	Counters() map[string]int64
	Samples() map[string]Distribution
}

Snapshot resembles an internal snapshot of the data

type Stopwatch

type Stopwatch interface {
	ElapsedMillis() float64
}

Stopwatch measures elapsed time