summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorisaac <isaac.adorno@att.com>2022-04-06 13:53:53 -0500
committerisaac <isaac.adorno@att.com>2022-04-13 11:06:44 -0500
commit532c80c364a4d77e48384235a2e42d440babfcf8 (patch)
treec544a2db82ec706000177da39fea1b46ac74e214 /docs
parentbffe5fb8a9d831ca859b896c41825782f113fc24 (diff)
Adding documentation for Prometheus metrics in Xacml-PDP.
Issue-ID: POLICY-3961 Signed-off-by: isaac <isaac.adorno@att.com> Change-Id: I7c3a5e39d755297501459fcb0acad67402b02c63
Diffstat (limited to 'docs')
-rw-r--r--docs/development/prometheus-metrics.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/development/prometheus-metrics.rst b/docs/development/prometheus-metrics.rst
index 7e9211ab..90bc9225 100644
--- a/docs/development/prometheus-metrics.rst
+++ b/docs/development/prometheus-metrics.rst
@@ -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.