Configure Prometheus metrics for the Global Profiling Engine

The Global Profiling Engine supports Prometheus metrics that reveal characteristics of your stick table data and the health of the GPE service. You could import this data into dashboarding software, such as Grafana, to see trends over time.

Enable metrics Jump to heading #

To enable Prometheus metrics:

1. On the Global Profiling Engine server, edit the file /etc/hapee-extras/hapee-gpe.json.

2. Set the prometheus_exporter field to one of the following values:

   Value	Description
   0	Disable metrics. (default)
   1	Enable only general metrics.
   2	Enable only health metrics.
   3	Enable both general and health metrics.

   In this example, we enable both general and health metrics:

   hapee-gpe.json
   json
   {
       "worker_thread_count": 4,
       "inter_worker_queue_size": 1024,
       "collector_queue_size": 64,
       "httpd_port": 9888,
       "datadir": "/var/cache/hapee-extras/hct_datadir",
       "default_stick_table_handling": 1,
       "prometheus_exporter": 3,
       ...

   hapee-gpe.json
   json
   {
       "worker_thread_count": 4,
       "inter_worker_queue_size": 1024,
       "collector_queue_size": 64,
       "httpd_port": 9888,
       "datadir": "/var/cache/hapee-extras/hct_datadir",
       "default_stick_table_handling": 1,
       "prometheus_exporter": 3,
       ...

   The metrics are available at the port set by httpd_port at /metrics for general metrics and /health for health metrics.

Metrics reference Jump to heading #

This section describes the available metrics.

General metrics Jump to heading #

General metrics record the count, sum, average, minimum, maximum, and percentiles of your stick table data.

Health metrics Jump to heading #

Health metrics reveal the health of your Global Profiling Engine service.