Metrics Logs
Metrics logs allow CRDP administrators to monitor performance of ongoing operations at various levels and notify them in case of failures. These logs are consumed by various Security Information and Event Management (SIEM) tools such as Prometheus. CRDP provides an API, /metrics, which enables administrators to generate metrics logs. This API uses GET method. The metrics are generated at a fixed time interval. 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 CRDP displays the following counters:
Counter Name | Description |
---|---|
protect_bulk_failure_count | The total count of failed protect bulk APIs. |
protect_bulk_failure_transaction_count | The total count of failed protect calls in the protect bulk API. |
protect_bulk_success_count | The total count of successful protect bulk API. |
protect_bulk_success_transaction_count | The total count of successful protect calls in the protect bulk API. |
protect_failure_count | The total count of failed protect APIs. |
protect_success_count | The total count of successful protect APIs. |
reveal_bulk_failure_count | The total count of failed reveal bulk APIs |
reveal_bulk_failure_transaction_count | The total count of failed reveal calls in the reveal bulk API. |
reveal_bulk_success_count | The total count of successful reveal bulk API. |
reveal_bulk_success_transaction_count | The total count of successful reveal calls in the reveal bulk API. |
reveal_failure_count | The total count of failed reveal APIs. |
unique_ip_address_count | The total count of unique IP addresses sending request to CRDP. |
Client{ID, app_name} | — ID: Unique identifier for the client. — app_name: The name of the application under which the client is registered. |
Based on these metrics counters, the SIEM tool generates performance report that includes details such as number of requests per second and status of the operations.
Request URL
curl -X GET -H "Content-Type: application/json" \<ip>:<port>/metrics
Here, ip
is the IP of the host machine where CRDP container is deployed and <port>
is the port of CRDP container.
Sample Response
Following is the sample of CRDP metrics logs which is generated using the Prometheus tool.
# HELP Client Information about client and application
# TYPE Client counter
Client{ID="b563e708-e031-4435-97b4-d0926ca10f30",app_name="test"} 0
# HELP promhttp_metric_handler_requests_in_flight Current number of scrapes being served.
# TYPE promhttp_metric_handler_requests_in_flight gauge
promhttp_metric_handler_requests_in_flight 1
# HELP promhttp_metric_handler_requests_total Total number of scrapes by HTTP status code.
# TYPE promhttp_metric_handler_requests_total counter
promhttp_metric_handler_requests_total{code="200"} 2
promhttp_metric_handler_requests_total{code="500"} 0
promhttp_metric_handler_requests_total{code="503"} 0
# HELP protect_bulk_failure_count The total count of failed protect bulk APIs.
# TYPE protect_bulk_failure_count counter
protect_bulk_failure_count 0
# HELP protect_bulk_failure_transaction_count The total count of failed protect calls in the protect bulk API.
# TYPE protect_bulk_failure_transaction_count counter
protect_bulk_failure_transaction_count 0
# HELP protect_bulk_success_count The total count of successful protect bulk API.
# TYPE protect_bulk_success_count counter
protect_bulk_success_count 0
# HELP protect_bulk_success_transaction_count The total count of successful protect calls in the protect bulk API.
# TYPE protect_bulk_success_transaction_count counter
protect_bulk_success_transaction_count 0
# HELP protect_failure_count The total count of failed protect APIs.
# TYPE protect_failure_count counter
protect_failure_count 0
# HELP protect_success_count The total count of successful protect APIs.
# TYPE protect_success_count counter
protect_success_count 0
# HELP reveal_bulk_failure_count The total count of failed reveal bulk APIs.
# TYPE reveal_bulk_failure_count counter
reveal_bulk_failure_count 0
# HELP reveal_bulk_failure_transaction_count The total count of failed reveal calls in the reveal bulk API.
# TYPE reveal_bulk_failure_transaction_count counter
reveal_bulk_failure_transaction_count 0
# HELP reveal_bulk_success_count The total count of successful reveal bulk API.
# TYPE reveal_bulk_success_count counter
reveal_bulk_success_count 0
# HELP reveal_bulk_success_transaction_count The total count of successful reveal calls in the reveal bulk API.
# TYPE reveal_bulk_success_transaction_count counter
reveal_bulk_success_transaction_count 0
# HELP reveal_failure_count The total count of failed reveal APIs.
# TYPE reveal_failure_count counter
reveal_failure_count 0
# HELP unique_ip_address_count The number of unique ip count
# TYPE unique_ip_address_count counter
unique_ip_address_count 1