X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdevelopment%2Fprometheus-metrics.rst;h=41b497a7a41c3270f00a441ef172d0c69ca05c9b;hb=adae6f1f22527ee431536fe49c47a2c866f2a6a5;hp=341d6d5a88f3b173c83b865a9f27f9c13c54e596;hpb=a4dbca2b8cd7d6f06abc53ce7a650b1360beac68;p=policy%2Fparent.git diff --git a/docs/development/prometheus-metrics.rst b/docs/development/prometheus-metrics.rst index 341d6d5a..41b497a7 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 | +---------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ @@ -131,9 +131,6 @@ Key metrics for APEX-PDP | pdpa_engine_average_execution_time_seconds | Average time taken to execute an APEX policy in seconds | "engine_instance_id": ID of the engine thread | +---------------------------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -Key metrics for Drools PDP --------------------------- - Key metrics for XACML PDP ------------------------- @@ -142,15 +139,51 @@ Key metrics for XACML PDP +================================+===================================================+==============================================================================================================================================================================================================================+ | process_start_time_seconds | Uptime of policy-pap application in seconds. | | +--------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| pdpx_policy_deployments_total | Counts the total number of deployment operations | "deploy": Counts the number of successful or failed deploys; "undeploy": Counts the number of successful or failed undeploys | +| pdpx_policy_deployments_total | Counts the total number of deployment operations | "operation": Possible values are deploy, undeploy | +--------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| pdpx_policy_decisions_total | Counts the total number of decisions | 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. | +| pdpx_policy_decisions_total | Counts the total number of decisions | "application": Possible values are Monitoring, Guard, Optimization, Naming, Native, Match; | +| | | "status": Possible values are permit, deny, indeterminant, not_applicable | ++--------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| logback_appender_total | Counts the log entries | level: Counts on a per log level basis. | +--------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Key metrics for Drools PDP +-------------------------- + ++-----------------------------------------------+-------------------------------------------------------+-------------------------------------------------------+ +| Metric name | Metric description |Metric labels | ++===============================================+=======================================================+=======================================================+ +| process_start_time_seconds | Uptime of policy-drools-pdp component in seconds. | | ++-----------------------------------------------+-------------------------------------------------------+-------------------------------------------------------+ +| pdpd_policy_deployments_total | Count of policy deployments | operation: deploy|undeploy, status: SUCCESS|FAILURE | ++-----------------------------------------------+-------------------------------------------------------+-------------------------------------------------------+ +| pdpd_policy_executions_latency_seconds_count | Count of policy executions | controller, controlloop, policy | ++-----------------------------------------------+-------------------------------------------------------+-------------------------------------------------------+ +| pdpd_policy_executions_latency_seconds_sum | Count of policy execution latency in seconds | controller, controlloop, policy | ++-----------------------------------------------+-------------------------------------------------------+-------------------------------------------------------+ +| logback_appender_total | Count of log entries | level | ++-----------------------------------------------+-------------------------------------------------------+-------------------------------------------------------+ 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 ===================================================================