Red Hat

Define Alert Triggers via HawkFX

A blog post by Heiko W. Rupp

alerts | javafx | jruby | ruby



HawkFX is an explorer for Hawkular. It is a pet project of mine and hosted on Github. It now has the ability to define alerting triggers.

Hawkular-services and now also Hawkular-Metrics standalone have the ability to fire alerts when certain conditions are met. To define those conditions, one creates a trigger via the Hawkular-Alerts api. The alerting team has also written a developer guide that explains the concepts and terms behind Hawkular-Alerts.

HawkFX now has the ability to directly insert new triggers. For this purpose I have created a DSL to allow to define triggers in a more 'natural language'. More on this below.

HawkFX trigger context menu
Figure 1. Context menu

When you right-click on a metric in the HawkFX list of metrics, there is now a new context menu item 'New trigger', that leads you to the insert screen, where you can insert the definition. This will contain a canned definition to start with.

HawkFX trigger insert
Figure 2. Alert trigger insert screen

When you are done writing the definition, you can click on the parse button at the bottom to check the definition.

Examples

Simple threshold trigger for gauges
define trigger "MyTrigger"
 ( threshold "myvalue" > 3 )
and for counters
define trigger "MyTrigger"
( threshold counter "myvalue" > 3 )

You can see from the previous two examples that gauges are the default for threshold triggers, so you can omit that keyword.

Trigger for availability, with high severity that is initially disabled
define trigger "MyTrigger"
  disabled
  severity HIGH
  ( availability "mymetric" is DOWN )
Trigger that fires when two conditions are true
define trigger "MyTrigger"
  AND(
    ( threshold counter "mycount" < 5 )
    ( string "mymetric" CO "ERROR" )
  )
Trigger that disables itself after firing
define trigger "MyTrigger"
 ( threshold "myvalue" > 3 )
 auto-disable

State of the DSL

The DSL is in flux and will be augmented and refined. So far it only contains a basic set of instructions.

The DSL tries to make life easy by trying to set sensible defaults (e.g. a trigger is enabled by default - you have to provide the disable command explicitly).

If you are interested in the grammar behind the DSL, visit the definition file. For examples about supported usage, you can have a look at the spec.

I hope to be able to extend the DSL going forward and get it into a state where it is useful for people. At least it makes it easy for me to get triggers defined when working on Hawkular.

Going forward it could also be possible to offer DSLs that mimic if-this-then-that or Zabbix rules, so that users of those systems can (re-)use their existing rules.

As written before, HawkFX is a Pet project of mine and comes with no support.




Published by Heiko W. Rupp on 24 October 2016

redhatlogo-white

© 2016 | Hawkular is released under Apache License v2.0