support transaction reports in engine

Issue-ID: POLICY-3033
Signed-off-by: jhh <jorge.hernandez-herrero@att.com>
Change-Id: Id1f02c86be491d5145e74725f76953e294e2975c
Signed-off-by: jhh <jorge.hernandez-herrero@att.com>

2 files changed, 173 insertions, 0 deletions

diff --git a/policy-management/src/main/java/org/onap/policy/drools/stats/PolicyStats.java b/policy-management/src/main/java/org/onap/policy/drools/stats/PolicyStats.java
new file mode 100644
index 00000000..d6d8d500
--- /dev/null
+++ b/policy-management/src/main/java/org/onap/policy/drools/stats/PolicyStats.java
@@ -0,0 +1,121 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.drools.stats;
+
+import static org.slf4j.LoggerFactory.getLogger;
+
+import java.time.Instant;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+import lombok.ToString;
+import org.onap.policy.drools.metrics.TransMetric;
+import org.slf4j.Logger;
+
+/**
+ * Basic policy execution statistics.
+ */
+
+@Data
+@NoArgsConstructor
+@EqualsAndHashCode
+@ToString
+public class PolicyStats {
+
+    private static final Logger logger = getLogger(PolicyStats.class);
+
+    /**
+     * Number of executed policy transactions.
+     */
+    private long policyExecutedCount;
+
+    /**
+     * Number of successfully executed policy transactions.
+     */
+    private long policyExecutedSuccessCount;
+
+    /**
+     * Number of failed executions of policy transactions.
+     */
+    private long policyExecutedFailCount;
+
+    /**
+     * Last time the policy transaction was executed.
+     */
+    private long lastExecutionTime;
+
+    /**
+     * Average execution time of a policy transaction.
+     */
+    private double averageExecutionTime;
+
+    /**
+     * Total policy execution times.
+     */
+    private double totalElapsedTime;
+
+    /**
+     * Uptime of the entity holding the stats.
+     */
+    private long birthTime = Instant.now().toEpochMilli();
+
+    /**
+     * Time last transaction was started.
+     */
+    private long lastStart;
+
+    /**
+     * add a stat transaction record.
+     */
+    public void stat(@NonNull TransMetric trans) {
+        policyExecutedCount++;
+        if (trans.isSuccess()) {
+            policyExecutedSuccessCount++;
+        } else {
+            policyExecutedFailCount++;
+        }
+
+        // make sure transaction has values that we care about
+
+        if (trans.getStartTime() == null) {
+            logger.warn("policy transaction contains no start time: {}", trans);
+            trans.setStartTime(null);
+        }
+
+        if (trans.getEndTime() == null) {
+            logger.warn("policy transaction contains no end time: {}", trans);
+            trans.setEndTime(null);
+        }
+
+        if (trans.getElapsedTime() == null) {
+            logger.warn("policy transaction contains no elapsed time: {}", trans);
+            trans.setElapsedTime(null);
+        }
+
+        // compute after the preconditions are satisfied
+
+        lastExecutionTime = trans.getEndTime().toEpochMilli();
+        totalElapsedTime += trans.getElapsedTime();
+        averageExecutionTime = totalElapsedTime / policyExecutedCount;
+        lastStart = trans.getStartTime().toEpochMilli();
+    }
+}
diff --git a/policy-management/src/main/java/org/onap/policy/drools/stats/PolicyStatsManager.java b/policy-management/src/main/java/org/onap/policy/drools/stats/PolicyStatsManager.java
new file mode 100644
index 00000000..bb1b2679
--- /dev/null
+++ b/policy-management/src/main/java/org/onap/policy/drools/stats/PolicyStatsManager.java
@@ -0,0 +1,52 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.drools.stats;
+
+import java.util.HashMap;
+import java.util.Map;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+import lombok.ToString;
+import org.onap.policy.drools.metrics.TransMetric;
+
+/**
+ * Policy Stats Manager that manages PDP-D statistics.
+ */
+
+@NoArgsConstructor
+@Data
+@EqualsAndHashCode
+@ToString
+public class PolicyStatsManager {
+
+    private final PolicyStats groupStat = new PolicyStats();
+    private final Map<String, PolicyStats> subgroupStats = new HashMap<>();
+
+    /**
+     * stat a new transaction.
+     */
+    public synchronized void stat(@NonNull String subGroupName, @NonNull TransMetric transaction) {
+        groupStat.stat(transaction);
+        subgroupStats.computeIfAbsent(subGroupName, key -> new PolicyStats()).stat(transaction);
+    }
+}