Prometheus Exporter for Google Cloud Platform (GCP)

I want to be able to monitor my resource consumption across multiple cloud platforms (GCP, Digital Ocean and Linode). I was inspired by @metalmatze's DigitalOcean Exporter and, with this exporter, have the three that I need:

Result:

And:

Installation

The application uses Google's Application Default Credentials (ADCs) to simplify authentication by finding credentials automatically.

On a machine running gcloud that's authenticated with your user (e.g. Gmail) account, you can run gcloud auth application-default login to establish your user account as ADCs. This ensures that the Exporter is able to operate as if it were you(r user account), enumerate GCP projects that you(r user account) has access to and resources within those projects.

If you run the Exporter remotely, you will need to create a service account for it to use. The Exporter will only be able to enumerate projects and project resources that this service account is able to access.

In the following examples, the Exporter's container is configured to use the ADCS stored in ${HOME}/.config/gcloud/appl...

Go

In this example, ADCs will be automatically detected without further configuration.

go get github.com/DazWilkin/gcp-exporter
go run github.com/DazWilkin/gcp-exporter

Standalone

PORT=9402
CREDENTIALS="${HOME}/.config/gcloud/application_default_credentials.json"
REPO="ghcr.io/dazwilkin/gcp-exporter"
docker run \
--interactive --tty \
--publish=${PORT}:${PORT} \
--volume=${CREDENTIALS}:/secrets/client_secrets.json \
--env=GOOGLE_APPLICATION_CREDENTIALS=/secrets/client_secrets.json \
ghcr.io/dazwilkin/gcp-exporter:365090e4dbd6df2da1ed9f19e5e48d1cbfc36618

Sigstore

gcp-exporter container images are being signed by Sigstore and may be verified:

cosign verify \
--key=./cosign.pub \
ghcr.io/dazwilkin/gcp-exporter:365090e4dbd6df2da1ed9f19e5e48d1cbfc36618

NOTE cosign.pub may be downloaded here

To install cosign, e.g.:

go install github.com/sigstore/cosign/cmd/cosign@latest

Docker Compose

docker-compose up

NB docker-compose.yml configuration for gcp-exporter services is:

gcp-exporter:
  image: ghcr.io/dazwilkin/gcp-exporter:365090e4dbd6df2da1ed9f19e5e48d1cbfc36618
  container_name: gcp-exporter
  environment:
  - GOOGLE_APPLICATION_CREDENTIALS=/secrets/client_secrets.json
  volumes:
  - /home/dazwilkin/.config/gcloud/application_default_credentials.json:/secrets/client_secrets.json
  expose:
  - "9402" # GCP Exporter port registered on Prometheus Wiki
  ports:
  - 9402:9402

The Docker Compose configuration includes:

NB You will need to create an alertmanager.yml configuration file. This example shows you how to configure AlertManager to send alerts to Gmail

Kubernetes

Assuming MicroK8s and Prometheus Operator

NAMESPACE="gcp-exporter"

kubectl create namespace ${NAMESPACE}

kubectl create secret generic gcp-exporter \
--from-file=client_secrets.json=/home/dazwilkin/.config/gcloud/application_default_credentials.json \
--namespace=${NAMESPACE}

kubectl apply \
--filename=./kubernetes.yaml \
--namespace=${NAMESPACE}

# NB This must be installed to 'monitoring' namespace
kubectl apply --filename=./kubernetes.rule.yaml  --namespace=monitoring

Raspberry Pi

Learning about multi-arch builds to run on Raspberry Pi 4.

