Merge pull request Netflix#769 from mattrjacobs/add-threadpool-to-metrics-stream-output

Add threadpool to hystrix-metrics-event-stream for each command

Author: mattrjacobs

hystrix-contrib/hystrix-metrics-event-stream/src/main/java/com/netflix/hystrix/contrib/metrics/eventstream/HystrixMetricsPoller.java

@@ -186,6 +186,7 @@ private String getCommandJson(HystrixCommandMetrics commandMetrics) throws IOExc
             json.writeStringField("type", "HystrixCommand");
             json.writeStringField("name", key.name());
             json.writeStringField("group", commandMetrics.getCommandGroup().name());
+            json.writeStringField("threadPool", commandMetrics.getThreadPoolKey().name());
             json.writeNumberField("currentTime", System.currentTimeMillis());
 
             // circuit breaker

hystrix-contrib/hystrix-rx-netty-metrics-stream/src/test/java/com/netflix/hystrix/HystrixCommandMetricsSamples.java

@@ -42,6 +42,13 @@ public String name() {
         }
     }
 
+    private static class MyHystrixThreadPoolKey implements HystrixThreadPoolKey {
+        @Override
+        public String name() {
+            return "hystrixThreadPoolKey";
+        }
+    }
+
     private static class MyHystrixCommandProperties extends HystrixCommandProperties {
         protected MyHystrixCommandProperties(HystrixCommandKey key) {
             super(key);
@@ -50,7 +57,7 @@ protected MyHystrixCommandProperties(HystrixCommandKey key) {
 
     static {
         HystrixCommandKey key = new MyHystrixCommandKey();
-        SAMPLE_1 = new HystrixCommandMetrics(key, new MyHystrixCommandGroupKey(),
+        SAMPLE_1 = new HystrixCommandMetrics(key, new MyHystrixCommandGroupKey(), new MyHystrixThreadPoolKey(),
                 new MyHystrixCommandProperties(key), HystrixEventNotifierDefault.getInstance());
     }
 }

hystrix-core/src/main/java/com/netflix/hystrix/AbstractCommand.java

@@ -207,7 +207,7 @@ protected AbstractCommand(HystrixCommandGroupKey group, HystrixCommandKey key, H
          * Metrics initialization
          */
         if (metrics == null) {
-            this.metrics = HystrixCommandMetrics.getInstance(this.commandKey, this.commandGroup, this.properties);
+            this.metrics = HystrixCommandMetrics.getInstance(this.commandKey, this.commandGroup, this.threadPoolKey, this.properties);
         } else {
             this.metrics = metrics;
         }

hystrix-core/src/main/java/com/netflix/hystrix/HystrixCommandMetrics.java

@@ -57,13 +57,38 @@ public class HystrixCommandMetrics extends HystrixMetrics {
      * @return {@link HystrixCommandMetrics}
      */
     public static HystrixCommandMetrics getInstance(HystrixCommandKey key, HystrixCommandGroupKey commandGroup, HystrixCommandProperties properties) {
+        return getInstance(key, commandGroup, null, properties);
+    }
+
+    /**
+     * Get or create the {@link HystrixCommandMetrics} instance for a given {@link HystrixCommandKey}.
+     * <p>
+     * This is thread-safe and ensures only 1 {@link HystrixCommandMetrics} per {@link HystrixCommandKey}.
+     *
+     * @param key
+     *            {@link HystrixCommandKey} of {@link HystrixCommand} instance requesting the {@link HystrixCommandMetrics}
+     * @param commandGroup
+     *            Pass-thru to {@link HystrixCommandMetrics} instance on first time when constructed
+     * @param properties
+     *            Pass-thru to {@link HystrixCommandMetrics} instance on first time when constructed
+     * @return {@link HystrixCommandMetrics}
+     */
+    public static HystrixCommandMetrics getInstance(HystrixCommandKey key, HystrixCommandGroupKey commandGroup, HystrixThreadPoolKey threadPoolKey, HystrixCommandProperties properties) {
         // attempt to retrieve from cache first
         HystrixCommandMetrics commandMetrics = metrics.get(key.name());
         if (commandMetrics != null) {
             return commandMetrics;
         }
         // it doesn't exist so we need to create it
-        commandMetrics = new HystrixCommandMetrics(key, commandGroup, properties, HystrixPlugins.getInstance().getEventNotifier());
+
+        //now check to see if we need to create a synthetic threadPoolKey
+        HystrixThreadPoolKey nonNullThreadPoolKey;
+        if (threadPoolKey == null) {
+            nonNullThreadPoolKey = HystrixThreadPoolKey.Factory.asKey(commandGroup.name());
+        } else {
+            nonNullThreadPoolKey = threadPoolKey;
+        }
+        commandMetrics = new HystrixCommandMetrics(key, commandGroup, nonNullThreadPoolKey, properties, HystrixPlugins.getInstance().getEventNotifier());
         // attempt to store it (race other threads)
         HystrixCommandMetrics existing = metrics.putIfAbsent(key.name(), commandMetrics);
         if (existing == null) {
@@ -107,13 +132,15 @@ public static Collection<HystrixCommandMetrics> getInstances() {
     private final HystrixRollingPercentile percentileTotal;
     private final HystrixCommandKey key;
     private final HystrixCommandGroupKey group;
+    private final HystrixThreadPoolKey threadPoolKey;
     private final AtomicInteger concurrentExecutionCount = new AtomicInteger();
     private final HystrixEventNotifier eventNotifier;
 
-    /* package */HystrixCommandMetrics(HystrixCommandKey key, HystrixCommandGroupKey commandGroup, HystrixCommandProperties properties, HystrixEventNotifier eventNotifier) {
+    /* package */HystrixCommandMetrics(HystrixCommandKey key, HystrixCommandGroupKey commandGroup, HystrixThreadPoolKey threadPoolKey, HystrixCommandProperties properties, HystrixEventNotifier eventNotifier) {
         super(new HystrixRollingNumber(properties.metricsRollingStatisticalWindowInMilliseconds(), properties.metricsRollingStatisticalWindowBuckets()));
         this.key = key;
         this.group = commandGroup;
+        this.threadPoolKey = threadPoolKey;
         this.properties = properties;
         this.percentileExecution = new HystrixRollingPercentile(properties.metricsRollingPercentileWindowInMilliseconds(), properties.metricsRollingPercentileWindowBuckets(), properties.metricsRollingPercentileBucketSize(), properties.metricsRollingPercentileEnabled());
         this.percentileTotal = new HystrixRollingPercentile(properties.metricsRollingPercentileWindowInMilliseconds(), properties.metricsRollingPercentileWindowBuckets(), properties.metricsRollingPercentileBucketSize(), properties.metricsRollingPercentileEnabled());
@@ -131,13 +158,23 @@ public HystrixCommandKey getCommandKey() {
 
     /**
      * {@link HystrixCommandGroupKey} of the {@link HystrixCommand} these metrics represent.
-     * 
+     *
      * @return HystrixCommandGroupKey
      */
     public HystrixCommandGroupKey getCommandGroup() {
         return group;
     }
 
+    /**
+     * {@link HystrixThreadPoolKey} used by {@link HystrixCommand} these metrics represent.
+     *
+     * @return HystrixThreadPoolKey
+     */
+    public HystrixThreadPoolKey getThreadPoolKey() {
+        return threadPoolKey;
+    }
+
+
     /**
      * {@link HystrixCommandProperties} of the {@link HystrixCommand} these metrics represent.
      * 

hystrix-core/src/test/java/com/netflix/hystrix/HystrixCircuitBreakerTest.java

@@ -494,7 +494,7 @@ public void testLowVolumeDoesNotTripCircuit() {
      * Utility method for creating {@link HystrixCommandMetrics} for unit tests.
      */
     private static HystrixCommandMetrics getMetrics(HystrixCommandProperties.Setter properties) {
-        return new HystrixCommandMetrics(CommandKeyForUnitTest.KEY_ONE, CommandOwnerForUnitTest.OWNER_ONE, HystrixCommandPropertiesTest.asMock(properties), HystrixEventNotifierDefault.getInstance());
+        return new HystrixCommandMetrics(CommandKeyForUnitTest.KEY_ONE, CommandOwnerForUnitTest.OWNER_ONE, ThreadPoolKeyForUnitTest.THREAD_POOL_ONE, HystrixCommandPropertiesTest.asMock(properties), HystrixEventNotifierDefault.getInstance());
     }
 
     /**

hystrix-core/src/test/java/com/netflix/hystrix/HystrixCommandMetricsTest.java

@@ -129,7 +129,7 @@ protected Boolean getFallback() {
      * Utility method for creating {@link HystrixCommandMetrics} for unit tests.
      */
     private static HystrixCommandMetrics getMetrics(HystrixCommandProperties.Setter properties) {
-        return new HystrixCommandMetrics(InspectableBuilder.CommandKeyForUnitTest.KEY_ONE, InspectableBuilder.CommandGroupForUnitTest.OWNER_ONE, HystrixCommandPropertiesTest.asMock(properties), HystrixEventNotifierDefault.getInstance());
+        return new HystrixCommandMetrics(InspectableBuilder.CommandKeyForUnitTest.KEY_ONE, InspectableBuilder.CommandGroupForUnitTest.OWNER_ONE, InspectableBuilder.ThreadPoolKeyForUnitTest.THREAD_POOL_ONE, HystrixCommandPropertiesTest.asMock(properties), HystrixEventNotifierDefault.getInstance());
     }
 
 }