com.netflix.hystrix.strategy.metrics
Class HystrixMetricsPublisher

java.lang.Object
  com.netflix.hystrix.strategy.metrics.HystrixMetricsPublisher

public abstract class HystrixMetricsPublisher
extends java.lang.Object

Abstract class with default implementations of Factory methods for creating "Metrics Publisher" instances for getting metrics and other related data exposed, published or otherwise retrievable by external systems such as Servo (https://github.com/Netflix/servo) for monitoring and statistical purposes.

Custom implementations of this interface can be used to override default behavior via 2 mechanisms:

1) Injection

Implementations can be injected into HystrixCommand and HystrixCollapser implementation constructors.

2) Plugin

Using HystrixPlugins.registerMetricsPublisher(com.netflix.hystrix.strategy.metrics.HystrixMetricsPublisher) an implementation can be registered globally to take precedence and override all other implementations.

The order of precedence is:

1. plugin registered globally using HystrixPlugins.registerMetricsPublisher(com.netflix.hystrix.strategy.metrics.HystrixMetricsPublisher)
2. injected via HystrixCommand and HystrixCollapser constructors
3. default implementation HystrixMetricsPublisherDefault

The injection approach is effective for HystrixCommand and HystrixCollapser implementations where you wish to have a different default mechanism for publishing metrics without overriding all implementations. It is also useful when distributing a library where static override should not be used.

The globally registered plugin is useful when using commands from 3rd party libraries and you want to override how properties are defined for all implementations in your entire system.

Constructor Summary

HystrixMetricsPublisher()

Method Summary

HystrixMetricsPublisherCommand	getMetricsPublisherForCommand(HystrixCommandKey commandKey, HystrixCommandGroupKey commandGroupKey, HystrixCommandMetrics metrics, HystrixCircuitBreaker circuitBreaker, HystrixCommandProperties properties) Construct an implementation of HystrixMetricsPublisherCommand for HystrixCommand instances having key HystrixCommandKey.
HystrixMetricsPublisherThreadPool	getMetricsPublisherForThreadPool(HystrixThreadPoolKey threadPoolKey, HystrixThreadPoolMetrics metrics, HystrixThreadPoolProperties properties) Construct an implementation of HystrixMetricsPublisherThreadPool for HystrixThreadPool instances having key HystrixThreadPoolKey.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HystrixMetricsPublisher

public HystrixMetricsPublisher()

Method Detail

getMetricsPublisherForCommand

public HystrixMetricsPublisherCommand getMetricsPublisherForCommand(HystrixCommandKey commandKey,
                                                                    HystrixCommandGroupKey commandGroupKey,
                                                                    HystrixCommandMetrics metrics,
                                                                    HystrixCircuitBreaker circuitBreaker,
                                                                    HystrixCommandProperties properties)

Construct an implementation of HystrixMetricsPublisherCommand for HystrixCommand instances having key HystrixCommandKey.

This will be invoked once per HystrixCommandKey instance.

Default Implementation

Return instance of HystrixMetricsPublisherCommandDefault

Parameters:

commandKey - HystrixCommandKey representing the name or type of HystrixCommand

commandGroupKey - HystrixCommandGroupKey of HystrixCommand

metrics - HystrixCommandMetrics instance tracking metrics for HystrixCommand instances having the key as defined by HystrixCommandKey

circuitBreaker - HystrixCircuitBreaker instance for HystrixCommand instances having the key as defined by HystrixCommandKey

properties - HystrixCommandProperties instance for HystrixCommand instances having the key as defined by HystrixCommandKey

Returns:

instance of HystrixMetricsPublisherCommand that will have its initialize method invoked once.

getMetricsPublisherForThreadPool

public HystrixMetricsPublisherThreadPool getMetricsPublisherForThreadPool(HystrixThreadPoolKey threadPoolKey,
                                                                          HystrixThreadPoolMetrics metrics,
                                                                          HystrixThreadPoolProperties properties)

Construct an implementation of HystrixMetricsPublisherThreadPool for HystrixThreadPool instances having key HystrixThreadPoolKey.

This will be invoked once per HystrixThreadPoolKey instance.

Default Implementation

Return instance of HystrixMetricsPublisherThreadPoolDefault

Parameters:

threadPoolKey - HystrixThreadPoolKey representing the name or type of HystrixThreadPool

metrics - HystrixThreadPoolMetrics instance tracking metrics for the HystrixThreadPool instance having the key as defined by HystrixThreadPoolKey

properties - HystrixThreadPoolProperties instance for the HystrixThreadPool instance having the key as defined by HystrixThreadPoolKey

Returns:

instance of HystrixMetricsPublisherThreadPool that will have its initialize method invoked once.