Accessing VGS Metrics via Prometheus API

To set up and configure the Observability Metrics service, please reach out to our support team at [email protected]. Provide the following details in your request:

• Your organization name.

• The list of vaults you want to receive metrics for.

Our support team will provide the Prometheus endpoints and credentials needed to access your metrics.

Sample Connection Details

If you want to receive metrics for the vault tntasd123 in the organization my-test-organization, the endpoint and credentials might look like this:

Prometheus API URL: https://metrics.apps.verygood.systems/vaults/tntasd123/api/metrics
Username: prometheus
Password: hunter2

Scraping Data

The Observability Metrics Prometheus endpoint exposes a /metrics endpoint that can be scraped from any Prometheus-compatible service.

Prometheus Scrape Compatible APMs

Many APMs will support entering the /metrics endpoint directly. If you use an APM like Grafana Cloud, you can pass the credentials in as basic auth credentials when configuring the endpoint.

APMs without Prometheus Scrape

If you have a Prometheus-compatible system that does not support scrape (e.g., you may need to leverage remote_write or remote_read you can still make this work by hosting your own Prometheus instance, which will scrape and then push or expose the metrics.

Dashboard Templates

VGS supplies a set of pre-built dashboards to get you up and running quickly.