Performance Metrics
Performance metrics allow DPG administrators to monitor performance of ongoing operations at various levels and notify them in case of failures. These metrics are consumed by various Security Information and Event Management (SIEM) tools such as Prometheus. DPG provides an API, /metrics, which enables generation of performance metrics. This API uses the GET method. The metrics are retrieved at specific time intervals. The configuration of the time interval varies according to the SIEM tool (like Prometheus) integrated in the user's environment.
Note
To generate metrics logs, the Enable Performance Metrics toggle on the Application Data Protection UI must be turned on.
The metrics for DPG displays the following counters:
| Counter Name | Description | Label Filters | MetricType |
|---|---|---|---|
total_request_count | Total number of requests received by DPG. | — client_id — app_name | Counter |
request_success_count | Total number of requests successfully served by DPG. | — client_id — app_name | Counter |
request_failed_count | Total number of requests failed. | — client_id — app_name | Counter |
total_response_count | Total number of responses returned by DPG. | — client_id — app_name | Counter |
response_success_count | Total number of responses with status code success. | — client_id — app_name | Counter |
response_failed_count | Total number of responses with status code error. | — client_id — app_name | Counter |
protected_tokens_count | Total number of tokens successfully protected. | — client_id — app_name — location (json/url) | Counter |
revealed_tokens_count | Total number of tokens successfully revealed. | — client_id — app_name — location (json/url) | Counter |
protect_token_size | Length of tokens protected by DPG. | — client_id — app_name — location (json/url) | Counter |
reveal_token_size | Length of tokens revealed by DPG. | — client_id — app_name — location (json/url) | Counter |
gateway_response_time | Measures the overall API latency from request initiation to response completion. | — client_id — app_name — route — method | Histogram |
Note
DPG acts as a reverse proxy, so, if there is an error in the request, the response counts such as response_success_count, response_failed_count, and total_response_count are not incremented.
Based on these metrics counters, the SIEM tool generates performance report that includes details such as number of transactions per second, average token size, and gateway latency.
Request URL
curl -X GET <DPG host IP>:<probes port>/metrics
In the above API call, replace <DPG host IP> and <probes port> with the valid values from the DPG deployment. The metrics endpoint is served on non-TLS port 8080.
