probe

Documentation

Index

• Constants
• type Label
• type LabelSlice
  • func (ls LabelSlice) Len() int
  • func (ls LabelSlice) Less(a, b int) bool
  • func (ls LabelSlice) Swap(a, b int)
• type MetricGroup
  • func Await(p Probe) ([]MetricGroup, error)
• type Probe
• type ProbeResult
• type Sample
• type SampleSlice
  • func (ss SampleSlice) Len() int
  • func (ss SampleSlice) Less(a, b int) bool
  • func (ss SampleSlice) Swap(a, b int)

Constants

const (
	MetricTypeCounter   = "counter"
	MetricTypeGauge     = "gauge"
	MetricTypeHistogram = "histogram"
	MetricTypeSummary   = "summary"
)

Types

type Label

type Label struct {
	Name  string
	Value string
}

type LabelSlice

type LabelSlice []Label

func (LabelSlice) Len

func (ls LabelSlice) Len() int

func (LabelSlice) Less

func (ls LabelSlice) Less(a, b int) bool

func (LabelSlice) Swap

func (ls LabelSlice) Swap(a, b int)

type MetricGroup

type MetricGroup struct {
	Type    string
	Help    string
	Samples SampleSlice
}

func Await

func Await(p Probe) ([]MetricGroup, error)

type Probe

type Probe interface {
	Probe(ch chan<- ProbeResult) error
	fmt.Stringer
}

type ProbeResult

type ProbeResult struct {
	MGroup MetricGroup
	Error  error
}

type Sample

type Sample struct {
	FamilyName string // The metric family name. Ex.: http_request_duration_seconds
	MetricName string // The actual metric name. Ex.: http_request_duration_seconds_bucket
	Labels     LabelSlice
	Value      float64
}

type SampleSlice

type SampleSlice []Sample

func (SampleSlice) Len

func (ss SampleSlice) Len() int

func (SampleSlice) Less

func (ss SampleSlice) Less(a, b int) bool

func (SampleSlice) Swap

func (ss SampleSlice) Swap(a, b int)