Vert.x Warp10 Metrics

Sensision / Warp10 implementation of the Vert.x Metrics SPI

License	The Apache Software License, Version 2.0
Categories	Metrics Application Testing & Monitoring Monitoring
GroupId	io.github.fyro-ing
ArtifactId	vertx-warp10-metrics
Last Version	0.0.1
Release Date	May 8, 2021
Type	jar
Description	Vert.x Warp10 Metrics Sensision / Warp10 implementation of the Vert.x Metrics SPI
Project URL	https://github.com/Fyro-Ing/vertx-warp10-metrics
Project Organization	Eclipse
Source Code Management	https://github.com/Fyro-Ing/vertx-warp10-metrics

Download vertx-warp10-metrics

Filename	Size
vertx-warp10-metrics-0.0.1.pom
vertx-warp10-metrics-0.0.1.jar	30 KB
vertx-warp10-metrics-0.0.1-tests.jar	2 KB
vertx-warp10-metrics-0.0.1-sources.jar	38 KB
vertx-warp10-metrics-0.0.1-javadoc.jar	101 KB
vertx-warp10-metrics-0.0.1-docs.zip	4 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.fyro-ing/vertx-warp10-metrics/ -->
<dependency>
    <groupId>io.github.fyro-ing</groupId>
    <artifactId>vertx-warp10-metrics</artifactId>
    <version>0.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.fyro-ing/vertx-warp10-metrics/
implementation 'io.github.fyro-ing:vertx-warp10-metrics:0.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.fyro-ing/vertx-warp10-metrics/
implementation ("io.github.fyro-ing:vertx-warp10-metrics:0.0.1")

Apache Buildr

'io.github.fyro-ing:vertx-warp10-metrics:jar:0.0.1'

Apache Ivy

<dependency org="io.github.fyro-ing" name="vertx-warp10-metrics" rev="0.0.1">
  <artifact name="vertx-warp10-metrics" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.fyro-ing', module='vertx-warp10-metrics', version='0.0.1')
)

Scala SBT

libraryDependencies += "io.github.fyro-ing" % "vertx-warp10-metrics" % "0.0.1"

Leiningen

[io.github.fyro-ing/vertx-warp10-metrics "0.0.1"]

Dependencies

compile (7)

Group / Artifact	Type	Version
io.vertx : vertx-core	jar
io.vertx : vertx-codetrans Optional	jar
io.vertx : vertx-lang-groovy Optional	jar
io.vertx : vertx-lang-ruby Optional	jar
io.vertx : vertx-lang-js Optional	jar
io.vertx : vertx-rx-java Optional	jar
io.warp10 : sensision	jar	1.0.24

provided (2)

Group / Artifact	Type	Version
io.vertx : vertx-codegen Optional	jar
io.vertx : vertx-docgen Optional	jar

test (4)

Group / Artifact	Type	Version
org.junit.jupiter : junit-jupiter-api	jar	5.7.1
io.vertx : vertx-junit5	jar
org.codehaus.groovy : groovy-all	pom	3.0.7
org.codehaus.groovy.modules.http-builder : http-builder	jar	0.7.1

Project Modules

There are no modules declared in this project.

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

Versions

Version
0.0.1 May 8, 2021