prometheus-engine

README

Prometheus Engine

This repository contains various binaries and packages for client-side usage of Google Cloud Managed Service for Prometheus (GMP), a managed Prometheus offering on top of Google Cloud Monitoring (GCM).

For more documentation and to get started, go to g.co/cloud/managedprometheus.

Binaries

• config-reloader: An auxiliary binary to initiate reload on configuration file changes.
• frontend: An authorizing proxy for the Prometheus-compatible query API of GMP. It additionally hosts a query UI.
• operator: A Kubernetes operator for managed metric collection for GMP.
• rule-evaluator: A Prometheus rule evaluation engine that evaluates against GMP.
• datasource-syncer: A cron job for periodic Oauth2 token injection to Grafana Prometheus datasource.

For the fully Prometheus-compatible binary that writes ingested data into GMP/GCM, see GoogleCloudPlatform/prometheus.

Docker Images

Images for this repo are regularly released in the GKE release GCR.

Development

Dependencies

In order to best develop and contribute to this repository, the following dependencies are recommended:

1. go
2. gcloud
3. kubectl

Can be also installed via:

gcloud components install kubectl

1. Docker with buildx plugin.

If you want to execute docker containers on remote machine you can run:

gcloud alpha cloud-shell ssh --authorize-session -- -nNT -L `pwd`/docker.sock:/var/run/docker.sock

# Then in separate terminal.
export DOCKER_HOST=unix://docker.sock

1. For UI development or update (e.g. to resolve UI security issue), npm is required. See pkg/ui documentation for details.

Presubmit

make presubmit regenerates all resources, builds all images and runs all tests.

Steps from presubmit are validated on the CI, but feel free to run it if you see CI failures related to regenerating resources or when you want to do local check before submitting.

Run CHECK=1 make presubmit to fail the command if repo state is not clean after presubmit (might require committing the changes).

Building

Run make help shows a list of candidate targets with documentation.

Any go application in ./cmd/ with an associated main.go, e.g. ./cmd/operator/main.go is a candidate for build by running, for example:

make operator
make frontend
make rule-evaluator
make config-reloader

This also includes example Go apps from /examples/instrumentation/:

make go-synthetic

Running make bin will build all of the above go binaries.

• Setting NO_DOCKER=1 here will build all the binaries natively on the host machine.

Testing

Unit

To run unit tests locally, use go test, your IDE or NO_DOCKER=1 make test.

To run unit tests from docker container run make test

Kubernetes End-to-end tests

Running make e2e will run e2e tests against Kubernetes cluster:

• By default, it run in hermetic docker container, downloads kind, recreates a single node kind cluster and runs e2e tests against it.
• To run a single test, use the TEST_RUN environment variable. For example, to run all collector tests, pass TEST_RUN=TestCollector:

TEST_RUN=TestCollector make e2e

Debugging

In docker mode, to run a single test or debug a cluster during or after failed test, you can try entering shell of the kindtest container. Before doing so, run make e2e to setup kind and start a cluster.

To enter shell with kind Kubernetes context, (ensure your docker socket is on /var/run/docker.sock):

docker run --network host --rm -it \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v `pwd`/e2e:/build/e2e gmp/kindtest bash

To access kind Kubernetes (e.g. to list pods) run:

kind export kubeconfig
kubectl get po

To execute a single test e.g. TestAlertmanagerDefault you can do (in kindtest shell):

kind export kubeconfig
go test -v ./e2e -run "TestAlertmanagerDefault" -args -project-id=test-proj -cluster=test-cluster -location=test-loc -skip-gcm

Each test case is creating a separate set of namespaces e.g. gmp-test-testalertmanagerdefault-20230714-120756 and gmp-test-testalertmanagerdefault-20230714-120756-pub, so to debug tests you have to ensure those namespaces are not cleaned. You can also provide time.Sleep in the place you want debug in.

Benchmarking

See BENCHMARK.md.