This section describes the Prometheus forwarding agent. The Prometheus agent is available for both real-time and batch workflow configurations. This agent lets you publish metrics in a format that can be scraped by a Prometheus instance. The metrics can then be visualized using Grafana. Follow the official Grafana documentation here: https://grafana.com/docs/grafana/latest/. To configure Prometheus, see https://prometheus.io/docs/introduction/overview/.
Use the Prometheus filter to configure the metrics that are going to be exposed for scraping, see 9.5657.3 The Prometheus Filter.
The Prometheus forwarding agent stores metrics in a cache. The cached metrics are published in an endpoint which is scraped by Prometheus.
...
| Note | ||
|---|---|---|
| ||
| Currently, the cache is under development. There is a known issue about dropping metrics even when the cache is not full. See more in the Endpoint section. |
Endpoint
Each Execution Context exposes an endpoint that can be scraped by a Prometheus instance at:
...
| Note | ||
|---|---|---|
| ||
| Metrics stored in the cache are read-only-once. Manual querying of the endpoint will result in data missing in Prometheus. |
Compatibility with System Insight
It is possible to replace the System Insight agent with the Prometheus agent without making any changes to the existing workflows. This is done by simply replacing the System Insight Forwarding agent with the Prometheus Forwarding Agent.
...
All metrics created with the use of a
MeasurementUDR are exposed as aGAUGEtype.Each value stored inside the
fieldsfield of theMeasurementUDR are reported as a separate metric.The
CATEGORYfield is not used. If it is still needed it has to be assigned toNAMEfields of thePrometheusUDR.If the
System InsightUDR fieldfieldscontains many measurements, each is reported as a separate metric.
This section includes the following subsections:
| Child pages (Children Display) |
|---|