util

Documentation

Index

• func ExtractMetricNameFromMetric(m model.Metric) (model.LabelValue, error)
• func ExtractMetricNameMatcherFromMatchers(matchers []*metric.LabelMatcher) (*metric.LabelMatcher, []*metric.LabelMatcher, bool)
• func FromLabelPairs(labelPairs []client.LabelPair) model.Metric
• func FromMetricsForLabelMatchersRequest(req *client.MetricsForLabelMatchersRequest) (model.Time, model.Time, []metric.LabelMatchers, error)
• func FromMetricsForLabelMatchersResponse(resp *client.MetricsForLabelMatchersResponse) []model.Metric
• func FromQueryRequest(req *client.QueryRequest) (model.Time, model.Time, []*metric.LabelMatcher, error)
• func FromQueryResponse(resp *client.QueryResponse) model.Matrix
• func FromWriteRequest(req *client.WriteRequest) []model.Sample
• func GetFirstAddressOf(name string) (string, error)
• func Max64(a, b int64) int64
• func MergeSamples(a, b []model.SamplePair) []model.SamplePair
• func Min(a, b int) int
• func Min64(a, b int64) int64
• func ParseProtoRequest(ctx context.Context, r *http.Request, req proto.Message, ...) ([]byte, error)
• func RegisterFlags(rs ...Registerer)
• func SerializeProtoResponse(w http.ResponseWriter, resp proto.Message, compression CompressionType) error
• func SplitFiltersAndMatchers(allMatchers []*metric.LabelMatcher) (filters, matchers []*metric.LabelMatcher)
• func ToLabelPairs(metric model.Metric) []client.LabelPair
• func ToMetricsForLabelMatchersRequest(from, to model.Time, matchersSet []metric.LabelMatchers) (*client.MetricsForLabelMatchersRequest, error)
• func ToMetricsForLabelMatchersResponse(metrics []model.Metric) *client.MetricsForLabelMatchersResponse
• func ToQueryRequest(from, to model.Time, matchers []*metric.LabelMatcher) (*client.QueryRequest, error)
• func ToQueryResponse(matrix model.Matrix) *client.QueryResponse
• func ToWriteRequest(samples []model.Sample) *client.WriteRequest
• func ValidateSample(s *model.Sample) error
• func WithContext(ctx context.Context) log.Logger
• func WithUserID(userID string) log.Logger
• func WriteJSONResponse(w http.ResponseWriter, v interface{})
• type CompressionType
  • func CompressionTypeFor(version string) CompressionType
• type DayValue
  • func NewDayValue(t model.Time) DayValue
  • func (v *DayValue) IsSet() bool
  • func (v *DayValue) Set(s string) error
  • func (v DayValue) String() string
• type HashBucketHistogram
  • func NewHashBucketHistogram(opts HashBucketHistogramOpts) HashBucketHistogram
• type HashBucketHistogramOpts
• type Op
• type PriorityQueue
  • func NewPriorityQueue() *PriorityQueue
  • func (pq *PriorityQueue) Close()
  • func (pq *PriorityQueue) Dequeue() Op
  • func (pq *PriorityQueue) DrainAndClose()
  • func (pq *PriorityQueue) Enqueue(op Op)
  • func (pq *PriorityQueue) Length() int
• type Registerer
• type URLValue
  • func (v *URLValue) Set(s string) error
  • func (v URLValue) String() string

Functions

func ExtractMetricNameFromMetric

func ExtractMetricNameFromMetric(m model.Metric) (model.LabelValue, error)

ExtractMetricNameFromMetric extract the metric name from a model.Metric

func ExtractMetricNameMatcherFromMatchers

func ExtractMetricNameMatcherFromMatchers(matchers []*metric.LabelMatcher) (*metric.LabelMatcher, []*metric.LabelMatcher, bool)

ExtractMetricNameMatcherFromMatchers extracts the metric name from a set of matchers

func FromLabelPairs

func FromLabelPairs(labelPairs []client.LabelPair) model.Metric

FromLabelPairs unpack a []client.LabelPair to a model.Metric

