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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
/*-
* ============LICENSE_START==========================================
* ONAP Portal
* ===================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ===================================================================
*
* Unless otherwise specified, all software contained herein is licensed
* under the Apache License, Version 2.0 (the "License");
* you may not use this software 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.
*
* Unless otherwise specified, all documentation contained herein is licensed
* under the Creative Commons License, Attribution 4.0 Intl. (the "License");
* you may not use this documentation except in compliance with the License.
* You may obtain a copy of the License at
*
* https://creativecommons.org/licenses/by/4.0/
*
* Unless required by applicable law or agreed to in writing, documentation
* 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.portalapp.portal.listener;
import java.util.List;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import org.hibernate.Query;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.onap.portalapp.portal.logging.aop.EPMetricsLog;
import org.onap.portalapp.portal.logging.format.EPAppMessagesEnum;
import org.onap.portalapp.portal.logging.logic.EPLogUtil;
import org.onap.portalapp.portal.ueb.EPUebHelper;
import org.onap.portalapp.portal.utils.EPCommonSystemProperties;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.onap.portalsdk.core.util.SystemProperties;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.transaction.annotation.Transactional;
@Transactional
@org.springframework.context.annotation.Configuration
@EnableAspectJAutoProxy
@EPMetricsLog
public class HealthMonitor {
private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(HealthMonitor.class);
@Autowired
private SessionFactory sessionFactory;
@Autowired
private EPUebHelper epUebHelper;
private static boolean databaseUp;
private static boolean uebUp;
private static boolean frontEndUp;
private static boolean backEndUp;
private static boolean dbClusterStatusOk;
private static boolean dbPermissionsOk;
/**
* Read directly by external classes.
*/
public static boolean isSuspended = false;
private Thread healthMonitorThread;
public HealthMonitor() {
}
public static boolean isDatabaseUp() {
return databaseUp;
}
public static boolean isClusterStatusOk() {
return dbClusterStatusOk;
}
public static boolean isDatabasePermissionsOk() {
return dbPermissionsOk;
}
public static boolean isUebUp() {
return uebUp;
}
public static boolean isFrontEndUp() {
return frontEndUp;
}
public static boolean isBackEndUp() {
return backEndUp;
}
private void monitorEPHealth() throws InterruptedException {
int numIntervalsDatabaseHasBeenDown = 0;
int numIntervalsClusterNotHealthy = 0;
int numIntervalsDatabasePermissionsIncorrect = 0;
int numIntervalsUebHasBeenDown = 0;
logger.debug(EELFLoggerDelegate.debugLogger, "monitorEPHealth thread started");
long sleepInterval = (Long
.valueOf(SystemProperties.getProperty(EPCommonSystemProperties.HEALTH_POLL_INTERVAL_SECONDS)) * 1000);
long numIntervalsBetweenAlerts = Long
.valueOf(SystemProperties.getProperty(EPCommonSystemProperties.HEALTHFAIL_ALERT_EVERY_X_INTERVALS));
logger.debug(EELFLoggerDelegate.debugLogger,
"monitorEPHealth: Polling health every " + sleepInterval + " milliseconds. Alerting every "
+ (sleepInterval * numIntervalsBetweenAlerts) / 1000 + " seconds when component remains down.");
while (true) {
//
// Get DB status. If down, signal alert once every X intervals.
//
databaseUp = this.checkIfDatabaseUp();
if (databaseUp == false) {
if ((numIntervalsDatabaseHasBeenDown % numIntervalsBetweenAlerts) == 0) {
logger.debug(EELFLoggerDelegate.debugLogger,
"monitorEPHealth: database down, logging to error log to trigger alert.");
// Write a Log entry that will generate an alert
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeHealthCheckMySqlError);
numIntervalsDatabaseHasBeenDown++;
} else {
numIntervalsDatabaseHasBeenDown = 0;
}
}
dbClusterStatusOk = this.checkClusterStatus();
if (dbClusterStatusOk == false) {
if ((numIntervalsClusterNotHealthy % numIntervalsBetweenAlerts) == 0) {
logger.debug(EELFLoggerDelegate.debugLogger,
"monitorEPHealth: cluster nodes down, logging to error log to trigger alert.");
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeHealthCheckMySqlError);
numIntervalsClusterNotHealthy++;
} else {
numIntervalsClusterNotHealthy = 0;
}
}
dbPermissionsOk = this.checkDatabasePermissions();
if (dbPermissionsOk == false) {
if ((numIntervalsDatabasePermissionsIncorrect % numIntervalsBetweenAlerts) == 0) {
logger.debug(EELFLoggerDelegate.debugLogger,
"monitorEPHealth: database permissions incorrect, logging to error log to trigger alert.");
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeHealthCheckMySqlError);
numIntervalsDatabasePermissionsIncorrect++;
} else {
numIntervalsDatabasePermissionsIncorrect = 0;
}
}
//
// Get UEB status. Publish a bogus message to EP inbox, if 200 OK
// returned, status is Up.
// If down, signal alert once every X intervals.
// EP will ignore this bogus message.
//
uebUp = this.checkIfUebUp();
if (uebUp == false) {
if ((numIntervalsUebHasBeenDown % numIntervalsBetweenAlerts) == 0) {
logger.debug(EELFLoggerDelegate.debugLogger,
"monitorEPHealth: UEB down, logging to error log to trigger alert");
// Write a Log entry that will generate an alert
EPLogUtil.logEcompError(logger, EPAppMessagesEnum.BeHealthCheckUebClusterError);
numIntervalsUebHasBeenDown++;
} else {
numIntervalsUebHasBeenDown = 0;
}
}
// The front end should be up because the API is called through
// proxy front end server.
frontEndUp = true;
// If the rest API called, the backend is always up
backEndUp = true;
//
// future nice to have...get Partner status
//
// For all apps exposing a rest url, query one of the rest
// urls(/roles?) and manage a list
// of app name/status. We might not return back a non 200 OK in
// health check, but we
// could return information in the json content of a health check.
//
//
// Get DB status. If down, signal alert once every X intervals.
//
if (Thread.interrupted()) {
logger.info(EELFLoggerDelegate.errorLogger, "monitorEPHealth: thread interrupted");
break;
}
try {
Thread.sleep(sleepInterval);
} catch (InterruptedException e) {
logger.error(EELFLoggerDelegate.errorLogger, "monitorEPHealth: sleep interrupted", e);
Thread.currentThread().interrupt();
}
}
}
@PostConstruct
public void initHealthMonitor() {
healthMonitorThread = new Thread("EP HealthMonitor thread") {
public void run() {
try {
monitorEPHealth();
} catch (InterruptedException e) {
logger.debug(EELFLoggerDelegate.debugLogger, "healthMonitorThread interrupted", e);
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "healthMonitorThread failed", e);
}
}
};
healthMonitorThread.start();
}
@PreDestroy
public void closeHealthMonitor() {
this.healthMonitorThread.interrupt();
}
/**
* This routine checks whether the database can be read. In June 2017 we
* experimented with checking if the database can be WRITTEN. Writes failed
* with some regularity in a MariaDB Galera cluster, and in that
* environment, the resulting alerts in the log triggered a health monitor
* cron job to shut down the Tomcat instance. The root cause of the cluster
* write failures was not determined.
*
* @return true if the database can be read.
*/
private boolean checkIfDatabaseUp() {
boolean isUp = false;
Session localSession = null;
try {
localSession = sessionFactory.openSession();
if (localSession != null) {
String sql = "select app_name from fn_app where app_id=1";
Query query = localSession.createSQLQuery(sql);
@SuppressWarnings("unchecked")
List<String> queryList = query.list();
if (queryList != null) {
isUp = true;
}
}
} catch (Exception e) {
logger.debug(EELFLoggerDelegate.debugLogger, "checkIfDatabaseUp failed", e);
isUp = false;
} finally {
if (localSession != null)
localSession.close();
}
return isUp;
}
private boolean checkClusterStatus() {
boolean isUp = false;
Session localSession = null;
try {
localSession = sessionFactory.openSession();
if (localSession != null) {
// If all nodes are unhealthy in a cluster, this will throw an
// exception
String sql = "select * from mysql.user";
Query query = localSession.createSQLQuery(sql);
@SuppressWarnings("unchecked")
List<String> queryList = query.list();
if (queryList != null) {
isUp = true;
}
}
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "checkClusterStatus failed", e);
if ((e.getCause() != null) && (e.getCause().getMessage() != null)) {
logger.error(EELFLoggerDelegate.errorLogger, "checkClusterStatus failure cause", e.getCause());
}
isUp = false;
} finally {
if (localSession != null) {
localSession.close();
}
}
return isUp;
}
private boolean checkDatabasePermissions() {
boolean isUp = false;
Session localSession = null;
try {
localSession = sessionFactory.openSession();
if (localSession != null) {
String sql = "SHOW GRANTS FOR CURRENT_USER";
Query query = localSession.createSQLQuery(sql);
@SuppressWarnings("unchecked")
List<String> grantsList = query.list();
for (String str : grantsList) {
if ((str.toUpperCase().contains("ALL"))
|| (str.toUpperCase().contains("DELETE") && str.toUpperCase().contains("SELECT")
&& str.toUpperCase().contains("UPDATE") && str.toUpperCase().contains("INSERT"))) {
isUp = true;
break;
}
}
if (isUp == false) {
logger.error(EELFLoggerDelegate.errorLogger,
"checkDatabasePermissions returning false. SHOW GRANTS FOR CURRENT_USER being dumped:");
for (String str : grantsList) {
logger.error(EELFLoggerDelegate.errorLogger, "grants output item = [" + str + "]");
}
}
}
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "checkDatabasePermissions failed", e);
if ((e.getCause() != null) && (e.getCause().getMessage() != null)) {
logger.error(EELFLoggerDelegate.errorLogger, "checkDatabasePermissions failure cause", e.getCause());
}
isUp = false;
} finally {
if (localSession != null) {
localSession.close();
}
}
return isUp;
}
private boolean checkIfUebUp() {
boolean uebUp = false;
try {
boolean isAvailable = epUebHelper.checkAvailability();
boolean messageCanBeSent = epUebHelper.MessageCanBeSentToTopic();
uebUp = (isAvailable && messageCanBeSent);
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "checkIfUebUp failed", e);
}
return uebUp;
}
}
|