Time Series Metrics Engine based on Cassandra
Java Groovy XSLT Shell Scala HTML Other
Switch branches/tags
Clone or download
jsanda [HWKMETRICS-772] master branch (#984)
* [HWKMETRICS-772] re-enable tests

* [HWKMETRICS-772] fix failing tests
Latest commit e0308e9 Jun 28, 2018
Failed to load latest commit information.
.mvn Replace srcdeps-maven-plugin with srcdeps core extension Nov 30, 2016
ansible-build [HWKMETRICS-688] Docker Container Aug 31, 2017
api [HWKMETRICS-788] remove unused, dead code May 4, 2018
containers [HWKMETRICS-788] remove unused, dead code May 4, 2018
core [HWKMETRICS-772] master branch (#984) Jun 28, 2018
data-generator license headers Mar 27, 2018
dist bump versions Mar 27, 2018
integration-tests Merge pull request #963 from jsanda/hwkmetrics-788 May 4, 2018
job-scheduler [HWKMETRICS-783] Schema installer should not use git hash for schema … Apr 23, 2018
.gitignore UI More small fixes for the standalone metrics charting tag. Nov 18, 2014
.travis.diagnose.sh Always install C* under ${HOME}/cassandra on Travis Sep 21, 2015
.travis.install.cassandra.sh license header Apr 6, 2018
.travis.maven.settings.xml Attempt automatic publishing of snapshots via travis. Feb 13, 2015
.travis.swagger.sh Introduce mvnw - a way to ensure that devs and CI use the same Maven Nov 30, 2016
.travis.yml Set default JDK to openjdk8 Aug 16, 2017
CONTRIBUTING.adoc HWKMETRICS-274 Missing JBoss logging method on EAP6.4 Sep 28, 2015
LICENSE Initial commit Mar 13, 2014
README.adoc update getting started with release build section Apr 5, 2017
mvnw Introduce mvnw - a way to ensure that devs and CI use the same Maven Nov 30, 2016
mvnw.cmd Introduce mvnw - a way to ensure that devs and CI use the same Maven Nov 30, 2016
pom.xml [HWKMETRICS-788] remove unused, dead code May 4, 2018


Hawkular Metrics, a storage engine for metric data

Build Status
Coverity Scan Build Status (coverity_scan branch)


Hawkular Metrics is the metric data storage engine part of Hawkular community.

It relies on Apache Cassandra as a backend and is comprised of:

  • a core library

  • a REST/HTTP interface

Cassandra 3.0.12 or later is required.

The core library

A Java library, built with RxJava on top of the Cassandra Java driver.

This is for advanced users only, for embedding the core functionality in another project.

REST/HTTP interface

Most users will work with the web application. It exposes a REST/HTTP interface based on the core library. It is implemented with the JAX-RS 2 asynchronous API and runs on a Wildfly 10 server. The data format is JSON.


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 curl.

Getting started with a release build

There are a couple of options for running Hawkular Metrics:

  • WildFly distribution

  • EAR distribution

Earlier versions of Hawkular Metrics could be run by deploying hawkular-metrics-api-jaxrs-X.Y.Z.war. This is longer supported.

The WildFly distribution is a pre-configured WildFly 10 server that includes Hawkular Alerts in addition to Hawkular Metrics. Check out the Metrics releases page and download the latest version of hawkular-metrics-wildfly-standalone-X.Y.Z.Final.tar.gz.

The EAR distribution includes both Hawkular Metrics and Hawkular Alerts. Check out the Metrics releases page and download the latest version of hawkular-metrics-standalone-dist-X.Y.Z.Final.ear. Copy the EAR file to the standalone/deployments directory. You will have to manually configure WildFly.

The following cache container declarations are needed in the infinispan subsection:

<cache-container name="hawkular-alerts" default-cache="triggers" statistics-enabled="true">
      <local-cache name="partition"/>
      <local-cache name="triggers"/>
      <local-cache name="data"/>
      <local-cache name="publish"/>
      <local-cache name="schema"/>
      <local-cache name="dataIds"/>
      <local-cache name="globalActions"/>
<cache-container name="hawkular-metrics" default-cache="triggers" statistics-enabled="true">
        <local-cache name="locks"/>

If you are running a cluster of WildFly servers in HA mode, then you will instead want to edit standalone-ha.xml, adding the following cache containers:

<cache-container name="hawkular-alerts" default-cache="triggers" statistics-enabled="true">
        <transport lock-timeout="60000"/>
        <replicated-cache name="partition" mode="SYNC">
               <transaction mode="BATCH"/>
        <replicated-cache name="triggers" mode="ASYNC">
               <transaction mode="BATCH"/>
        <replicated-cache name="data" mode="ASYNC">
               <transaction mode="BATCH"/>
        <replicated-cache name="publish" mode="ASYNC">
               <transaction mode="BATCH"/>
        <replicated-cache name="schema" mode="SYNC">
               <transaction mode="NON_XA"/>
        <replicated-cache name="dataIds" mode="ASYNC">
               <transaction mode="BATCH"/>
        <replicated-cache name="globalActions" mode="ASYNC">
               <transaction mode="BATCH"/>
<cache-container name="hawkular-metrics" default-cache="triggers" statistics-enabled="true">
        <transport lock-timeout="60000"/>
        <replicated-cache name="locks" mode="SYNC">
               <transaction mode="NON_XA" locking="PESSIMISTIC"/>

By default, Metrics will try to connect to a Cassandra on localhost. If you want to start a Cassandra server embedded in WildFly for testing, add the hawkular-metrics-embedded-cassandra-ear-X.Y.Z.ear archive to the standalone/deployments directory.

Build Instructions

A running Cassandra cluster, which can be a single node, is required for unit and integration tests.
git clone git@github.com:hawkular/hawkular-metrics.git
cd hawkular-metrics
./mvnw install
If you only want to build the sources without a running C* cluster, you can run ./mvnw install -DskipTests.

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.0.12 -n 1 -s hawkular

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.0.12 cluster.

Client tools

If you want to send or fetch metrics from your own application, there are client libraries available to assist:

Working with monitoring tools

You can send data collected with your usual monitoring tools to Hawkular Metrics:

  • collectd

  • ganglia

  • jmxtrans

  • statsd

In order to do so, you must start our network protocol adapter, ptrans.

Contributing & Community

If you are a user of Hawkular Metrics please ask your question in the Hawkular user forum. To contribute or participate in design discussion, please use the Hawkular developer mailing list.

We love contributions and pull-requests :-)

To file an issue, please use the Hawkular-Metrics JIRA.

To chat, 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.