func FromMetricsForLabelMatchersRequest

func FromMetricsForLabelMatchersRequest(req *client.MetricsForLabelMatchersRequest) (model.Time, model.Time, []metric.LabelMatchers, error)

FromMetricsForLabelMatchersRequest unpacks a MetricsForLabelMatchersRequest proto

func FromMetricsForLabelMatchersResponse

func FromMetricsForLabelMatchersResponse(resp *client.MetricsForLabelMatchersResponse) []model.Metric

FromMetricsForLabelMatchersResponse unpacks a MetricsForLabelMatchersResponse proto

func FromQueryRequest

func FromQueryRequest(req *client.QueryRequest) (model.Time, model.Time, []*metric.LabelMatcher, error)

FromQueryRequest unpacks a QueryRequest proto.

func FromQueryResponse

func FromQueryResponse(resp *client.QueryResponse) model.Matrix

FromQueryResponse unpacks a QueryResponse proto.

func FromWriteRequest

func FromWriteRequest(req *client.WriteRequest) []model.Sample

FromWriteRequest converts a WriteRequest proto into an array of samples.

func GetFirstAddressOf

func GetFirstAddressOf(name string) (string, error)

GetFirstAddressOf returns the first IPv4 address of the supplied interface name.

func Max64

func Max64(a, b int64) int64

Max64 returns the maximum of two int64s

func MergeSamples

func MergeSamples(a, b []model.SamplePair) []model.SamplePair

MergeSamples merges and dedupes two sets of already sorted sample pairs.

func Min

func Min(a, b int) int

Min returns the minimum of two ints

func Min64

func Min64(a, b int64) int64

Min64 returns the minimum of two int64s

func ParseProtoRequest

func ParseProtoRequest(ctx context.Context, r *http.Request, req proto.Message, compression CompressionType) ([]byte, error)

ParseProtoRequest parses a proto from the body of an HTTP request.

func RegisterFlags

func RegisterFlags(rs ...Registerer)

RegisterFlags registers flags with the provided Registerers

func SerializeProtoResponse

func SerializeProtoResponse(w http.ResponseWriter, resp proto.Message, compression CompressionType) error

SerializeProtoResponse serializes a protobuf response into an HTTP response.

func SplitFiltersAndMatchers

func SplitFiltersAndMatchers(allMatchers []*metric.LabelMatcher) (filters, matchers []*metric.LabelMatcher)

SplitFiltersAndMatchers splits empty matchers off, which are treated as filters, see #220

func ToLabelPairs

func ToLabelPairs(metric model.Metric) []client.LabelPair

ToLabelPairs builds a []client.LabelPair from a model.Metric

func ToMetricsForLabelMatchersRequest

func ToMetricsForLabelMatchersRequest(from, to model.Time, matchersSet []metric.LabelMatchers) (*client.MetricsForLabelMatchersRequest, error)

ToMetricsForLabelMatchersRequest builds a MetricsForLabelMatchersRequest proto

func ToMetricsForLabelMatchersResponse

func ToMetricsForLabelMatchersResponse(metrics []model.Metric) *client.MetricsForLabelMatchersResponse

ToMetricsForLabelMatchersResponse builds a MetricsForLabelMatchersResponse proto

func ToQueryRequest

func ToQueryRequest(from, to model.Time, matchers []*metric.LabelMatcher) (*client.QueryRequest, error)

ToQueryRequest builds a QueryRequest proto.

func ToQueryResponse

func ToQueryResponse(matrix model.Matrix) *client.QueryResponse

ToQueryResponse builds a QueryResponse proto.

func ToWriteRequest

func ToWriteRequest(samples []model.Sample) *client.WriteRequest

ToWriteRequest converts an array of samples into a WriteRequest proto.

func ValidateSample

func ValidateSample(s *model.Sample) error

ValidateSample returns an err if the sample is invalid

func WithContext

func WithContext(ctx context.Context) log.Logger

WithContext returns a Logger that has information about the current user in its details.

e.g.

log := util.WithContext(ctx)
log.Errorf("Could not chunk chunks: %v", err)

func WithUserID

