metadata

Documentation

Index

• Constants
• type Cache
  • func NewCache(client *http.Client, promURL *url.URL, staticMetadata []*Entry) *Cache
  • func (c *Cache) Get(ctx context.Context, job, instance, metric string) (*Entry, error)
• type Entry
• type Kind
• type ValueType

Constants

const (
	GAUGE      Kind = 1
	CUMULATIVE Kind = 2
	DELTA      Kind = 3

	DOUBLE       ValueType = 1
	INT64        ValueType = 2
	DISTRIBUTION ValueType = 3
	HISTOGRAM    ValueType = 4
)

const DefaultEndpointPath = "api/v1/targets/metadata"

DefaultEndpointPath is the default HTTP path on which Prometheus serves the target metadata endpoint.

const MetricTypeUntyped = "untyped"

The old metric type value for textparse.MetricTypeUnknown that is used in Prometheus 2.4 and earlier.

Types

type Cache

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

Cache populates and maintains a cache of metric metadata it retrieves from a given Prometheus server. Its methods are not safe for concurrent use.

func NewCache

func NewCache(client *http.Client, promURL *url.URL, staticMetadata []*Entry) *Cache

NewCache returns a new cache that gets populated by the metadata endpoint at the given URL. It uses the default endpoint path if no specific path is provided.

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, job, instance, metric string) (*Entry, error)

Get returns metadata for the given metric and job. If the metadata is not in the cache, it blocks until we have retrieved it from the Prometheus server. If no metadata is found in the Prometheus server, a matching entry from the static metadata or nil is returned.

type Entry

type Entry struct {
	Metric     string
	MetricType textparse.MetricType
	ValueType  ValueType
	Help       string
}

type Kind

type Kind int

type ValueType

type ValueType int