org.zapodot:hystrix-dropwizard-bundle

hystrix-dropwizard-bundle

A Hystrix bundle for DropWizard which adds a Hystrix event stream to the admin context and enables Metrics reporting of Hystrix metrics

Licence

This library is released under an Apache Licence (V2).

Why do I need it?

• You use both DropWizard and Hystrix in your project (or are planning to..) and want your application's Hystrix metrix available in a Hystrix Dashboard (either directly or via Turbine)
• It is easy to set up as it really requires you to add only a single line of code in your application (see example below)

Alternatives

• If you want a even tighter integration between Hystrix and DropWizard, you should have a look at Yammer's Tenacity project. Note: Tenacity implies (but does not require) that you are using Breakerbox for managing your Hystrix runtime configuration.

Usage

This library is distributed through the Sonatype OSS Repo and should thus be widely available.

Add dependency

Maven

<dependency>
    <groupId>org.zapodot</groupId>
    <artifactId>hystrix-dropwizard-bundle</artifactId>
    <version>1.0.1</version>
</dependency>

SBT

libraryDependencies += "org.zapodot" % "hystrix-dropwizard-bundle" % "1.0.1"

Add bundle to your application

    @Override
    public void initialize(final Bootstrap<AppConfiguration> bootstrap) {
        ...
        bootstrap.addBundle(HystrixBundle.withDefaultSettings());
        ...
    }

This will initialize the bundle using default settings which means that:

• a HystrixMetricsStreamServlet is added to the admin context of your application with servlet mapping /hystrix.stream
• the HystrixCodaHaleMetricsPublisher is registered for Hystrix which will push all Hystrix metrics to DropWizard (previously: CodaHale) Metrics

If you need some other configuration, use the provided Builder (see example below)

    @Override
    public void initialize(final Bootstrap<AppConfiguration> bootstrap) {
        ...
        bootstrap.addBundle(HystrixBundle.builder()
                                            .withApplicationStreamPath("/my-path")
                                            .disableStreamServletInAdminContext()
                                            .disableMetricsPublisher()
                                            .build()
                                            );
        ...
    }

Overriding publishing settings

Starting with version 0.9, you may now implement your own mechanism for specifying whether Hystrix Metrics should be published to DropWizard Metrics by adding your own lambda expression to the withMetricsPublisherPredicate builder method

    HystrixBundle.builder()
                .withMetricsPublisherPredicate((c) -> true) // c is your application configuration POJO
                .build();

Note: The now defunct version 0.8 implemented another approach which included overriding a method on Hystrix bundle. Putting this on the builder allows us to keep the specialized constructor private which provides us with more flexibility in the future.