func WithUserID(userID string) log.Logger

WithUserID returns a Logger that has information about the current user in its details.

func WriteJSONResponse

func WriteJSONResponse(w http.ResponseWriter, v interface{})

WriteJSONResponse writes some JSON as a HTTP response.

Types

type CompressionType

type CompressionType int

CompressionType for encoding and decoding requests and responses.

const (
	NoCompression CompressionType = iota
	FramedSnappy
	RawSnappy
)

Values for CompressionType

func CompressionTypeFor

func CompressionTypeFor(version string) CompressionType

CompressionTypeFor a given version of the Prometheus remote storage protocol. See https://github.com/prometheus/prometheus/issues/2692.

type DayValue

type DayValue struct {
	model.Time
	// contains filtered or unexported fields
}

DayValue is a model.Time that can be used as a flag. NB it only parses days!

func NewDayValue

func NewDayValue(t model.Time) DayValue

NewDayValue makes a new DayValue; will round t down to the nearest midnight.

func (*DayValue) IsSet

func (v *DayValue) IsSet() bool

IsSet returns true is the DayValue has been set.

func (*DayValue) Set

func (v *DayValue) Set(s string) error

Set implements flag.Value

func (DayValue) String

func (v DayValue) String() string

String implements flag.Value

type HashBucketHistogram

type HashBucketHistogram interface {
	prometheus.Metric
	prometheus.Collector

	Observe(string, uint32)
	Stop()
}

HashBucketHistogram is used to track a histogram of per-bucket rates.

For instance, I want to know that 50% of rows are getting X QPS or lower and 99% are getting Y QPS of lower. At first glance, this would involve tracking write rate per row, and periodically sticking those numbers in a histogram. To make this fit in memory: instead of per-row, we keep N buckets of counters and hash the key to a bucket. Then every second we update a histogram with the bucket values (and zero the buckets).

Note, we want this metric to be relatively independent of the number of hash buckets and QPS of the service - we're trying to measure how well load balanced the write load is. So we normalise the values in the hash buckets such that if all buckets are '1', then we have even load. We do this by multiplying the number of ops per bucket by the number of buckets, and dividing by the number of ops.

func NewHashBucketHistogram

func NewHashBucketHistogram(opts HashBucketHistogramOpts) HashBucketHistogram

NewHashBucketHistogram makes a new HashBucketHistogram

type HashBucketHistogramOpts

type HashBucketHistogramOpts struct {
	prometheus.HistogramOpts
	HashBuckets int
}

HashBucketHistogramOpts are the options for making a HashBucketHistogram

type Op

type Op interface {
	Key() string
	Priority() int64 // The larger the number the higher the priority.
}

Op is an operation on the priority queue.

type PriorityQueue

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

PriorityQueue is a priority queue.

func NewPriorityQueue

func NewPriorityQueue() *PriorityQueue

NewPriorityQueue makes a new priority queue.

func (*PriorityQueue) Close

func (pq *PriorityQueue) Close()

Close signals that the queue is closed. A closed queue will not accept new items.

func (*PriorityQueue) Dequeue

func (pq *PriorityQueue) Dequeue() Op

Dequeue will return the op with the highest priority; block if queue is empty; returns nil if queue is closed.

func (*PriorityQueue) DrainAndClose

func (pq *PriorityQueue) DrainAndClose()

DrainAndClose closed the queue and removes all the items from it.

func (*PriorityQueue) Enqueue

func (pq *PriorityQueue) Enqueue(op Op)

Enqueue adds an operation to the queue in priority order. If the operation is already on the queue, it will be ignored.

func (*PriorityQueue) Length

func (pq *PriorityQueue) Length() int

Length returns the length of the queue.

type Registerer

type Registerer interface {
	RegisterFlags(*flag.FlagSet)
}

Registerer is a thing that can RegisterFlags

type URLValue

type URLValue struct {
	*url.URL
}

URLValue is a url.URL that can be used as a flag.

func (*URLValue) Set

func (v *URLValue) Set(s string) error

Set implements flag.Value

func (URLValue) String

func (v URLValue) String() string

String implements flag.Value