rsionThis 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/.
...
The Prometheus forwarding agent stores metrics in a cache. The cached metrics are published in an endpoint which that is scraped by Prometheus.
...
<ec_host>:<ec_webport>/metrics/It is possible to configure how many metrics to store and for how long a cache can hold. This is configured via Execution Context Properties:
...
The cache is shared by all workflows running in the Execution Context so its size has to be set accordingly, that is, to the expected metric flow throughput. Each Prometheus scrape empties the cache so the cache size should be set to minimum
<number_of_metrics_expected_per_second> * <prometheus_scrape_interval>.
| 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.
A few restrictions apply:
...
The CATEGORY field is not used. If it is still needed it has to be assigned to NAME fields of the Prometheus UDR. See Prometheus UDR Type for more information.
...
| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
The section contains the following subsections: |
...