2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Modifications Copyright (c) 2019 Samsung
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END=========================================================
23 package org.onap.so.apihandlerinfra;
27 import java.util.Collections;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31 import org.springframework.http.MediaType;
32 import org.springframework.http.ResponseEntity;
34 import javax.annotation.PostConstruct;
35 import javax.transaction.Transactional;
36 import javax.ws.rs.DefaultValue;
37 import javax.ws.rs.GET;
38 import javax.ws.rs.Path;
39 import javax.ws.rs.Produces;
40 import javax.ws.rs.QueryParam;
41 import javax.ws.rs.container.ContainerRequestContext;
42 import javax.ws.rs.core.Context;
43 import javax.ws.rs.core.Response;
44 import javax.ws.rs.core.UriBuilder;
46 import org.apache.http.HttpStatus;
47 import org.onap.so.logger.MessageEnum;
48 import org.springframework.beans.factory.annotation.Autowired;
49 import org.springframework.core.env.Environment;
50 import org.springframework.http.HttpEntity;
51 import org.springframework.http.HttpHeaders;
52 import org.springframework.stereotype.Component;
53 import org.springframework.web.client.RestTemplate;
54 import org.springframework.http.HttpMethod;
55 import io.swagger.annotations.Api;
56 import io.swagger.annotations.ApiOperation;
60 @Path("/globalhealthcheck")
61 @Api(value="/globalhealthcheck",description="APIH Infra Global Health Check")
62 public class GlobalHealthcheckHandler {
63 private static Logger logger = LoggerFactory.getLogger(GlobalHealthcheckHandler.class);
64 private static final String CONTEXTPATH_PROPERTY = "management.context-path";
65 private static final String PROPERTY_DOMAIN = "mso.health.endpoints";
66 private static final String CATALOGDB_PROPERTY = PROPERTY_DOMAIN + ".catalogdb";
67 private static final String REQUESTDB_PROPERTY = PROPERTY_DOMAIN + ".requestdb";
68 private static final String SDNC_PROPERTY = PROPERTY_DOMAIN + ".sdnc";
69 private static final String OPENSTACK_PROPERTY = PROPERTY_DOMAIN + ".openstack";
70 private static final String BPMN_PROPERTY = PROPERTY_DOMAIN + ".bpmn";
71 private static final String ASDC_PROPERTY = PROPERTY_DOMAIN + ".asdc";
72 private static final String REQUESTDBATTSVC_PROPERTY = PROPERTY_DOMAIN + ".requestdbattsvc";
73 private static final String DEFAULT_PROPERTY_VALUE = "";
76 private String actuatorContextPath;
77 private String endpointCatalogdb;
78 private String endpointRequestdb;
79 private String endpointSdnc;
80 private String endpointOpenstack;
81 private String endpointBpmn;
82 private String endpointAsdc;
83 private String endpointRequestdbAttsvc;
86 private Environment env;
89 private RestTemplate restTemplate;
90 private final String health = "/health";
94 protected void init() {
95 actuatorContextPath = env.getProperty(CONTEXTPATH_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
96 endpointCatalogdb = env.getProperty(CATALOGDB_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
97 endpointRequestdb = env.getProperty(REQUESTDB_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
98 endpointSdnc = env.getProperty(SDNC_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
99 endpointOpenstack = env.getProperty(OPENSTACK_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
100 endpointBpmn = env.getProperty(BPMN_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
101 endpointAsdc = env.getProperty(ASDC_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
102 endpointRequestdbAttsvc = env.getProperty(REQUESTDBATTSVC_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
106 @Produces("application/json")
107 @ApiOperation(value="Performing global health check",response=Response.class)
109 public Response globalHealthcheck (@DefaultValue("true") @QueryParam("enableBpmn") boolean enableBpmn,
110 @Context ContainerRequestContext requestContext) {
111 Response HEALTH_CHECK_RESPONSE = null;
112 // Build internal response object
113 HealthcheckResponse rsp = new HealthcheckResponse();
116 // Generated RequestId
117 String requestId = requestContext.getProperty("requestId").toString();
118 logger.info("{} {}", MessageEnum.APIH_GENERATED_REQUEST_ID.toString(), requestId);
120 // set APIH status, this is the main entry point
121 rsp.setApih(HealthcheckStatus.UP.toString());
123 rsp.setBpmn(querySubsystemHealth(MsoSubsystems.BPMN));
125 rsp.setSdncAdapter(querySubsystemHealth(MsoSubsystems.SDNC));
126 // set ASDCController
127 rsp.setAsdcController(querySubsystemHealth(MsoSubsystems.ASDC));
128 // set CatalogDbAdapter
129 rsp.setCatalogdbAdapter(querySubsystemHealth(MsoSubsystems.CATALOGDB));
130 // set RequestDbAdapter
131 rsp.setRequestdbAdapter(querySubsystemHealth(MsoSubsystems.REQUESTDB));
132 // set OpenStackAdapter
133 rsp.setOpenstackAdapter(querySubsystemHealth(MsoSubsystems.OPENSTACK));
134 // set RequestDbAdapterAttSvc
135 rsp.setRequestdbAdapterAttsvc(querySubsystemHealth(MsoSubsystems.REQUESTDBATT));
137 rsp.setMessage(String.format("HttpStatus: %s", HttpStatus.SC_OK));
138 logger.info(rsp.toString());
140 HEALTH_CHECK_RESPONSE = Response.status (HttpStatus.SC_OK)
144 }catch (Exception ex){
145 logger.error("Exception occurred", ex);
146 rsp.setMessage(ex.getMessage());
147 HEALTH_CHECK_RESPONSE = Response.status (HttpStatus.SC_INTERNAL_SERVER_ERROR)
152 return HEALTH_CHECK_RESPONSE;
155 protected HttpEntity<String> buildHttpEntityForRequest(){
156 HttpHeaders headers = new HttpHeaders();
157 headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));
158 headers.set("Content-Type", "application/json");
159 HttpEntity<String> entity = new HttpEntity<>("parameters", headers);
163 protected String querySubsystemHealth(MsoSubsystems subsystem){
165 // get port number for the subsystem
166 String ept = getEndpointUrlForSubsystemEnum(subsystem);
168 // build final endpoint url
169 UriBuilder builder = UriBuilder.fromPath(ept).path(actuatorContextPath).path(health);
170 URI uri = builder.build();
171 logger.info("Calculated URL: {}", uri.toString());
173 ResponseEntity<SubsystemHealthcheckResponse> result =
174 restTemplate.exchange(uri, HttpMethod.GET, buildHttpEntityForRequest(), SubsystemHealthcheckResponse.class);
176 return processResponseFromSubsystem(result,subsystem);
178 }catch(Exception ex){
179 logger.error("Exception occured in GlobalHealthcheckHandler.querySubsystemHealth() ", ex);
180 return HealthcheckStatus.DOWN.toString();
183 protected String processResponseFromSubsystem(ResponseEntity<SubsystemHealthcheckResponse> result, MsoSubsystems subsystem){
184 if(result == null || result.getStatusCodeValue() != HttpStatus.SC_OK){
185 logger.error(String.format("Globalhealthcheck: checking subsystem: %s failed ! result object is: %s",
187 result == null? "NULL": result));
188 return HealthcheckStatus.DOWN.toString();
191 SubsystemHealthcheckResponse body = result.getBody();
193 String status = body.getStatus();
194 if("UP".equalsIgnoreCase(status)){
195 return HealthcheckStatus.UP.toString();
197 logger.error("{}, query health endpoint did not return UP status!", subsystem);
198 return HealthcheckStatus.DOWN.toString();
203 protected String getEndpointUrlForSubsystemEnum(MsoSubsystems subsystem){
206 return this.endpointSdnc;
208 return this.endpointAsdc;
210 return this.endpointBpmn;
212 return this.endpointCatalogdb;
214 return this.endpointOpenstack;
216 return this.endpointRequestdb;
218 return this.endpointRequestdbAttsvc;