VMware has ended active development of this project, this repository will no longer be updated.
The Wavefront by VMware Dropwizard SDK provides out of the box metrics for your Dropwizard application. You can analyze the data in Wavefront to better understand how your application is performing in production.
If you are using Maven, add the following maven dependency to your pom.xml:
<dependency>
<groupId>com.wavefront</groupId>
<artifactId>wavefront-dropwizard-sdk-java</artifactId>
<version>$releaseVersion</version>
</dependency>
Replace $releaseVersion
with the latest version available on maven.
This SDK provides a WavefrontDropwizardReporter
for collecting metrics about your Dropwizard application.
To create a WavefrontDropwizardReporter
:
- Create an
ApplicationTags
instance, which specifies metadata metadata about your application. - Create a
WavefrontSender
for sending data to Wavefront. - Create a
WavefrontDropwizardReporter
instance.
For the details of each step, see the sections below.
The application tags determine the metadata (point tags) that are included with the Dropwizard metrics reported to Wavefront. These tags enable you to filter and query the reported Dropwizard metrics in Wavefront.
You encapsulate application tags in an ApplicationTags
object.
See Instantiating ApplicationTags for details.
A WavefrontSender
object implements the low-level interface for sending data to Wavefront. You can choose to send data using either the Wavefront proxy or direct ingestion.
-
If you have already set up a
WavefrontSender
for another SDK that will run in the same JVM, use that one. (For details about sharing aWavefrontSender
instance, see Share a WavefrontSender.) -
Otherwise, follow the steps in Set Up a WavefrontSender.
A WavefrontDropwizardReporter
reports metrics to Wavefront.
To build a WavefrontDropwizardReporter
, you must specify:
- Dropwizard Environment
MetricRegistry
object. - An
ApplicationTags
object. - A
WavefrontSender
object.
You can optionally specify:
- A nondefault source for the reported data. If you omit the source, the host name is automatically used. The source should be identical across all the Wavefront SDKs running in the same JVM.
- A nondefault reporting interval, which controls how often data is reported to the
WavefrontSender
. The reporting interval determines the timestamps on the data sent to Wavefront. If you omit the reporting interval, data is reported once a minute.
ApplicationTags applicationTags = buildTags(); // pseudocode; see above
WavefrontSender wavefrontSender = buildWavefrontSender(); // pseudocode; see above
/**
* Every Dropwizard application has an `io.dropwizard.setup.Environment` instance.
* Grab the metric registry for your Dropwizard environment i.e. `io.dropwizard.setup.Environment.metrics()`
*/
MetricRegistry metricRegistry = environment.metrics();
// Create WavefrontDropwizardReporter.Builder using applicationTags
WavefrontDropwizardReporter.Builder wfDropwizardReporterBuilder = new WavefrontDropwizardReporter.Builder(metricRegistry, applicationTags);
// Optionally set the source name to "mySource" for your metrics and histograms.
// Omit this statement to use the host name.
wfDropwizardReporterBuilder.withSource("mySource");
// Optionally change the reporting interval to 30 seconds. Default is 1 minute.
wfDropwizardReporterBuilder.reportingIntervalSeconds(30);
// Create a WavefrontDropwizardReporter with the WavefronSender.
WavefrontDropwizardReporter wfDropwizardReporter = wfDropwizardReporterBuilder.build(wavefrontSender);
You start the WavefrontDropwizardReporter
explicitly to start reporting Dropwizard app metrics.
// Start the reporter
wfDropwizardReporter.start();
You must explicitly stop the WavefrontDropwizardReporter
before shutting down your JVM.
// Stop the reporter
wfDropwizardReporter.stop();
You can go to Wavefront and see the Dropwizard app metrics with the prefix dw.*
.