Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 2.34 KB

README.md

File metadata and controls

70 lines (46 loc) · 2.34 KB
Raw

Dropwizard Metrics UI

Build Status Maven Central License

Dropwizard Metrics UI is a Dropwizard Bundle that exposes the registered Dropwizard Metrics and displays its core metrics in a dashboard.

Usage

Just add the following dependency to your pom.xml:

<dependency>
    <groupId>org.marmelo.dropwizard</groupId>
    <artifactId>dropwizard-metrics-ui</artifactId>
    <version>1.0</version>
</dependency>

And then register the MetricsUIBundle to your Dropwizard application inside the Application#initialize method:

@Override
public void initialize(Bootstrap<HelloWorldConfiguration> bootstrap) {
    bootstrap.addBundle(new MetricsUIBundle());
}

By default it will be available through the administrative environment at http://localhost:8081/admin/.

Advanced Usage

The Dropwizard Metrics UI leverages the already available Dropwizard Metrics REST endpoints and can only be deployed together in the same environment (usually the administrative environment).

You may override the default /admin path through the MetricsUIBundle constructor:

@Override
public void initialize(Bootstrap<HelloWorldConfiguration> bootstrap) {
    bootstrap.addBundle(new MetricsUIBundle("/dashboard/*"));
}

If you want full customization power you may register the underlying MetricsUIServlet servlet manually:

@Override
public void run(Environment environment) {
    environment.admin()
            .addServlet("Dropwizard Metrics UI", new MetricsUIServlet())
            .addMapping("/admin/*");
}

Support

Please file bug reports and feature requests in GitHub issues.

License

Copyright (c) 2018 Rafael Marmelo

This library is licensed under the MIT License.