Adding documentation for Prometheus metrics in Xacml-PDP. 42/128342/7
authorisaac <isaac.adorno@att.com>
Wed, 6 Apr 2022 18:53:53 +0000 (13:53 -0500)
committerisaac <isaac.adorno@att.com>
Wed, 13 Apr 2022 16:06:44 +0000 (11:06 -0500)
Issue-ID: POLICY-3961
Signed-off-by: isaac <isaac.adorno@att.com>
Change-Id: I7c3a5e39d755297501459fcb0acad67402b02c63

docs/development/prometheus-metrics.rst

index 7e9211a..90bc922 100644 (file)
@@ -11,3 +11,29 @@ Prometheus Metrics support in Policy Framework Components
     :depth: 3
 
 This page explains the prometheus metrics exposed by different Policy Framework components.
+
+XACML-PDP
+*********
+
+The following Prometheus metric counters are present in the current release:
+
+- pdpx_policy_deployments_total counts the total number of deployment operations.
+- pdpx_policy_decisions_total counts the total number of decisions.
+
+pdpx_policy_deployments_total
++++++++++++++++++++++++++++++
+
+This counter supports the following labels:
+
+-  "deploy": Counts the number of successful or failed deploys.
+-  "undeploy": Counts the number of successful or failed undeploys.
+
+pdpx_policy_decisions_total
++++++++++++++++++++++++++++
+
+This counter supports the following labels:
+
+-  "permit": Counts the number of permit decisions.
+-  "deny": Counts the number of deny decisions.
+-  "indeterminant": Counts the number of indeterminant decisions.
+-  "not_applicable": Counts the number of not applicable decisions.