2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 AT&T Intellectual Property
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ========================LICENSE_END===================================
20 package org.oransc.ric.portal.dashboard;
23 import java.io.IOException;
24 import java.lang.invoke.MethodHandles;
25 import java.nio.file.Files;
26 import java.util.ArrayList;
27 import java.util.List;
29 import org.oransc.ric.portal.dashboard.exception.StatsManagerException;
30 import org.oransc.ric.portal.dashboard.model.AppStats;
31 import org.oransc.ric.portal.dashboard.model.StatsDetailsTransport;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
35 import com.fasterxml.jackson.core.type.TypeReference;
36 import com.fasterxml.jackson.databind.ObjectMapper;
39 * Provides simple xApp stats-management services.
41 * This first implementation serializes xApp stat details to a file.
43 * Migrate to a database someday?
46 public class AppStatsManager {
48 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
50 // This default value is only useful for development and testing.
51 public static final String STATS_FILE_PATH = "app-stats.json";
53 private final File statsFile;
54 private final List<AppStats> stats;
55 private int appMaxId = -1;
58 * Development/test-only constructor that uses default file path.
61 * If true, start empty and remove any existing file.
66 public AppStatsManager(boolean clear) throws IOException {
67 this(STATS_FILE_PATH);
69 logger.debug("ctor: removing file {}", statsFile.getAbsolutePath());
70 File f = new File(AppStatsManager.STATS_FILE_PATH);
72 Files.delete(f.toPath());
78 * Constructor that accepts a file path
80 * @param statsFilePath
83 * If file cannot be read
85 public AppStatsManager(final String statsFilePath) throws IOException {
86 logger.debug("ctor: statsfile {}", statsFilePath);
87 if (statsFilePath == null)
88 throw new IllegalArgumentException("Missing or empty stats file property");
89 statsFile = new File(statsFilePath);
90 logger.debug("ctor: managing stats in file {}", statsFile.getAbsolutePath());
91 if (statsFile.exists()) {
92 final ObjectMapper mapper = new ObjectMapper();
93 stats = mapper.readValue(statsFile, new TypeReference<List<AppStats>>() {
95 for (AppStats st : stats) {
96 if (st.getStatsDetails().getAppId() > appMaxId)
97 appMaxId = st.getStatsDetails().getAppId();
100 stats = new ArrayList<>();
105 * Gets the current app metric stats.
107 * @return List of App stat objects, possibly empty
109 public List<AppStats> getStats() {
114 * Gets the current app metric stats by instance key.
117 * Desired instance key
118 * @return List of App stat objects by instance key, possibly empty
120 public List<AppStats> getStatsByInstance(String instanceKey) {
121 List<AppStats> statsByInstance = new ArrayList<>();
122 for (AppStats st : this.stats) {
123 if (st.getInstanceKey().equals(instanceKey)) {
124 logger.debug("getStatsByInstance: match on instance key {}", instanceKey);
125 statsByInstance.add(st);
128 return statsByInstance;
132 * Gets the stats with the specified app Id and instance key
137 * Desired instance key
138 * @return Stats object; null if Id is not known
140 public AppStats getStatsById(String instanceKey, int appId) {
142 for (AppStats st : this.stats) {
143 if (st.getInstanceKey().equals(instanceKey) && st.getStatsDetails().getAppId() == appId) {
144 logger.debug("getStatsById: match on app id {} with instance key {}", appId, instanceKey);
148 logger.debug("getStatsById: no match on app id with instance key {}{}", appId, instanceKey);
153 private void saveStats() throws IOException {
154 final ObjectMapper mapper = new ObjectMapper();
155 mapper.writeValue(statsFile, stats);
159 * Allow at most one thread to create a stats at one time. Before creating new
160 * stat, checks for composite key (appname,url) uniqueness for an instance key
162 public synchronized AppStats createStats(String instanceKey, StatsDetailsTransport statsSetupRequest)
163 throws StatsManagerException, IOException {
164 logger.debug("createStats: appId {}, instanceKey {}", statsSetupRequest.getAppId(), instanceKey);
166 for (AppStats st : stats) {
167 if (st.getInstanceKey().equals(instanceKey)
168 && st.getStatsDetails().getAppName().equals(statsSetupRequest.getAppName())
169 && st.getStatsDetails().getMetricUrl().equals(statsSetupRequest.getMetricUrl())) {
170 // Log the existing object to avoid using tainted (user-supplied) data
171 String msg = "App exists with name " + st.getStatsDetails().getAppName() + " and url "
172 + st.getStatsDetails().getMetricUrl() + " on instance key " + st.getInstanceKey();
174 throw new StatsManagerException(msg);
178 AppStats newAppStat = null;
179 // Assigns appId to be 1 more than the largest value stored in memory
180 appMaxId = appMaxId + 1;
181 newAppStat = new AppStats(instanceKey,
182 new StatsDetailsTransport(appMaxId, statsSetupRequest.getAppName(), statsSetupRequest.getMetricUrl()));
183 stats.add(newAppStat);
189 * Allow at most one thread to modify a stats at one time. We still have
190 * last-edit-wins of course.
192 public synchronized void updateStats(String instanceKey, StatsDetailsTransport statsSetupRequest)
193 throws StatsManagerException, IOException {
194 logger.debug("updateStats: appId {}, instanceKey {}", statsSetupRequest.getAppId(), instanceKey);
195 boolean statsObjectFound = false;
197 for (AppStats st : stats) {
198 if (st.getInstanceKey().equals(instanceKey)
199 && st.getStatsDetails().getAppId() == statsSetupRequest.getAppId()) {
200 AppStats newAppStat = new AppStats(instanceKey, statsSetupRequest);
202 stats.add(newAppStat);
203 statsObjectFound = true;
208 if (!statsObjectFound) {
209 String msg = "Stats to be updated does not exist ";
211 throw new StatsManagerException(msg);
215 public synchronized AppStats deleteStats(String instanceKey, int appId) throws StatsManagerException, IOException {
216 logger.debug("deleteStats: appId {}, instanceKey {}", appId, instanceKey);
217 boolean statsObjectFound = false;
218 AppStats stat = null;
219 for (AppStats st : stats) {
220 if (st.getInstanceKey().equals(instanceKey) && st.getStatsDetails().getAppId() == appId) {
223 statsObjectFound = true;
227 } catch (Exception e) {
228 throw new StatsManagerException(e.toString());
233 if (!statsObjectFound) {
234 String msg = "deleteStats: no match on app id {} of instance key {}";
235 // Replace log pattern-breaking characters
236 instanceKey = instanceKey.replaceAll("[\n|\r|\t]", "_");
237 logger.warn(msg, appId, instanceKey);
238 throw new StatsManagerException(msg);