Feat: Enable hystrix metrics stream for core APIML services (#1899)

* Enable hystrix stream for api catalog

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Remove hystrix dashboard from ac

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Enable hystrix metrics for caching service

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Enable hystrix metrics for gateway

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Enable hystrix metrics for discovery service

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Add flag to enable access to hystrix stream

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Remove unused imports

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Add HystrixCommand to missed controllers

Signed-off-by: Carson Cook <carson.cook@ibm.com>

Author: CarsonCook

api-catalog-services/build.gradle

@@ -64,6 +64,7 @@ dependencies {
     implementation libraries.spring_boot_starter_actuator
     implementation libraries.spring_boot_configuration_processor
     implementation libraries.spring_cloud_starter_eureka
+    implementation libraries.spring_cloud_starter_hystrix
     implementation libraries.spring_retry
     implementation libraries.swagger_core
     implementation libraries.swagger3_core

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/ApiCatalogApplication.java

@@ -11,8 +11,8 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
 import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
-import org.springframework.cloud.netflix.hystrix.HystrixAutoConfiguration;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.retry.annotation.EnableRetry;
 import org.springframework.scheduling.annotation.EnableAsync;
@@ -21,7 +21,7 @@
 import org.zowe.apiml.product.monitoring.LatencyUtilsConfigInitializer;
 import org.zowe.apiml.product.version.BuildInfo;
 
-@SpringBootApplication(exclude = HystrixAutoConfiguration.class)
+@SpringBootApplication
 @EnableEurekaClient
 @ComponentScan(value = {
     "org.zowe.apiml.apicatalog",
@@ -33,6 +33,7 @@
 @EnableRetry
 @EnableAsync
 @EnableApimlLogger
+@EnableCircuitBreaker
 public class ApiCatalogApplication {
 
     public static void main(String[] args) {

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/controllers/api/ApiCatalogController.java

@@ -9,6 +9,7 @@
  */
 package org.zowe.apiml.apicatalog.controllers.api;
 
+import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.Authorization;
@@ -75,6 +76,7 @@ public ApiCatalogController(CachedProductFamilyService cachedProductFamilyServic
             @Authorization("LoginBasicAuth"), @Authorization("CookieAuth")
         }
     )
+    @HystrixCommand
     public ResponseEntity<List<APIContainer>> getAllAPIContainers() throws ContainerStatusRetrievalThrowable {
         try {
             Iterable<APIContainer> allContainers = cachedProductFamilyService.getAllContainers();
@@ -104,6 +106,7 @@ public ResponseEntity<List<APIContainer>> getAllAPIContainers() throws Container
             @Authorization("LoginBasicAuth"), @Authorization("CookieAuth")
         }
     )
+    @HystrixCommand
     public ResponseEntity<List<APIContainer>> getAPIContainerById(@PathVariable(value = "id") String id) throws ContainerStatusRetrievalThrowable {
         try {
             List<APIContainer> apiContainers = new ArrayList<>();

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/controllers/api/CatalogApiDocController.java

@@ -9,6 +9,7 @@
  */
 package org.zowe.apiml.apicatalog.controllers.api;
 
+import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
 import org.zowe.apiml.apicatalog.services.status.APIServiceStatusService;
 import io.swagger.annotations.*;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -63,6 +64,7 @@ public CatalogApiDocController(APIServiceStatusService apiServiceStatusService)
         @ApiResponse(code = 404, message = "URI not found"),
         @ApiResponse(code = 500, message = "An unexpected condition occurred"),
     })
+    @HystrixCommand
     public ResponseEntity<String> getApiDocInfo(
         @ApiParam(name = "serviceId", value = "The unique identifier of the registered service", required = true, example = "apicatalog")
         @PathVariable(value = "serviceId") String serviceId,
@@ -89,6 +91,7 @@ public ResponseEntity<String> getApiDocInfo(
         @ApiResponse(code = 404, message = "URI not found"),
         @ApiResponse(code = 500, message = "An unexpected condition occurred"),
     })
+    @HystrixCommand
     public ResponseEntity<String> getApiDiff(
         @ApiParam(name = "serviceId", value = "The unique identifier of the registered service", required = true, example = "apicatalog")
         @PathVariable(value = "serviceId") String serviceId,

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/controllers/handlers/NotFoundErrorController.java

@@ -9,6 +9,7 @@
  */
 package org.zowe.apiml.apicatalog.controllers.handlers;
 
+import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
 import org.springframework.boot.web.servlet.error.ErrorController;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;
@@ -32,6 +33,7 @@ public class NotFoundErrorController implements ErrorController {
 
 
     @GetMapping(value = "/not_found")
+    @HystrixCommand
     public String handleError(HttpServletRequest request) {
         Object status = request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
 

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/security/SecurityConfiguration.java

@@ -72,6 +72,9 @@ public class SecurityConfiguration {
     @Value("${server.attls.enabled:false}")
     private boolean isAttlsEnabled;
 
+    @Value("${apiml.metrics.enabled:false}")
+    private boolean isMetricsEnabled;
+
     /**
      * Filter chain for protecting /apidoc/** endpoints with MF credentials for client certificate.
      */
@@ -164,8 +167,15 @@ protected void configure(HttpSecurity http) throws Exception {
                 .antMatchers("/static-api/**").authenticated()
                 .antMatchers("/containers/**").authenticated()
                 .antMatchers(APIDOC_ROUTES).authenticated()
-                .antMatchers("/application/health", "/application/info").permitAll()
-                .antMatchers("/application/**").authenticated();
+                .antMatchers("/application/health", "/application/info").permitAll();
+
+            if (isMetricsEnabled) {
+                http.authorizeRequests().antMatchers("/application/hystrix.stream").permitAll();
+            }
+
+
+            http.authorizeRequests().antMatchers("/application/**").authenticated();
+
             if (isAttlsEnabled) {
                 http.addFilterBefore(new SecureConnectionFilter(), BasicContentFilter.class);
             }

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/staticapi/StaticAPIRefreshController.java

@@ -9,6 +9,7 @@
  */
 package org.zowe.apiml.apicatalog.staticapi;
 
+import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
@@ -24,6 +25,7 @@ public class StaticAPIRefreshController {
     private final StaticAPIService staticAPIService;
 
     @PostMapping(value = "/refresh", produces = MediaType.APPLICATION_JSON_VALUE)
+    @HystrixCommand
     public ResponseEntity<String> refreshStaticApis() {
         StaticAPIResponse staticAPIResponse = staticAPIService.refresh();
         return ResponseEntity

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/staticapi/StaticDefinitionController.java

@@ -10,6 +10,7 @@
 
 package org.zowe.apiml.apicatalog.staticapi;
 
+import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
@@ -36,6 +37,7 @@ public class StaticDefinitionController {
      * @return the response entity
      */
     @PostMapping(value = "/generate", produces = MediaType.APPLICATION_JSON_VALUE)
+    @HystrixCommand
     public ResponseEntity<String> generateStaticDef(@RequestBody String payload, @RequestHeader(value = "Service-Id") String serviceId) throws IOException {
         StaticAPIResponse staticAPIResponse = staticDefinitionGenerator.generateFile(payload, serviceId);
         return ResponseEntity
@@ -50,6 +52,7 @@ public ResponseEntity<String> generateStaticDef(@RequestBody String payload, @Re
      * @return the response entity
      */
     @PostMapping(value = "/override", produces = MediaType.APPLICATION_JSON_VALUE)
+    @HystrixCommand
     public ResponseEntity<String> overrideStaticDef(@RequestBody String payload, @RequestHeader(value = "Service-Id") String serviceId) throws IOException {
         StaticAPIResponse staticAPIResponse = staticDefinitionGenerator.overrideFile(payload, serviceId);
         return ResponseEntity
@@ -59,6 +62,7 @@ public ResponseEntity<String> overrideStaticDef(@RequestBody String payload, @Re
 
 
     @DeleteMapping(value = "/delete", produces = MediaType.APPLICATION_JSON_VALUE)
+    @HystrixCommand
     public ResponseEntity<String> deleteStaticDef(@RequestHeader(value = "Service-Id") String serviceId) throws IOException {
         StaticAPIResponse staticAPIResponse = staticDefinitionGenerator.deleteFile(serviceId);
         return ResponseEntity.status(staticAPIResponse.getStatusCode()).body(staticAPIResponse.getBody());

api-catalog-services/src/main/resources/application.yml

@@ -157,7 +157,7 @@ management:
         web:
             base-path: /application
             exposure:
-                include: health,info
+                include: health,info,hystrix.stream
     health:
         defaults:
             enabled: false
@@ -175,7 +175,7 @@ management:
         web:
             base-path: /application
             exposure:
-                include: health,info,loggers
+                include: health,info,loggers,hystrix.stream
 
 logging:
     level:

caching-service/build.gradle

@@ -61,6 +61,7 @@ dependencies {
     implementation libraries.spring_boot_starter_actuator
     implementation libraries.spring_retry
     implementation libraries.spring_boot_starter_aop
+    implementation libraries.spring_cloud_starter_hystrix
     implementation libraries.lettuce
     implementation libraries.spring_security_web
     implementation libraries.spring_security_config