mirror of
https://github.com/kubernetes-sigs/prometheus-adapter.git
synced 2026-04-06 17:57:51 +00:00
af9f11c817
This commit introduces advanced configuration. The rate-interval and label-prefix flags are removed, and replaced by a configuration file that allows you to specify series queries and the rules for transforming those into metrics queries and API resources.
75 lines
3.4 KiB
Go
75 lines
3.4 KiB
Go
package config
|
|
|
|
type MetricsDiscoveryConfig struct {
|
|
// Rules specifies how to discover and map Prometheus metrics to
|
|
// custom metrics API resources. The rules are applied independently,
|
|
// and thus must be mutually exclusive. Rules will the same SeriesQuery
|
|
// will make only a single API call.
|
|
Rules []DiscoveryRule `yaml:"rules"`
|
|
}
|
|
|
|
// DiscoveryRule describes on set of rules for transforming Prometheus metrics to/from
|
|
// custom metrics API resources.
|
|
type DiscoveryRule struct {
|
|
// SeriesQuery specifies which metrics this rule should consider via a Prometheus query
|
|
// series selector query.
|
|
SeriesQuery string `yaml:"seriesQuery"`
|
|
// SeriesFilters specifies additional regular expressions to be applied on
|
|
// the series names returned from the query. This is useful for constraints
|
|
// that can't be represented in the SeriesQuery (e.g. series matching `container_.+`
|
|
// not matching `container_.+_total`. A filter will be automatically appended to
|
|
// match the form specified in Name.
|
|
SeriesFilters []RegexFilter `yaml:"seriesFilter"`
|
|
// Resources specifies how associated Kubernetes resources should be discovered for
|
|
// the given metrics.
|
|
Resources ResourceMapping `yaml:"resources"`
|
|
// Name specifies how the metric name should be transformed between custom metric
|
|
// API resources, and Prometheus metric names.
|
|
Name NameMapping `yaml:"name"`
|
|
// MetricsQuery specifies modifications to the metrics query, such as converting
|
|
// cumulative metrics to rate metrics. It is a template where `.LabelMatchers` is
|
|
// a the comma-separated base label matchers and `.Series` is the series name, and
|
|
// `.GroupBy` is the comma-separated expected group-by label names. The delimeters
|
|
// are `${` and `}$`.
|
|
MetricsQuery string `yaml:"metricsQueries,omitempty"`
|
|
}
|
|
|
|
// RegexFilter is a filter that matches positively or negatively against a regex.
|
|
// Only one field may be set at a time.
|
|
type RegexFilter struct {
|
|
Is string `yaml:"is,omitempty"`
|
|
IsNot string `yaml:"isNot,omitempty"`
|
|
}
|
|
|
|
// ResourceMapping specifies how to map Kubernetes resources to Prometheus labels
|
|
type ResourceMapping struct {
|
|
// Template specifies a golang string template for converting a Kubernetes
|
|
// group-resource to a Prometheus label. The template object contains
|
|
// the `.Group` and `.Resource` fields. The `.Group` field will have
|
|
// dots replaced with underscores, and the `.Resource` field will be
|
|
// singularized. The delimiters are `${` and `}$`.
|
|
Template string `yaml:"template,omitempty"`
|
|
// Overrides specifies exceptions to the above template, mapping label names
|
|
// to group-resources
|
|
Overrides map[string]GroupResource `yaml:"overrides,omitempty"`
|
|
}
|
|
|
|
// GroupResource represents a Kubernetes group-resource.
|
|
type GroupResource struct {
|
|
Group string `yaml:"group,omitempty"`
|
|
Resource string `yaml:"resource"`
|
|
}
|
|
|
|
// NameMapping specifies how to convert Prometheus metrics
|
|
// to/from custom metrics API resources.
|
|
type NameMapping struct {
|
|
// Matches is a regular expression that is used to match
|
|
// Prometheus series names. It may be left blank, in which
|
|
// case it is equivalent to `.*`.
|
|
Matches string `yaml:"prometheus"`
|
|
// As is the name used in the API. Captures from Matches
|
|
// are available for use here. If not specified, it defaults
|
|
// to $0 if no capture groups are present in Matches, or $1
|
|
// if only one is present, and will error if multiple are.
|
|
As string `yaml:"as"`
|
|
}
|