mirror of
https://github.com/kubernetes-sigs/prometheus-adapter.git
synced 2026-04-06 17:57:51 +00:00
4e99936e4f
This adds a walkthrough to the docs covering setting up Prometheus and the adapter, as well as autoscaling a sample application on custom metrics.
44 lines
2 KiB
Markdown
44 lines
2 KiB
Markdown
Metrics Format and Presentation
|
|
===============================
|
|
|
|
The adapter gathers the names of available metrics from Prometheus at the
|
|
specified interval. Only metrics of the following forms are considered:
|
|
|
|
- "container" metrics (cAdvisor container metrics): series with a name
|
|
starting with `container_`, as well as non-empty `namespace` and
|
|
`pod_name` labels.
|
|
|
|
- "namespaced" metrics (metrics describing namespaced Kubernetes objects):
|
|
series with non-empty namespace labels (which don't start with
|
|
`container_`).
|
|
|
|
*Note*: Currently, metrics on non-namespaced objects (besides namespaces
|
|
themselves) are not supported.
|
|
|
|
Metrics in Prometheus are converted in the custom-metrics-API metrics as
|
|
follows:
|
|
|
|
1. The metric name and type are decided:
|
|
- For container metrics, the `container_` prefix is removed
|
|
- If the metric has the `_total` suffix, it is marked as a counter
|
|
metric, and the suffix is removed
|
|
- If the metric has the `_seconds_total` suffix, it is marked as
|
|
a seconds counter metric, and the suffix is removed.
|
|
- If the metric has none of the above suffixes, is is marked as a gauge
|
|
metric, and the metric name is used as-is
|
|
|
|
2. Relevant resources are associated with the metric:
|
|
- container metrics are associated with pods only
|
|
- for non-container metrics, each label on the series is considered. If
|
|
that label represents a resource (without the group) available on the
|
|
server, the metric is associated with that resource. A metric may be
|
|
associated with multiple resources.
|
|
|
|
When retrieving counter and seconds-counter metrics, the adapter requests
|
|
the metrics as a rate over the configured amount of time. For metrics
|
|
with multiple associated resources, the adapter requests the metric
|
|
aggregated over all non-requested metrics.
|
|
|
|
The adapter does not consider resources consumed by the "POD" container,
|
|
which exists as part of all Kubernetes pods running in Docker simply
|
|
supports the existance of the pod's shared network namespace.
|