summaryrefslogtreecommitdiffstats
path: root/docs/development/prometheus-metrics.rst
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2022-04-22 10:28:57 -0400
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2022-04-22 10:29:06 -0400
commit497107302c4295e30cdea18ec70bc90b606844ee (patch)
tree7132789334077cc721d1ddcd55f4e5a85301cd35 /docs/development/prometheus-metrics.rst
parent7cceef2d644dabd297451ed8dfe85206d22c51fb (diff)
Add document for distribution metrics
Adding document for policy-distribution metrics Issue-ID: POLICY-3964 Change-Id: I3cd039678d33ba0dc472d21b3c496feb8fc70625 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Diffstat (limited to 'docs/development/prometheus-metrics.rst')
-rw-r--r--docs/development/prometheus-metrics.rst21
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/development/prometheus-metrics.rst b/docs/development/prometheus-metrics.rst
index 341d6d5a..84699853 100644
--- a/docs/development/prometheus-metrics.rst
+++ b/docs/development/prometheus-metrics.rst
@@ -118,9 +118,9 @@ Key metrics for APEX-PDP
+=============================================+=====================================================================================+======================================================================================================================+
| process_start_time_seconds | Uptime of apex-pdp application in seconds | |
+---------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
-| pdpa_policy_deployments_total | Number of TOSCA policy deploy/undeploy operations | "operation": Possibles values are deploy, undeploy; "status": Deploy/Undeploy status values - SUCCESS, FAILURE, TOTAL |
+| pdpa_policy_deployments_total | Number of TOSCA policy deploy/undeploy operations | "operation": Possibles values are deploy, undeploy; "status": Deploy/Undeploy status values - SUCCESS, FAILURE, TOTAL|
+---------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
-| pdpa_policy_executions_total | Number of TOSCA policy executions | "status": Execution status values - SUCCESS, FAILURE, TOTAL" |
+| pdpa_policy_executions_total | Number of TOSCA policy executions | "status": Execution status values - SUCCESS, FAILURE, TOTAL" |
+---------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| pdpa_engine_state | State of APEX engine | "engine_instance_id": ID of the engine thread |
+---------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
@@ -151,6 +151,23 @@ Key metrics for XACML PDP
Key metrics for Policy Distribution
-----------------------------------
++------------------------------------+-------------------------------------------------------+
+| Metric name | Metric description |
++====================================+=======================================================+
+| total_distribution_received_count | Total number of distribution received |
++------------------------------------+-------------------------------------------------------+
+| distribution_success_count | Total number of distribution successfully processed |
++------------------------------------+-------------------------------------------------------+
+| distribution_failure_count | Total number of distribution failures |
++------------------------------------+-------------------------------------------------------+
+| total_download_received_count | Total number of download received |
++------------------------------------+-------------------------------------------------------+
+| download_success_count | Total number of download successfully processed |
++------------------------------------+-------------------------------------------------------+
+| download_failure_count | Total number of download failures |
++------------------------------------+-------------------------------------------------------+
+
+
3. OOM changes to enable prometheus monitoring for Policy Framework
===================================================================