Prometheus
- By Canonical Observability
Channel | Revision | Published | Runs on |
---|---|---|---|
latest/stable | 189 | 01 Aug 2024 | |
latest/candidate | 209 | 28 Jun 2024 | |
latest/beta | 210 | 01 Aug 2024 | |
latest/edge | 212 | 28 Aug 2024 | |
1.0/stable | 159 | 16 Feb 2024 | |
1.0/candidate | 159 | 12 Dec 2023 | |
1.0/beta | 159 | 12 Dec 2023 | |
1.0/edge | 159 | 12 Dec 2023 |
juju deploy prometheus-k8s --channel candidate
Deploy Kubernetes operators easily with Juju, the Universal Operator Lifecycle Manager. Need a Kubernetes cluster? Install MicroK8s to create a full CNCF-certified Kubernetes system in under 60 seconds.
Platform:
After adding scrape or remote write relations to prometheus, it may take juju some time to settle the model. After the model is settled, some data you expect to have may be missing (scrape jobs / alert rules).
Checklist
juju status --relations
includes all the relations you expect to have, and if you have cross-model relations, then the SAAS section has a non-zero count for prometheus relations.
Rules and scrape targets are listed in prometheus
Query a prometheus unit ip to confirm all the rules are configured:
curl 10.1.207.168:9090/api/v1/rules | jq
and scrape jobs are healthy:
curl 10.1.207.168:9090/api/v1/targets \
| jq '.data.activeTargets | .[] | {scrapeUrl, health}'
If something is missing, proceed to the next section.
Rules are present on prometheus filesystem
Rule files have topology information in their filename. Confirm you have everything you expect to find:
juju ssh --container prometheus prom/0 ls /etc/prometheus/rules
If something is missing, proceed to the next section.
Rules and scrape jobs are listed in relation data
To the relation data that is incoming into prometheus, you can use show-unit
:
juju show-unit --format json prom/0 \
| jq '."prom/0"."relation-info"'
To filter out all relations except the cross model relations,
juju show-unit --format json prom/0 \
| jq '."prom/0"."relation-info" | .[] | select(."cross-model" == true)'
To further filter out all relations except the ones related to the “receive-remote-write” relation,
juju show-unit --format json prom/0 \
| jq '."prom/0"."relation-info" | .[] | select(."cross-model" == true) | select(.endpoint == "receive-remote-write")'
To inspect all the scrape jobs coming in via the metrics-endpoint relation,
juju show-unit --format json prom/0 \
| jq -r '."prom/0"."relation-info" | .[] | select(.endpoint == "metrics-endpoint")."application-data"."scrape_jobs"'
Similarly for alert rules:
juju show-unit --format json prom/0 \
| jq -r '."prom/0"."relation-info" | .[] | select(.endpoint == "metrics-endpoint")."application-data"."alert_rules"'
For convenience you could use a function:
app_data () {
# Usage examples:
# app_data prom/0 receive-remote-write alert_rules
# app_data prom/0 metrics-endpoint scrape_jobs
# $1 = unit, e.g. prom/0
local UNIT="$1"
# $2 = endpoint, e.g. receive-remote-write
local ENDPOINT="$2"
# $3 = app relation data key, e.g. scrape_jobs (optional)
local KEY="$3"
if [[ $# -eq 3 ]]; then
juju show-unit --format json $UNIT \
| jq -r ".\"$UNIT\".\"relation-info\" | .[] | select(.endpoint == \"$ENDPOINT\").\"application-data\".\"$KEY\""
elif [[ $# -eq 2 ]]; then
juju show-unit --format json $UNIT \
| jq -r ".\"$UNIT\".\"relation-info\" | .[] | select(.endpoint == \"$ENDPOINT\").\"application-data\""
else
echo "Illegal number of parameters" >&2
fi
}