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
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* Copyright (C) 2017 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.
* ============LICENSE_END=========================================================
*/
package org.openecomp.sdc.be.servlets;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.jcabi.aspects.Loggable;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.servers.Server;
import io.swagger.v3.oas.annotations.servers.Servers;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;
import org.apache.commons.lang3.tuple.Pair;
import org.openecomp.sdc.be.components.health.HealthCheckBusinessLogic;
import org.openecomp.sdc.be.config.BeEcompErrorManager;
import org.openecomp.sdc.be.dao.api.ActionStatus;
import org.openecomp.sdc.be.impl.ComponentsUtils;
import org.openecomp.sdc.be.impl.WebAppContextWrapper;
import org.openecomp.sdc.be.user.UserBusinessLogic;
import org.openecomp.sdc.common.api.Constants;
import org.openecomp.sdc.common.api.HealthCheckInfo;
import org.openecomp.sdc.common.api.HealthCheckWrapper;
import org.openecomp.sdc.common.log.wrappers.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.web.context.WebApplicationContext;
import javax.inject.Inject;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.List;
@Loggable(prepend = true, value = Loggable.TRACE, trim = false)
@Path("/")
@Tags({@Tag(name = "SDC Internal APIs")})
@Servers({@Server(url = "/sdc2/rest")})
@Controller
public class BeMonitoringServlet extends BeGenericServlet {
Gson prettyGson = new GsonBuilder().setPrettyPrinting().create();
private static final Logger log = Logger.getLogger(ConfigServlet.class);
private final HealthCheckBusinessLogic healthCheckBusinessLogic;
@Inject
public BeMonitoringServlet(UserBusinessLogic userBusinessLogic,
ComponentsUtils componentsUtils,
HealthCheckBusinessLogic healthCheckBusinessLogic){
super(userBusinessLogic, componentsUtils);
this.healthCheckBusinessLogic = healthCheckBusinessLogic;
}
@GET
@Path("/healthCheck")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@Operation(description = "Return aggregate BE health check of SDC BE components",
summary = "return BE health check", responses = {
@ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))),
@ApiResponse(responseCode = "200", description = "SDC BE components are all up"),
@ApiResponse(responseCode = "500", description = "One or more SDC BE components are down")})
public Response getHealthCheck(@Context final HttpServletRequest request) {
try {
Pair<Boolean, List<HealthCheckInfo>> beHealthCheckInfosStatus = healthCheckBusinessLogic.getBeHealthCheckInfosStatus();
Boolean aggregateStatus = beHealthCheckInfosStatus.getLeft();
ActionStatus status = aggregateStatus ? ActionStatus.OK : ActionStatus.GENERAL_ERROR;
String sdcVersion = getVersionFromContext(request);
if (sdcVersion == null || sdcVersion.isEmpty()) {
sdcVersion = "UNKNOWN";
}
String siteMode = healthCheckBusinessLogic.getSiteMode();
HealthCheckWrapper healthCheck = new HealthCheckWrapper(beHealthCheckInfosStatus.getRight(), sdcVersion, siteMode);
// The response can be either with 200 or 500 aggregate status - the
// body of individual statuses is returned either way
String healthCheckStr = prettyGson.toJson(healthCheck);
return buildOkResponse(getComponentsUtils().getResponseFormat(status), healthCheckStr);
} catch (Exception e) {
BeEcompErrorManager.getInstance().logBeHealthCheckError("BeHealthCheck");
log.debug("BE health check unexpected exception", e);
throw e;
}
}
//TODO remove after UI alignment and tests after API consolidation ASDC-191
/*@GET
@Path("/version")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "return the ASDC application version", notes = "return the ASDC application version", response = String.class)
@ApiResponses(value = { @ApiResponse(code = 200, message = "return ASDC version"), @ApiResponse(code = 500, message = "Internal Error") })
public Response getSdcVersion(@Context final HttpServletRequest request) {
try {
String url = request.getMethod() + " " + request.getRequestURI();
log.debug("Start handle request of {}", url);
String version = getVersionFromContext(request);
log.debug("asdc version from manifest is: {}", version);
if (version == null || version.isEmpty()) {
return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.ASDC_VERSION_NOT_FOUND));
}
HealthCheckInfo versionInfo = new HealthCheckInfo();
versionInfo.setVersion(version);
// The response can be either with 200 or 500 aggregate status - the
// body of individual statuses is returned either way
return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), versionInfo);
} catch (Exception e) {
BeEcompErrorManager.getInstance().logBeRestApiGeneralError("getSDCVersion");
log.debug("BE get ASDC version unexpected exception", e);
return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
}
}*/
private String getVersionFromContext(HttpServletRequest request) {
ServletContext servletContext = request.getSession().getServletContext();
return (String) servletContext.getAttribute(Constants.ASDC_RELEASE_VERSION_ATTR);
}
private HealthCheckBusinessLogic getHealthCheckBL(ServletContext context) {
WebAppContextWrapper webApplicationContextWrapper = (WebAppContextWrapper) context.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR);
WebApplicationContext webApplicationContext = webApplicationContextWrapper.getWebAppContext(context);
return webApplicationContext.getBean(HealthCheckBusinessLogic.class);
}
}
|