Unsure how to use docker manifest with GitHub Actions as this model has been suplanted by docker buildx (that I don't want to use).

Refactored Dockerfile to take a build argument GOLANG_OPTIONS (default=CGO_ENABLED=0 GOOS=linux GOARCH=amd64)

if [ "$(getconf LONG_BIT)" -eq 64 ]
then
  # 64-bit Raspian
  ARCH="GOARCH=arm64"
  TAG="arm64"
else
  # 32-bit Raspian
  ARCH="GOARCH=arm GOARM=7"
  TAG="arm32v7"
fi

docker build \
--build-arg=GOLANG_OPTIONS="CGO_ENABLED=0 GOOS=linux ${ARCH}" \
--build-arg=COMMIT=$(git rev-parse HEAD) \
--build-arg=VERSION=$(uname --kernel-release) \
--tag=ghcr.io/dazwilkin/gcp-exporter:${TAG} \
--file=./Dockerfile \
.

NOTE See environment variables

Podman

NOTE You will need to replace the service names (alertmanager, gcp-exporter, gcp-status, cadvisor and node-exporter) in prometheus.yml with localhost

NOTE minimal set of containers pending cAdvisor support for Podman. See cAdvisor Issue #2424 and Pull #3021
sed \
--in-place \
--expression="s/$alertmanager\|gcp-exporter\|gcp-status\|cadvisor\|node-exporter$:/localhost:/g" \
prometheus.yml

POD="exporter"

# 8080: cAdvisor (Unavailabe)
# 9090: Prometheus
# 9093: AlertManager
# 9402: GCP Exporter
# 9100: Node Exporter
podman pod create \
--name=${POD} \
--publish=9090:9090 \
--publish=9093:9093 \
--publish=9402:9402 \
--publish=9100:9100

podman run \
--detach --tty --rm \
--pod=${POD} \
--name=prometheus \
--volume=${PWD}/prometheus.yml:/etc/prometheus/prometheus.yml \
--volume=${PWD}/rules.yml:/etc/alertmanager/rules.yml \
docker.io/prom/prometheus:v2.37.0 \
  --config.file=/etc/prometheus/prometheus.yml \
  --web.enable-lifecycle

podman run \
--detach --tty --rm \
--pod=${POD} \
--name=alertmanager \
--volume=${PWD}/alertmanager.yml:/etc/alertmanager/alertmanager/rules.yml \
docker.io/prom/alertmanager:v0.24.0

podman run \
--detach --tty --rm \
--pod=${POD} \
--name=gcp-exporter \
--env=GOOGLE_APPLICATION_CREDENTIALS=/secrets/key.json \
--volume=/home/userid/.config/gcloud/application_default_credentials.json:/secrets/key.json \
ghcr.io/dazwilkin/gcp-exporter:365090e4dbd6df2da1ed9f19e5e48d1cbfc36618

podman run \
--detach --tty --rm \
--name=node-exporter \
--pod=${POD} \
--volume=/:/host:ro,rslave \
docker.io/prom/node-exporter:v1.1.2 \
  --path.rootfs=/host

Develop

git clone [email protected]:DazWilkin/gcp-exporter.git && cd gcp-exporter

Please file issues

Metrics

Name	Type	Description
`gcp_exporter_buildinfo`	Counter	A metric with a constant '1' value labeled by OS version, Go version, and the Git commit of the exporter
`gcp_exporter_startime`	Gauge	Exporter start time in Unix epoch seconds
`gcp_artifact_registry_registries`	Gauge	Number of Artifact Registry registries
`gcp_artifact_registry_locations`	Gauge	Number of Artifact Registry locations
`gcp_artifact_registry_formats`	Gauge	Number of Artifact Registry formats
`gcp_cloud_endpoints_services`	Gauge	Number of Cloud Endpoints services
`gcp_cloud_functions_functions`	Gauge	Number of Cloud Functions functions
`gcp_cloud_functions_locations`	Gauge	Number of Cloud Functions locations
`gcp_cloud_functions_runtimes`	Gauge	Number of Cloud Functions runtimes
`gcp_cloud_logging_logs`	Gauge	Number of Cloud Logging Logs
`gcp_cloud_monitoring_alert_policies`	Gauge	Number of Cloud Monitoring Alert Policies
`gcp_cloud_monitoring_uptime_checks`	Gauge	Number of Cloud Monitoring Uptime Checks
`gcp_cloud_run_jobs`	Gauge	Number of Cloud Run jobs
`gcp_cloud_run_services`	Gauge	Number of Cloud Run services
`gcp_cloud_scheduler_jobs`	Gauge	Number of Cloud Scheduler jobs
`gcp_compute_engine_instances`	Gauge	Number of instances
`gcp_compute_engine_forwardingrules`	Gauge	Number of forwardingrules
`gcp_kubernetes_engine_cluster_up`	Gauge	1 if the cluster is running, 0 otherwise
`gcp_kubernetes_engine_cluster_nodes`	Gauge	Number of nodes currently in the cluster
`gcp_storage_buckets`	Gauge	Number of buckets

Prometheus API

curl \
--silent \
http://localhost:9090/api/v1/label/__name__/values \
| jq -r .data[] | awk '/^gcp/ {print}'

Yields:

gcp_artifact_registry_formats
gcp_artifact_registry_locations
gcp_artifact_registry_registries
gcp_cloud_endpoints_services
gcp_cloud_functions_functions
gcp_cloud_functions_locations
gcp_cloud_functions_runtimes
gcp_cloud_logging_logs
gcp_cloud_run_services
gcp_compute_engine_forwardingrules
gcp_compute_engine_instances
gcp_exporter_build_info
gcp_exporter_start_time
gcp_kubernetes_engine_cluster_nodes
gcp_kubernetes_engine_cluster_up
gcp_projects_count
gcp_storage_buckets

Port

Registered 9402 with Prometheus Exporters' default port allocations

References

Using Google's (now legacy) API Client Libraries. The current Cloud Client Libraries do not provide coverage for all the relevant resources.

Google Compute Engine API
Google Resource Manager API && GoDoc
Google Kubernetes Engine (Container) API && GoDoc

Name		Name	Last commit message	Last commit date
Latest commit History 459 Commits
.github		.github
collector		collector
gcp		gcp
images		images
.dockerignore		.dockerignore
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
build.sh		build.sh
cosign.pub		cosign.pub
docker-compose.yml		docker-compose.yml
go.mod		go.mod
go.sum		go.sum
kubernetes.rule.yaml		kubernetes.rule.yaml
kubernetes.yaml		kubernetes.yaml
main.go		main.go
prometheus.yml		prometheus.yml
rules.yml		rules.yml
update_images.sh		update_images.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Prometheus Exporter for Google Cloud Platform (GCP)

Installation

Go

Standalone

Sigstore

Docker Compose

Kubernetes

Raspberry Pi

Podman

Develop

Metrics

Prometheus API

Port

References

Similar Exporters

About

Releases

Packages

Contributors 3

Languages

License

DazWilkin/gcp-exporter

Folders and files

Latest commit

History

Repository files navigation

Prometheus Exporter for Google Cloud Platform (GCP)

Installation

Go

Standalone

Sigstore

Docker Compose

Kubernetes

Raspberry Pi

Podman

Develop

Metrics

Prometheus API

Port

References

Similar Exporters

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 3

Languages

Packages