gcp-gce-exporter

README

GCP GCE ☁ Exporter

A prometheus exporter providing metrics for GCP GCE compute resource specifications and capacity profiling.

Exposes compute resource statistics of GCP GCE machine-types, images and regions from the GCP Compute Engine API to a Prometheus compatible endpoint.

Description

The application can be run in a number of ways though its main consumption is via the Docker hub image 0x0I.gcp-gce-exporter.

Required

• PROJECT - Google Cloud Platform API authorized and capable Google Cloud project
• GOOGLE_APPLICATION_CREDENTIALS - path to file containing service account key and authentication credentials (requires file mount into container) or GOOGLE_APPLICATION_CREDENTIALS_JSON - json blob containing service account key and authentication credentials

Optional

• METRICS_PATH - Path under which to expose metrics. Defaults to /metrics
• LISTEN_PORT - Port on which to expose metrics. Defaults to 9692
• REGION - GCP region to scrape. Defaults to us-east1
• LOG_LEVEL - Set the logging level. Defaults to info

Install and deploy

Run manually from Docker Hub (Note: credentials file must exist within Container):

podman run --detach --env GOOGLE_APPLICATION_CREDENTIALS="/path/to/creds.json" \
           --env PROJECT="XXXXXXX" --publish 9692:9692 \
           --volume /home/user/gcp.creds.json:/path/to/creds.json \
           0Iabs/0x01.gcp-gce-exporter

Scrape non-default GCP GCE region and increase logging level:

podman run --detach --env GOOGLE_APPLICATION_CREDENTIALS="/path/to/creds.json" \
           --env PROJECT="XXXXXXX" \
           --env REGION=asia-southeast1 \
           --env LOG_LEVEL=debug \
           --publish 9692:9692 \
           0Iabs/0x01.gcp-gce-exporter

Build a container image:

podman build --file build/Containerfile --tag <image-name> .
podman run -d -e GOOGLE_APPLICATION_CREDENTIALS="/path/to/creds.json" -e PROJECT="XXXXXXX" -p 9692:9692 <image-name>

Docker compose

gcp-gce-exporter:
  tty: true
  stdin_open: true
  environment:
    - GOOGLE_APPLICATION_CREDENTIALS="/path/to/creds.json"
    - PROJECT="XXXXXXX"
  expose:
    - 9692:9692
  image: 0Iabs/gcp-gce-exporter:latest

Metrics

Metrics will be made available on port 9692 by default, or you can pass environment variable LISTEN_ADDRESS to override this. An example printout of the metrics you should expect to see can be found in METRICS.md.