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
|
/*-
* ================================================================================
* eCOMP Portal
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property
* ================================================================================
* 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.
* ================================================================================
*/
package org.openecomp.portalapp.portal.controller;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.openecomp.portalapp.controller.EPRestrictedBaseController;
import org.openecomp.portalapp.portal.listener.HealthMonitor;
import org.openecomp.portalapp.portal.logging.aop.EPAuditLog;
import org.openecomp.portalapp.portal.logging.format.EPAppMessagesEnum;
import org.openecomp.portalapp.portal.logging.logic.EPLogUtil;
import org.openecomp.portalapp.portal.utils.EPSystemProperties;
import org.openecomp.portalapp.portal.utils.EcompPortalUtils;
import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.slf4j.MDC;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import com.google.gson.Gson;
/*
* This controller checks the health status and returns JSON response.
* It does not require
*/
@RestController
@org.springframework.context.annotation.Configuration
@EnableAspectJAutoProxy
@EPAuditLog
public class HealthCheckController extends EPRestrictedBaseController {
private class HealthStatus {
public int statusCode;
@SuppressWarnings("unused")
public String body;
public HealthStatus(int code, String body) {
this.statusCode = code;
this.body = body;
}
}
private class HealthStatusInfo {
HealthStatusInfo(String healthCheckComponent) {
this.healthCheckComponent = healthCheckComponent;
this.healthCheckStatus = statusUp; // Default value
this.version = "";
this.description = statusOk; // Default value
this.hostName = "";
this.ipAddress = "";
this.dbClusterStatus = "";
this.dbPermissions = "";
}
@SuppressWarnings("unused")
public String healthCheckComponent;
@SuppressWarnings("unused")
public String healthCheckStatus;
@SuppressWarnings("unused")
public String version;
@SuppressWarnings("unused")
public String description;
@SuppressWarnings("unused")
public String hostName;
@SuppressWarnings("unused")
public String ipAddress;
@SuppressWarnings("unused")
public String dbClusterStatus;
@SuppressWarnings("unused")
public String dbPermissions;
}
private final String statusUp = "UP";
private final String statusDown = "DOWN";
private final String statusOk = "OK";
EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(HealthCheckController.class);
@RequestMapping(value = { "/portalApi/healthCheck" }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus healthCheck(HttpServletRequest request, HttpServletResponse response) {
HealthStatus healthStatus = new HealthStatus(500, "");
// Return the status as 500 if it suspended due to manual fail over
if (HealthMonitor.isSuspended) {
healthStatus.body = "Suspended";
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
MDC.put(EPSystemProperties.RESPONSE_CODE, Integer.toString(HttpServletResponse.SC_INTERNAL_SERVER_ERROR));
return healthStatus;
}
try {
boolean overallStatus = true;
List<HealthStatusInfo> statusCollection = new ArrayList<HealthStatusInfo>();
HealthStatusInfo beInfo = new HealthStatusInfo("BE");
beInfo.hostName = EcompPortalUtils.getMyHostName();
beInfo.ipAddress = EcompPortalUtils.getMyIpAdddress();
if (!HealthMonitor.isBackEndUp()) {
overallStatus = false;
beInfo.healthCheckStatus = statusDown;
beInfo.description = "Check the logs for more details";
EPLogUtil.logEcompError(EPAppMessagesEnum.BeHealthCheckError);
}
statusCollection.add(beInfo);
HealthStatusInfo feInfo = new HealthStatusInfo("FE");
if (!HealthMonitor.isFrontEndUp()) {
overallStatus = false;
feInfo.healthCheckStatus = statusDown;
feInfo.description = "Check the logs for more details";
EPLogUtil.logEcompError(EPAppMessagesEnum.FeHealthCheckError);
}
statusCollection.add(feInfo);
HealthStatusInfo dbInfo = new HealthStatusInfo("DB");
if (!HealthMonitor.isDatabaseUp()) {
overallStatus = false;
dbInfo.healthCheckStatus = statusDown;
dbInfo.description = "Check the logs for more details";
EPLogUtil.logEcompError(EPAppMessagesEnum.BeDaoSystemError);
}
if (!HealthMonitor.isClusterStatusOk()) {
dbInfo.dbClusterStatus = "Problem, check the logs for more details";
EPLogUtil.logEcompError(EPAppMessagesEnum.BeDaoSystemError);
}
else {
dbInfo.dbClusterStatus = statusOk;
}
if (!HealthMonitor.isDatabasePermissionsOk()) {
dbInfo.dbPermissions = "Problem, check the logs for more details";
EPLogUtil.logEcompError(EPAppMessagesEnum.BeDaoSystemError);
}
else {
dbInfo.dbPermissions = statusOk;
}
statusCollection.add(dbInfo);
HealthStatusInfo uebInfo = new HealthStatusInfo("UEB");
if (!HealthMonitor.isUebUp()) {
uebInfo.healthCheckStatus = statusDown;
uebInfo.description = "Check the logs for more details";
EPLogUtil.logEcompError(EPAppMessagesEnum.BeUebConnectionError);
}
statusCollection.add(uebInfo);
String json = "";
try {
json = new Gson().toJson(statusCollection);
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, EcompPortalUtils.getStackTrace(e));
EPLogUtil.logEcompError(EPAppMessagesEnum.BeInvalidJsonInput);
}
logger.info(EELFLoggerDelegate.debugLogger, json);
if (overallStatus) {
healthStatus = new HealthStatus(200, json);
} else {
healthStatus = new HealthStatus(500, json);
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
}
MDC.put(EPSystemProperties.RESPONSE_CODE, Integer.toString(healthStatus.statusCode));
} catch (Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "Exception occurred while performing the healthcheck. Details: "
+ EcompPortalUtils.getStackTrace(e));
}
EcompPortalUtils.logAndSerializeObject("/portalApi/healthCheck", "GET result =", response.getStatus());
return healthStatus;
}
@RequestMapping(value = {
"/portalApi/healthCheckSuspend" }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus healthCheckSuspend(HttpServletRequest request, HttpServletResponse response) {
HealthStatus healthStatus = new HealthStatus(500, "Suspended for manual failover mechanism");
HealthMonitor.isSuspended = true;
healthStatus.statusCode = 200;
EcompPortalUtils.logAndSerializeObject("/portalApi/healthCheckSuspend", "GET result =",
response.getStatus());
return healthStatus;
}
@RequestMapping(value = {
"/portalApi/healthCheckResume" }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus healthCheckResume(HttpServletRequest request, HttpServletResponse response) {
HealthStatus healthStatus = new HealthStatus(500, "Resumed from manual failover mechanism");
HealthMonitor.isSuspended = false;
healthStatus.statusCode = 200;
EcompPortalUtils.logAndSerializeObject("/portalApi/healthCheckResume", "GET result =",
response.getStatus());
return healthStatus;
}
@RequestMapping(value = {
"/portalApi/ping" }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus ping(HttpServletRequest request, HttpServletResponse response) {
HealthStatus healthStatus = new HealthStatus(200, "OK");
EcompPortalUtils.logAndSerializeObject("/portalApi/ping", "GET result =",
response.getStatus());
return healthStatus;
}
}
|
