org.zapodot.hystrix.bundle

Class HystrixBundle<T extends Configuration>

java.lang.Object

org.zapodot.hystrix.bundle.HystrixBundle<T>

All Implemented Interfaces:

ConfiguredBundle<T>

public class HystrixBundle<T extends Configuration>
extends Object
implements ConfiguredBundle<T>

A DropWizard bundle that enables the Hystrix event stream to be registered, and the Hystrix metrics to be integrated with DropWizard's metrics

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HystrixBundle.Builder A builder that is convenient to use if you need to configure this bundle in any way

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_STREAM_PATH The default path that will be used for binding the HystrixMetricsStreamServlet to the admin context.
static String	SERVLET_NAME

Method Summary

Modifier and Type	Method and Description
static HystrixBundle.Builder	builder() Creates a new @{link Builder} that may be used to configure this bundle's behaviour.
protected boolean	canPublishHystrixMetrics(T configuration) Determines whether Hystrix metrics should be published as Dropwizard Metrics.
void	initialize(Bootstrap<?> bootstrap)
void	run(T configuration, Environment environment) Setup method for the ConfiguredBundle
static HystrixBundle	withDefaultSettings() Creates a bundle instance with default settings i.e the HystrixMetricsStreamServlet will be added to the admin context mapped by the @{link #DEFAULT_STREAM_PATH} path and the Hystrix to DropWizard metrics publisher is enabled

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STREAM_PATH

public static final String DEFAULT_STREAM_PATH

The default path that will be used for binding the HystrixMetricsStreamServlet to the admin context.

See Also:

Constant Field Values

SERVLET_NAME

public static final String SERVLET_NAME

See Also:

Constant Field Values

Method Detail

withDefaultSettings

public static HystrixBundle withDefaultSettings()

Creates a bundle instance with default settings i.e the HystrixMetricsStreamServlet will be added to the admin context mapped by the @{link #DEFAULT_STREAM_PATH} path and the Hystrix to DropWizard metrics publisher is enabled

Returns:

an HystrixBundle instance configured using default settings

builder

public static HystrixBundle.Builder builder()

Creates a new @{link Builder} that may be used to configure this bundle's behaviour.

Returns:

a new Builder

initialize

public void initialize(Bootstrap<?> bootstrap)

Specified by:

initialize in interface ConfiguredBundle<T extends Configuration>

canPublishHystrixMetrics

protected boolean canPublishHystrixMetrics(T configuration)

Determines whether Hystrix metrics should be published as Dropwizard Metrics. By default it follows what was set using the builder at initialization time. Override to use some other mechanism to decide. Returning true means metrics should be published.

Example:

  bootstrap.addBundle( new HystrixBundle() {
   
     protected boolean canPublishHystrixMetrics(MyAppConfiguration configuration) {
       return configuration.isEnableHystrixMetrics();
     }
  });
 

Parameters:

configuration - the current configuration as provided by DropWizard

Returns:

boolean which decides whether the metrics to be published or not

See Also:

HystrixBundle.Builder.disableMetricsPublisher()

run

public void run(T configuration,
                Environment environment)

Setup method for the ConfiguredBundle

Specified by:

run in interface ConfiguredBundle<T extends Configuration>

Parameters:

configuration - the configuration as provided by DropWizard

environment - the environment as provided by DropWizard

See Also:

ConfiguredBundle.run(Object, Environment)