Documentation ¶
Overview ¶
Package gauge provides mechanisms for gauging values.
Index ¶
Constants ¶
const ( // OkMessage is the default health.Message returned // for things that are not currently on fire. OkMessage = "ok" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FloatGauger ¶
A FloatGauger represents Gaugable float values.
func Floats ¶
func Floats(varname string, length int) (FloatGauger, error)
Floats will create a FloatGauger.
The value of varname is exported by varexp, and so it should follow the convention of being all lowercase with dashes, preferably prefixed with the name of the executable.
The specified length must be greater than zero.
Operations made available by the underlying implementation are threadsafe.
type Gaugeable ¶
Gaugeable represents something which can apply thresholds to values collected over time, producing a resultant health.Health which represents the current state of the thing being gauged.
type IntGauger ¶
An IntGauger represents Gaugable int values.
func Ints ¶
Ints will create an IntGauger.
The value of varname is exported by varexp, and so it should follow the convention of being all lowercase with dashes, and preferably prefixed with the name of the executable.
The specified length must be greater than zero.
Operations made available by the underlying implementation are threadsafe.
type MaxFloatThreshold ¶
type MaxFloatThreshold floatThreshold
MaxFloatThreshold represents a maximum threshold over a sequence of float64.
type MaxIntThreshold ¶
type MaxIntThreshold intThreshold
MaxIntThreshold represents a maximum threshold over a sequence of int.
type MinFloatThreshold ¶
type MinFloatThreshold floatThreshold
MinFloatThreshold represents a minimum threshold over a sequence of float64.
type MinIntThreshold ¶
type MinIntThreshold intThreshold
MinIntThreshold represents a minimum threshold over a sequence of integers.