README
¶
Gardener Metrics Exporter
The gardener-metrics-exporter is a Prometheus metrics exporter for
Gardener service-level related metrics.
This application requires Go 1.9 or later.
Metrics
| Metric | Description | Scope | Type |
|---|---|---|---|
| garden_shoot_operation_states | Operation state of a Shoot | Shoot | Gauge |
| garden_shoot_info | Information to a Shoot | Shoot | Gauge |
| garden_shoot_condition | Condition state of a Shoot | Shoot | Gauge |
| garden_shoot_node_min_total | Min node count of a Shoot | Shoot | Gauge |
| garden_shoot_node_max_total | Max node count of a Shoot | Shoot | Gauge |
| garden_shoot_worker_node_min_total | Min node count of a Shoot worker group | Shoot | Gauge |
| garden_shoot_worker_node_max_total | Max node count of a Shoot worker group | Shoot | Gauge |
| garden_shoot_operations_total | Count of ongoing operations | Shoot | Gauge |
| garden_shoot_operation_states | Operation State of a Shoot | Shoot | Gauge |
| garden_shoot_operation_progress_percent | Operation Percentage of a Shoot | Shoot | Gauge |
| garden_seed_info | Information to a Seed | Seed | Gauge |
| garden_seed_capacity | Information regarding a seed's capacity with respect to certain resources | Seed | Gauge |
| garden_seed_condition | Condition State of a Seed | Seed | Gauge |
| garden_seed_usage | Actual usage of seed by resources | Seed | Gauge |
| garden_projects_status | Status of Garden Projects | Projects | Gauge |
| garden_users_total | Count of users | Users | Gauge |
| garden_scrape_failure_total | Total count of scraping failures, grouped by kind/group of metric(s) | App | Counter |
Grafana Dashboards
Some Grafana dashboards are included in the dashboards folder. Simply
import them and make sure you have your Prometheus data source named to
cluster-prometheus.
Usage
First, clone the repo into your $GOPATH.
mkdir -p "$GOPATH/src/github.com/gardener"
git clone https://github.com/gardener/gardener-metrics-exporter.git \
"$GOPATH/src/github.com/gardener/gardener-metrics-exporter"
cd "$GOPATH/src/github.com/gardener/gardener-metrics-exporter"
Local
The metrics exporter needs to run against a Gardener environment (Kubernetes
cluster extendend with core.gardener.cloud/v1alpha1 api group). Such an
environment can be created by following the instructions the gardener local
setup.
If the current-context of your $HOME/.kube/config point to a Gardener
environment then you can simply run:
make start
If you plan to pass a specific kubeconfig then you need to build the app locally
and pass a kubeconfig to the binary. Let's build the app for your environment
locally and run it. The binary will be located in the ./bin directory of the
repository.
# Build
make build-local
# Run
./bin/gardener-metrics-exporter --kubeconfig=<path-to-kubeconfig-file>
Be aware: The user in the kubeconfig needs permissions to GET, LIST, *WATCH the resources Shoot, Seed, Project *(core.gardener.cloud/v1alpha1) in all namespaces of the cluster.
Verify that everything works by calling the /metrics endpoint of the app.
curl http://localhost:2718/metrics
Run a local Prometheus instance and add the following scrape config snippet to your config.
scrape_configs:
- job_name: 'gardener-metrics-exporter'
static_configs:
- targets:
- localhost:2718
metric_relabel_configs:
- source_labels: [ __name__ ]
regex: '^garden_.*$'
action: keep
Now the metrics should be collected by Prometheus. Open the Prometheus console
and query for garden_* metrics.
In Cluster
Deploy the metrics-exporter to a kubernetes cluster via helm.
helm upgrade gardener-metrics-exporter charts/gardener-metrics-exporter \
--install --namespace=<your-namespace> --values=<path-to-your-values.yaml>
For example, the scrape config for your Prometheus could look like this:
scrape_configs:
- job_name: 'gardener-metrics-exporter'
kubernetes_sd_configs:
- role: endpoints
namespaces:
names:
- <helm-deployment-namespace>
relabel_configs:
- source_labels: [__meta_kubernetes_service_name]
regex: gardener-metrics-exporter
action: keep
metric_relabel_configs:
- source_labels: [ __name__ ]
regex: '^garden_.*$'
action: keep
Directories