metrics

Documentation

Overview

Package metrics defines metrics utilities.

Index

• type HistogramBucket
  • func (bucket HistogramBucket) String() string
• type HistogramBuckets
  • func MergeHistograms(a HistogramBuckets, b HistogramBuckets) (HistogramBuckets, error)
  • func ParseHistogram(scale string, histo *dto.Histogram) (buckets HistogramBuckets, err error)
  • func (buckets HistogramBuckets) Len() int
  • func (buckets HistogramBuckets) Less(i, j int) bool
  • func (buckets HistogramBuckets) Swap(i, j int)
  • func (buckets HistogramBuckets) Table() string
• type RequestsSummary
  • func (rs RequestsSummary) JSON() string
  • func (rs RequestsSummary) Table() string

Types

type HistogramBucket

type HistogramBucket struct {
	Scale      string  `json:"scale"`
	LowerBound float64 `json:"lower-bound"`
	UpperBound float64 `json:"upper-bound"`
	Count      uint64  `json:"count"`
}

HistogramBucket represents metrics latency bucket.

func (HistogramBucket) String

func (bucket HistogramBucket) String() string

type HistogramBuckets

type HistogramBuckets []HistogramBucket

func MergeHistograms

func MergeHistograms(a HistogramBuckets, b HistogramBuckets) (HistogramBuckets, error)

MergeHistograms merges two histograms.

func ParseHistogram

func ParseHistogram(scale string, histo *dto.Histogram) (buckets HistogramBuckets, err error)

ParseHistogram parses Prometheus histogram.

func (HistogramBuckets) Len

func (buckets HistogramBuckets) Len() int

func (HistogramBuckets) Less

func (buckets HistogramBuckets) Less(i, j int) bool

func (HistogramBuckets) Swap

func (buckets HistogramBuckets) Swap(i, j int)

func (HistogramBuckets) Table

func (buckets HistogramBuckets) Table() string

Table converts "HistogramBuckets" to table.

type RequestsSummary

type RequestsSummary struct {
	// SuccessTotal is the number of successful client requests.
	SuccessTotal float64 `json:"success-total" read-only:"true"`
	// FailureTotal is the number of failed client requests.
	FailureTotal float64 `json:"failure-total" read-only:"true"`
	// LatencyHistogram is the client requests latency histogram.
	LatencyHistogram HistogramBuckets `json:"latency-histogram,omitempty" read-only:"true"`
}

RequestsSummary represents request results.

func (RequestsSummary) JSON

func (rs RequestsSummary) JSON() string

func (RequestsSummary) Table

func (rs RequestsSummary) Table() string