Skip to content

Commit 33f7b9b

Browse files
PMP Grafana endpoints
1 parent f9cd3c2 commit 33f7b9b

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

content/en/docs/private-platform/pmp-prerequisites.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,18 @@ For performance reasons, Mendix recommends at least the following minimum hardwa
4040
| Grafana | 12.2.1 |
4141
| Prometheus | 2.41.0 |
4242

43+
#### Grafana Endpoints
44+
45+
Private Mendix Platform uses the following Grafana endpoints:
46+
47+
* [GET /api/health](https://grafana.com/docs/grafana/latest/developers/http_api/other/#returns-health-information-about-grafana) - This endpoint is used to check the health and status of the Grafana instance itself. It allows Private Mendix Platform to get the Grafana version and verify that Grafana is running before saving the logging and monitoring configuration.
48+
* [GET /api/datasourcesData](https://grafana.com/docs/grafana/latest/developers/http_api/data_source/) - This endpoint is used to fetch the unique identifiers (IDs) of datasources, like Loki (logs) and Prometheus (metrics). These IDs are required for subsequent queries.
49+
* `GET /api/datasources/proxy/uid/:uid/*` - This endpoint acts as a proxy for calls to the data source identified by the specified UID. Private Mendix Platform uses this to call Loki and Prometheus APIs to query logs and labels.
50+
* [GET /loki/api/v1/query_range](https://grafana.com/docs/enterprise-logs/latest/reference/loki-http-api/#query-logs-within-a-range-of-time) - This is the primary endpoint for fetching log data. Private Mendix Platform uses this Loki API to query application logs over a specific time range. The results of this query are used for real-time monitoring, and displayed within the Private Mendix Platform interface.
51+
* [GET /api/v1/labels](https://prometheus.io/docs/prometheus/latest/querying/api/#getting-label-names) (Prometheus API via Grafana) - This endpoint queries the available labels from Prometheus. Private Mendix Platform uses this to check if a specific label (for ezample, a namespace) exists in Prometheus.
52+
* [GET /api/v1/label/pod/values](https://prometheus.io/docs/prometheus/latest/querying/api/#querying-label-values) (Prometheus API via Grafana) - This endpoint retrieves the list of all unique pod names for a target environment. This is used to populate the filter dropdown in the Private Mendix Platform interface.
53+
* [POST /api/ds/query?ds_type=prometheus](https://grafana.com/docs/grafana/latest/developers/http_api/data_source/#query-a-data-source) - This is a universal Grafana API endpoint for executing queries on a specific data source. Private Mendix Platform uses it to send PromQL queries to the Prometheus data source to fetch metric data for the Metrics dashboard.
54+
4355
## General Requirements
4456

4557
* The machine where Private Mendix Platform is installed must have connectivity to the Container Registry and the Kubernetes cluster

0 commit comments

Comments
 (0)