istio.io/prometheus.md at a8c82ab313ef960cbc0f561135eceb8e7ced1968

8.4 KiB

Raw Blame History

title	overview	order	layout	type
prometheus Config	Generated documentation for Mixer's prometheus Adapter Configuration Schema	40	docs	markdown

Index

Params (message)
Params.MetricInfo (message)
Params.MetricInfo.BucketsDefinition (message)
Params.MetricInfo.BucketsDefinition.Explicit (message)
Params.MetricInfo.BucketsDefinition.Exponential (message)
Params.MetricInfo.BucketsDefinition.Linear (message)
Params.MetricInfo.Kind (enum)

Params

Field	Type	Description
`metrics[]`	repeated MetricInfo	The set of metrics to represent in Prometheus. If a metric is defined in Istio but doesn't have a corresponding shape here, it will not be populated at runtime.

MetricInfo

Describes how a metric should be represented in Prometheus.

Field	Type	Description
`name`	string	Recommended. The name is used to register the prometheus metric. It must be unique across all prometheus metrics as prometheus does not allow duplicate names. If name is not specified a sanitized version of instanceName is used.
`instanceName`	string	Required. The name is the fully qualified name of the Istio metric instance that this MetricInfo processes.
`description`	string	Optional. A human readable description of this metric.
`kind`	Kind
`buckets`	BucketsDefinition	For metrics with a metric kind of DISTRIBUTION, this provides a mechanism for configuring the buckets that will be used to store the aggregated values. This field must be provided for metrics declared to be of type DISTRIBUTION. This field will be ignored for non-distribution metric kinds.
`labelNames[]`	repeated string	The names of labels to use: these need to match the dimensions of the Istio metric.

BucketsDefinition

Describes buckets for DISTRIBUTION kind metrics.

Field	Type	Description
`linearBuckets`	Linear (oneof )	The linear buckets.
`exponentialBuckets`	Exponential (oneof )	The exponential buckets.
`explicitBuckets`	Explicit (oneof )	The explicit buckets.

Explicit

Specifies a set of buckets with arbitrary widths.

There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:

Upper bound (0 <= i < N-1): bounds[i]
Lower bound (1 <= i < N): bounds[i - 1]

The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.

Field	Type	Description
`bounds[]`	repeated double	The values must be monotonically increasing.

Exponential

Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.

There are numFiniteBuckets + 2 (= N) buckets. The two additional buckets are the underflow and overflow buckets.

Bucket i has the following boundaries:

Upper bound (0 <= i < N-1): scale * (growthFactor ^ i)
Lower bound (1 <= i < N): scale * (growthFactor ^ (i - 1))

Field	Type	Description
`numFiniteBuckets`	int32	Must be greater than 0.
`growthFactor`	double	Must be greater than 1.
`scale`	double	Must be greater than 0.

Linear

Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.