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
|
/*-
* ================================================================================
* DCAE DMaaP Bus Controller Web Application
* ================================================================================
* 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.dmaapbc.dbcapp.controller;
import java.util.Date;
import javax.servlet.http.HttpServletRequest;
import org.openecomp.dmaapbc.dbcapp.service.DmaapAccessService;
import org.openecomp.portalsdk.core.controller.UnRestrictedBaseController;
import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.openecomp.portalsdk.core.util.SystemProperties;
import org.slf4j.MDC;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
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;
/**
* This controller responds to probes for application health, returning a JSON
* body to indicate current status.
*/
@RestController
@Configuration
@EnableAspectJAutoProxy
@RequestMapping("/")
public class HealthCheckController extends UnRestrictedBaseController {
private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(HealthCheckController.class);
private static final String HEALTH_CHECK_PATH = "/healthCheck";
@Autowired
private DmaapAccessService dmaapAccessService;
/**
* Model for JSON response with health-check results.
*/
public class HealthStatus {
// Either 200 or 500
public int statusCode;
// Additional detail in case of error, empty in case of success.
public String message;
public HealthStatus(int code, String msg) {
this.statusCode = code;
this.message = msg;
}
public int getStatusCode() {
return statusCode;
}
public void setStatusCode(int code) {
this.statusCode = code;
}
public String getMessage() {
return message;
}
public void setMessage(String msg) {
this.message = msg;
}
}
/**
* Checks application health by making a trivial query to the database.
*
* @param request
* @return 200 if database access succeeds, 500 if it fails.
*/
@RequestMapping(value = { HEALTH_CHECK_PATH }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus healthCheck(HttpServletRequest request) {
logger.setRequestBasedDefaultsIntoGlobalLoggingContext(request, DataBusHomeController.APP_NAME);
logger.info(EELFLoggerDelegate.auditLogger, request.getMethod() + request.getRequestURI());
HealthStatus healthStatus = null;
try {
logger.debug(EELFLoggerDelegate.debugLogger, "Performing health check");
dmaapAccessService.getDmaapAccessCount();
healthStatus = new HealthStatus(200, "health check succeeded");
} catch (Exception ex) {
logger.error(EELFLoggerDelegate.errorLogger, "Failed to perform health check", ex);
healthStatus = new HealthStatus(500, "health check failed: " + ex.toString());
}
return healthStatus;
}
/**
* This implementation does not support suspend/resume.
*
* @param request
* @return Trivial success
*/
@RequestMapping(value = {
HEALTH_CHECK_PATH + "/suspend" }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus healthCheckSuspend(HttpServletRequest request) {
MDC.put(SystemProperties.AUDITLOG_BEGIN_TIMESTAMP, DataBusHomeController.logDateFormat.format(new Date()));
logger.setRequestBasedDefaultsIntoGlobalLoggingContext(request, DataBusHomeController.APP_NAME);
HealthStatus response = new HealthStatus(200, "suspend not implemented");
MDC.put(SystemProperties.AUDITLOG_END_TIMESTAMP, DataBusHomeController.logDateFormat.format(new Date()));
logger.info(EELFLoggerDelegate.auditLogger, request.getMethod() + request.getRequestURI());
return response;
}
/**
* This implementation does not support suspend/resume.
*
* @param request
* @return Trivial success
*/
@RequestMapping(value = {
HEALTH_CHECK_PATH + "/resume" }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus healthCheckResume(HttpServletRequest request) {
MDC.put(SystemProperties.AUDITLOG_BEGIN_TIMESTAMP, DataBusHomeController.logDateFormat.format(new Date()));
logger.setRequestBasedDefaultsIntoGlobalLoggingContext(request, DataBusHomeController.APP_NAME);
HealthStatus response = new HealthStatus(200, "resume not implemented");
MDC.put(SystemProperties.AUDITLOG_END_TIMESTAMP, DataBusHomeController.logDateFormat.format(new Date()));
logger.info(EELFLoggerDelegate.auditLogger, request.getMethod() + request.getRequestURI());
return response;
}
/**
* Answers ping request without checking the application health.
*
* @param request
* @return Trivial success
*/
@RequestMapping(value = { HEALTH_CHECK_PATH + "/ping" }, method = RequestMethod.GET, produces = "application/json")
public HealthStatus ping(HttpServletRequest request) {
MDC.put(SystemProperties.AUDITLOG_BEGIN_TIMESTAMP, DataBusHomeController.logDateFormat.format(new Date()));
logger.setRequestBasedDefaultsIntoGlobalLoggingContext(request, DataBusHomeController.APP_NAME);
HealthStatus response = new HealthStatus(200, "ping received");
MDC.put(SystemProperties.AUDITLOG_END_TIMESTAMP, DataBusHomeController.logDateFormat.format(new Date()));
logger.info(EELFLoggerDelegate.auditLogger, request.getMethod() + request.getRequestURI());
return response;
}
}
|
