docs/development/prometheus-metrics.rst

   1 .. This work is licensed under a
   2 .. Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4
   5 .. _prometheus-metrics:
   6
   7 Prometheus Metrics support in Policy Framework Components
   8 #########################################################
   9
  10 .. contents::
  11     :depth: 3
  12
  13 This page explains the prometheus metrics exposed by different Policy Framework components.
  14
  15 XACML-PDP
  16 *********
  17
  18 The following Prometheus metric counters are present in the current release:
  19
  20 - pdpx_policy_deployments_total counts the total number of deployment operations.
  21 - pdpx_policy_decisions_total counts the total number of decisions.
  22
  23 pdpx_policy_deployments_total
  24 +++++++++++++++++++++++++++++
  25
  26 This counter supports the following labels:
  27
  28 -  "deploy": Counts the number of successful or failed deploys.
  29 -  "undeploy": Counts the number of successful or failed undeploys.
  30
  31 pdpx_policy_decisions_total
  32 +++++++++++++++++++++++++++
  33
  34 This counter supports the following labels:
  35
  36 -  "permit": Counts the number of permit decisions.
  37 -  "deny": Counts the number of deny decisions.
  38 -  "indeterminant": Counts the number of indeterminant decisions.
  39 -  "not_applicable": Counts the number of not applicable decisions.