prometheus

Documentation

Overview

Package prometheus provides utility functions to deal with prometheus endpoints

Index

• type MetricFamily
  • func ParseMetrics(data []byte) ([]*MetricFamily, error)
  • func ParseMetricsWithFilter(data []byte, filter []string) ([]*MetricFamily, error)
• type Reader
  • func NewReader(b []byte, filters []string) *Reader
  • func (r *Reader) Read(b []byte) (n int, err error)

Types

type MetricFamily

type MetricFamily struct {
	Name    string
	Type    string
	Samples model.Vector
}

MetricFamily represents a metric family that is returned by a prometheus endpoint

func ParseMetrics

func ParseMetrics(data []byte) ([]*MetricFamily, error)

ParseMetrics parses prometheus-formatted metrics from the input data.

func ParseMetricsWithFilter

func ParseMetricsWithFilter(data []byte, filter []string) ([]*MetricFamily, error)

ParseMetricsWithFilter parses prometheus-formatted metrics from the input data, ignoring lines which contain text that matches the passed in filter.

type Reader

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

A Reader implements the io.Reader interfaces by reading from a byte slice. Unlike a Buffer, a Reader is read-only and supports seeking. The zero value for Reader operates like a Reader of an empty slice.

func NewReader

func NewReader(b []byte, filters []string) *Reader

NewReader returns a new Reader reading from b.

func (*Reader) Read

func (r *Reader) Read(b []byte) (n int, err error)

Read implements the io.Reader interface.