README.adoc

vertx-warp10-metrics

About

Warp10 is an open source platform for time series analysis.

The Vert.x Metrics SPI allows implementers to capture events from Vert.x in order to gather metrics.

This project is an implementation of the Vert.x Metrics SPI. Metrics built from Vert.x events will sent to a Warp10 platform throw Sensision agent

Quickstart

Follow the instructions to get Warp10 up and running.

Ten clone this project and build it:

git clone https://github.com/slambour/vertx-warp10-metrics.git
cd vertx-warp10-metrics
 mvn clean install

Once the project is built, add the dependency to your Vert.x 3 project. For Maven based projects:

<parent>
 <groupId>io.vertx</groupId>
 <artifactId>vertx-warp10-metrics</artifactId>
 <version>3.3.0-SNAPSHOT</version>
</parent>

Then, you must enable Vert.x Metrics programmatically:

VertxWarp10Options vertxWarp10Options = new VertxWarp10Options();
vertxWarp10Options.setEnabled(true); // By default Vert.x Metrics is disabled

VertxOptions vertxOptions = new VertxOptions();
vertxOptions.setMetricsOptions(vertxWarp10Options);

Vertx vertx = Vertx.vertx(vertxOptions);

or via with system properties:

-Dvertx.metrics.options.enabled=true

Configuration

If you are running with Warp10 docker image, Sensision agent have to write metrics inside the data folder configured by volume mapping. All Sensision configuration works with system properties

-Dsensision.home=/var/warp10/sensision/data
-Dsensision.events.dir=/var/warp10/sensision/data/metrics
-Dsensision.dump.period=60000
-Dsensision.dump.currentts=true
-Dsensision.dump.onexit=true

Documentation

Asciidoc documentation is generated by the build in src/main/asciidoc folder. With:

1. Getting started sections

2. All metrics available

3. Access to your metrics with WarpScript

License

Source available under the terms of Apache License v2.0.

The Apache License v2.0 is available at: http://www.opensource.org/licenses/apache2.0.php