# Accessing VGS Metrics via Prometheus API

To set up and configure the Observability Metrics service, please reach out to our support team at <support@vgs.io>. 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:

```plaintext
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](/enterprise-platform/core-platform-services/observability/metrics-templates.md) dashboards to get you up and running quickly.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.verygoodsecurity.com/enterprise-platform/core-platform-services/observability/accessing-vgs-metrics-via-prometheus-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
