aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/main/java/org/onap/policy/pdpx/main/rest/XacmlPdpStatisticsManager.java
blob: 253a009516d50c9281054caea41e33350b024db0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2019, 2021-2022 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.pdpx.main.rest;

import io.prometheus.client.Counter;
import java.util.HashMap;
import java.util.Map;
import lombok.Getter;
import lombok.Setter;
import lombok.Synchronized;
import org.onap.policy.common.utils.resources.PrometheusUtils;
import org.onap.policy.models.pdp.enums.PdpResponseStatus;

/**
 * Class to hold statistical data for xacmlPdp component.
 */
@Getter(onMethod_ = @Synchronized)
public class XacmlPdpStatisticsManager {
    @Getter
    @Setter
    private static XacmlPdpStatisticsManager current = null;
    protected static final String PROMETHEUS_NAMESPACE = "pdpx";
    protected static final String POLICY_DECISIONS_METRIC = "policy_decisions";
    public static final String POLICY_DECISIONS_HELP = "The total number of policy decisions.";
    public static final String PERMIT_OPERATION = "permit";
    public static final String DENY_OPERATION = "deny";
    public static final String INDETERMINANT_OPERATION = "indeterminant";
    public static final String NOT_APPLICABLE_OPERATION = "not_applicable";
    public static final String APPLICATION = "application";

    protected static final Counter deploymentsCounter =
        Counter.build().namespace(PROMETHEUS_NAMESPACE).name(PrometheusUtils.POLICY_DEPLOYMENTS_METRIC)
            .labelNames(PrometheusUtils.OPERATION_METRIC_LABEL,
                PrometheusUtils.STATUS_METRIC_LABEL)
            .help(PrometheusUtils.POLICY_DEPLOYMENT_HELP)
            .register();

    protected static final Counter decisionsCounter =
        Counter.build().namespace(PROMETHEUS_NAMESPACE).name(POLICY_DECISIONS_METRIC)
            .labelNames(APPLICATION, PrometheusUtils.STATUS_METRIC_LABEL)
            .help(POLICY_DECISIONS_HELP)
            .register();

    private long totalPolicyTypesCount;
    private long totalPoliciesCount;
    private long errorCount;
    private long permitDecisionsCount;
    private long denyDecisionsCount;
    private long deploySuccessCount;
    private long deployFailureCount;
    private long undeploySuccessCount;
    private long undeployFailureCount;
    private long indeterminantDecisionsCount;
    private long notApplicableDecisionsCount;
    private Map<String, Map<String, Integer>> applicationMetrics = new HashMap<>();

    /**
     * Used to update our Map of ApplicationNames to statistics.
     * A typical applicationsMetric map could look something like this:
     * {
     *     "app_1_name": {
     *         "permit_decisions_count": 1,
     *         "deny_decisions_count": 1
     *     },
     *     "app_2_name": {
     *         "indeterminant_decisions_count": 1,
     *         "not_applicable_decisions_count": 1
     *     }
     * }
     * @param appName - the current app we are updating decisions for
     * @param updateMethod - the kind of decision we made for our app
     */
    @Synchronized
    public void updateApplicationMetrics(String appName, String updateMethod) {
        if (!applicationMetrics.containsKey(appName)) {
            Map<String, Integer> appMap = new HashMap<>();
            appMap.put(updateMethod, 1);
            applicationMetrics.put(appName, appMap);
        } else {
            int newTotal = applicationMetrics.get(appName).getOrDefault(updateMethod, 0) + 1;
            applicationMetrics.get(appName).put(updateMethod, newTotal);
        }
    }

    /**
     * Method to set the xacml pdp total policy types count. This
     * doesn't really increment, it depends on the applications
     * that are loaded. Which can be dynamic.
     */
    @Synchronized
    public void setTotalPolicyTypesCount(long newCount) {
        totalPolicyTypesCount = newCount;
    }

    /**
     * Method to set the xacml pdp total policies count. This
     * doesn't really increment, it depends on the applications
     * that are loaded. Which can be dynamic.
     */
    @Synchronized
    public void setTotalPolicyCount(long newCount) {
        totalPoliciesCount = newCount;
    }

    /**
     * Method to update the number of error decisions.
     */
    @Synchronized
    public void updateErrorCount() {
        ++errorCount;
    }

    /**
     * Method to update the number of permit decisions.
     */
    @Synchronized
    public void updatePermitDecisionsCount(String appName) {
        decisionsCounter.labels(appName, PERMIT_OPERATION).inc();
        updateApplicationMetrics(appName, "permit_decisions_count");
        ++permitDecisionsCount;
    }

    /**
     * Method to update the number of deny decisions.
     */
    @Synchronized
    public void updateDenyDecisionsCount(String appName) {
        decisionsCounter.labels(appName, DENY_OPERATION).inc();
        updateApplicationMetrics(appName, "deny_decisions_count");
        ++denyDecisionsCount;
    }

    /**
     * Method to update the number of indeterminant decisions.
     */
    @Synchronized
    public void updateIndeterminantDecisionsCount(String appName) {
        decisionsCounter.labels(appName, INDETERMINANT_OPERATION).inc();
        updateApplicationMetrics(appName, "indeterminant_decisions_count");
        ++indeterminantDecisionsCount;
    }

    /**
     * Method to update the number of not applicable decisions.
     */
    @Synchronized
    public void updateNotApplicableDecisionsCount(String appName) {
        decisionsCounter.labels(appName, NOT_APPLICABLE_OPERATION).inc();
        updateApplicationMetrics(appName, "not_applicable_decisions_count");
        ++notApplicableDecisionsCount;
    }

    /**
     * Method to update the number of successful deploys.
     */
    @Synchronized
    public void updateDeploySuccessCount() {
        deploymentsCounter.labels(PrometheusUtils.DEPLOY_OPERATION,
            PdpResponseStatus.SUCCESS.name()).inc();
        ++deploySuccessCount;
    }

    /**
     * Method to update the number of failed deploys.
     */
    @Synchronized
    public void updateDeployFailureCount() {
        deploymentsCounter.labels(PrometheusUtils.DEPLOY_OPERATION,
            PdpResponseStatus.FAIL.name()).inc();
        ++deployFailureCount;
    }

    /**
     * Method to update the number of successful undeploys.
     */
    @Synchronized
    public void updateUndeploySuccessCount() {
        deploymentsCounter.labels(PrometheusUtils.UNDEPLOY_OPERATION,
            PdpResponseStatus.SUCCESS.name()).inc();
        ++undeploySuccessCount;
    }

    /**
     * Method to update the number of failed undeploys.
     */
    @Synchronized
    public void updateUndeployFailureCount() {
        deploymentsCounter.labels(PrometheusUtils.UNDEPLOY_OPERATION,
            PdpResponseStatus.FAIL.name()).inc();
        ++undeployFailureCount;
    }

    /**
     * Reset all the statistics counts to 0.
     */
    @Synchronized
    public void resetAllStatistics() {
        totalPolicyTypesCount = 0L;
        totalPoliciesCount = 0L;
        errorCount = 0L;
        permitDecisionsCount = 0L;
        denyDecisionsCount = 0L;
        deploySuccessCount = 0L;
        deployFailureCount = 0L;
        undeploySuccessCount = 0L;
        undeployFailureCount = 0L;
        indeterminantDecisionsCount = 0L;
        notApplicableDecisionsCount = 0L;
        applicationMetrics.clear();
    }
}