gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   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
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  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=========================================================
  21  */
  22
  23 package org.onap.so.apihandlerinfra;
  24
  25
  26 import java.net.URI;
  27 import java.util.Collections;
  28 import org.onap.so.logger.LoggingAnchor;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31 import org.springframework.http.MediaType;
  32 import org.springframework.http.ResponseEntity;
  33 import javax.annotation.PostConstruct;
  34 import javax.transaction.Transactional;
  35 import javax.ws.rs.DefaultValue;
  36 import javax.ws.rs.GET;
  37 import javax.ws.rs.Path;
  38 import javax.ws.rs.Produces;
  39 import javax.ws.rs.QueryParam;
  40 import javax.ws.rs.container.ContainerRequestContext;
  41 import javax.ws.rs.core.Context;
  42 import javax.ws.rs.core.Response;
  43 import javax.ws.rs.core.UriBuilder;
  44 import org.apache.http.HttpStatus;
  45 import org.onap.so.logger.MessageEnum;
  46 import org.springframework.beans.factory.annotation.Autowired;
  47 import org.springframework.core.env.Environment;
  48 import org.springframework.http.HttpEntity;
  49 import org.springframework.http.HttpHeaders;
  50 import org.springframework.stereotype.Component;
  51 import org.springframework.web.client.RestTemplate;
  52 import org.springframework.http.HttpMethod;
  53 import io.swagger.annotations.Api;
  54 import io.swagger.annotations.ApiOperation;
  55
  56
  57 @Component
  58 @Path("/globalhealthcheck")
  59 @Api(value = "/globalhealthcheck", description = "APIH Infra Global Health Check")
  60 public class GlobalHealthcheckHandler {
  61     private static Logger logger = LoggerFactory.getLogger(GlobalHealthcheckHandler.class);
  62     private static final String CONTEXTPATH_PROPERTY = "management.context-path";
  63     private static final String PROPERTY_DOMAIN = "mso.health.endpoints";
  64     private static final String CATALOGDB_PROPERTY = PROPERTY_DOMAIN + ".catalogdb";
  65     private static final String REQUESTDB_PROPERTY = PROPERTY_DOMAIN + ".requestdb";
  66     private static final String SDNC_PROPERTY = PROPERTY_DOMAIN + ".sdnc";
  67     private static final String OPENSTACK_PROPERTY = PROPERTY_DOMAIN + ".openstack";
  68     private static final String BPMN_PROPERTY = PROPERTY_DOMAIN + ".bpmn";
  69     private static final String ASDC_PROPERTY = PROPERTY_DOMAIN + ".asdc";
  70     private static final String REQUESTDBATTSVC_PROPERTY = PROPERTY_DOMAIN + ".requestdbattsvc";
  71     private static final String DEFAULT_PROPERTY_VALUE = "";
  72
  73     // e.g. /manage
  74     private String actuatorContextPath;
  75     private String endpointCatalogdb;
  76     private String endpointRequestdb;
  77     private String endpointSdnc;
  78     private String endpointOpenstack;
  79     private String endpointBpmn;
  80     private String endpointAsdc;
  81     private String endpointRequestdbAttsvc;
  82
  83     @Autowired
  84     private Environment env;
  85
  86     @Autowired
  87     private RestTemplate restTemplate;
  88     private final String health = "/health";
  89
  90
  91     @PostConstruct
  92     protected void init() {
  93         actuatorContextPath = env.getProperty(CONTEXTPATH_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
  94         endpointCatalogdb = env.getProperty(CATALOGDB_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
  95         endpointRequestdb = env.getProperty(REQUESTDB_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
  96         endpointSdnc = env.getProperty(SDNC_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
  97         endpointOpenstack = env.getProperty(OPENSTACK_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
  98         endpointBpmn = env.getProperty(BPMN_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
  99         endpointAsdc = env.getProperty(ASDC_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
 100         endpointRequestdbAttsvc = env.getProperty(REQUESTDBATTSVC_PROPERTY, String.class, DEFAULT_PROPERTY_VALUE);
 101     }
 102
 103     @GET
 104     @Produces("application/json")
 105     @ApiOperation(value = "Performing global health check", response = Response.class)
 106     @Transactional
 107     public Response globalHealthcheck(@DefaultValue("true") @QueryParam("enableBpmn") boolean enableBpmn,
 108             @Context ContainerRequestContext requestContext) {
 109         Response HEALTH_CHECK_RESPONSE = null;
 110         // Build internal response object
 111         HealthcheckResponse rsp = new HealthcheckResponse();
 112
 113         try {
 114             // Generated RequestId
 115             String requestId = requestContext.getProperty("requestId").toString();
 116             logger.info(LoggingAnchor.TWO, MessageEnum.APIH_GENERATED_REQUEST_ID.toString(), requestId);
 117
 118             // set APIH status, this is the main entry point
 119             rsp.setApih(HealthcheckStatus.UP.toString());
 120             // set BPMN
 121             rsp.setBpmn(querySubsystemHealth(MsoSubsystems.BPMN));
 122             // set SDNCAdapter
 123             rsp.setSdncAdapter(querySubsystemHealth(MsoSubsystems.SDNC));
 124             // set ASDCController
 125             rsp.setAsdcController(querySubsystemHealth(MsoSubsystems.ASDC));
 126             // set CatalogDbAdapter
 127             rsp.setCatalogdbAdapter(querySubsystemHealth(MsoSubsystems.CATALOGDB));
 128             // set RequestDbAdapter
 129             rsp.setRequestdbAdapter(querySubsystemHealth(MsoSubsystems.REQUESTDB));
 130             // set OpenStackAdapter
 131             rsp.setOpenstackAdapter(querySubsystemHealth(MsoSubsystems.OPENSTACK));
 132             // set RequestDbAdapterAttSvc
 133             rsp.setRequestdbAdapterAttsvc(querySubsystemHealth(MsoSubsystems.REQUESTDBATT));
 134             // set Message
 135             rsp.setMessage(String.format("HttpStatus: %s", HttpStatus.SC_OK));
 136             logger.info(rsp.toString());
 137
 138             HEALTH_CHECK_RESPONSE = Response.status(HttpStatus.SC_OK).entity(rsp).build();
 139
 140         } catch (Exception ex) {
 141             logger.error("Exception occurred", ex);
 142             rsp.setMessage(ex.getMessage());
 143             HEALTH_CHECK_RESPONSE = Response.status(HttpStatus.SC_INTERNAL_SERVER_ERROR).entity(rsp).build();
 144         }
 145
 146         return HEALTH_CHECK_RESPONSE;
 147     }
 148
 149     protected HttpEntity<String> buildHttpEntityForRequest() {
 150         HttpHeaders headers = new HttpHeaders();
 151         headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));
 152         headers.set("Content-Type", "application/json");
 153         HttpEntity<String> entity = new HttpEntity<>("parameters", headers);
 154         return entity;
 155     }
 156
 157     protected String querySubsystemHealth(MsoSubsystems subsystem) {
 158         try {
 159             // get port number for the subsystem
 160             String ept = getEndpointUrlForSubsystemEnum(subsystem);
 161
 162             // build final endpoint url
 163             UriBuilder builder = UriBuilder.fromPath(ept).path(actuatorContextPath).path(health);
 164             URI uri = builder.build();
 165             logger.info("Calculated URL: {}", uri.toString());
 166
 167             ResponseEntity<SubsystemHealthcheckResponse> result = restTemplate.exchange(uri, HttpMethod.GET,
 168                     buildHttpEntityForRequest(), SubsystemHealthcheckResponse.class);
 169
 170             return processResponseFromSubsystem(result, subsystem);
 171
 172         } catch (Exception ex) {
 173             logger.error("Exception occured in GlobalHealthcheckHandler.querySubsystemHealth() ", ex);
 174             return HealthcheckStatus.DOWN.toString();
 175         }
 176     }
 177
 178     protected String processResponseFromSubsystem(ResponseEntity<SubsystemHealthcheckResponse> result,
 179             MsoSubsystems subsystem) {
 180         if (result == null || result.getStatusCodeValue() != HttpStatus.SC_OK) {
 181             logger.error(String.format("Globalhealthcheck: checking subsystem: %s failed ! result object is: %s",
 182                     subsystem, result == null ? "NULL" : result));
 183             return HealthcheckStatus.DOWN.toString();
 184         }
 185
 186         SubsystemHealthcheckResponse body = result.getBody();
 187
 188         String status = body.getStatus();
 189         if ("UP".equalsIgnoreCase(status)) {
 190             return HealthcheckStatus.UP.toString();
 191         } else {
 192             logger.error("{}, query health endpoint did not return UP status!", subsystem);
 193             return HealthcheckStatus.DOWN.toString();
 194         }
 195     }
 196
 197
 198     protected String getEndpointUrlForSubsystemEnum(MsoSubsystems subsystem) {
 199         switch (subsystem) {
 200             case SDNC:
 201                 return this.endpointSdnc;
 202             case ASDC:
 203                 return this.endpointAsdc;
 204             case BPMN:
 205                 return this.endpointBpmn;
 206             case CATALOGDB:
 207                 return this.endpointCatalogdb;
 208             case OPENSTACK:
 209                 return this.endpointOpenstack;
 210             case REQUESTDB:
 211                 return this.endpointRequestdb;
 212             case REQUESTDBATT:
 213                 return this.endpointRequestdbAttsvc;
 214             default:
 215                 return "";
 216         }
 217     }
 218 }