Hawkular Metrics, a storage engine for metric data
Hawkular Metrics is the metric data store for the Hawkular project. It can also be used independently.
It relies on Apache Cassandra as a backend and is comprised of:
a core library
a REST/HTTP interface
|Cassandra 3.7 or later is required. It is recommended to use the latest 3.7.x release if possible.|
The core library
A Java library, built with RxJava on top of the Cassandra Java driver.
This is for advanced users only, if you want to embed the core functionnality in another product.
Simple, easy to use REST interface
The REST API should be easy to use. Users should be able to send
data with the simplest tools: shell scripts and
Getting started with a release build
Download a Wildfly 10 archive and expand it somewhere on your disk.
Check out the Metrics releases page and download the latest
version of the web application archive:
Copy this file to the
standalone/deployments directory of the Wildfly server.
Start the server with
By default, Metrics will try to connect to a Cassandra on localhost. If you want to start a Cassandra server
embedded into Wildfly for testing, add the
hawkular-metrics-embedded-cassandra-ear-X.Y.Z.ear archive to the
|A running Cassandra cluster, which can be a single node, is required for unit and integration tests.|
git clone email@example.com:hawkular/hawkular-metrics.git cd hawkular-metrics mvn install
If you only want to build the sources without a running C* cluster, you can run
Setting up Cassandra for development or testing
For development or testing, the easiest way to setup Cassandra is to use the Cassandra Cluster Manager, CCM.
ccm create -v 3.7 hawkular ccm populate -n 1 ccm start
These steps build and start a single node cluster of Cassandra. Note that while it is recommended to use ccm, it is not necessary. You just need to make sure you have a running 3.7.x cluster.
Working with monitoring tools
You can send data collected with your usual monitoring tools to Hawkular Metrics:
In order to do so, you must start our network protocol adapter, ptrans.
Contributing & Community
We love contributions and pull-requests :-)
To meet the guys, join us on Freenode IRC in channel #hawkular. If you can not use the irc protocol, you can also use a web to irc gateway like Web chat on Freenode.
Hawkular-Metrics is @hawkular_org on Twitter.