org.hawkular.metrics.alerter.groups

Class GroupTriggerManager

java.lang.Object

org.hawkular.metrics.alerter.groups.GroupTriggerManager

public class GroupTriggerManager
extends Object

Another feature of the Metrics Alerter is an ability to manage a Metrics Group Trigger. A Metrics Group Trigger is an hAlerting group trigger that has a member trigger for each metric is a set scoped by a metrics tag query. The concept is similar to data-driven triggers but because metrics does not lend itself to the required source+dataId approach used by data-driven triggers, we use this approach.

We interact with hAlerting to pull properly tagged group triggers. We set up a job for each to query for metrics, and maintain member triggers for each.

Each Metrics Group Trigger has several tags to guide its handling:

   "HawkularMetrics" : "GroupTrigger"       // Required to be processed as Metrics Group Trigger
   "DataIds"         : DataId1..DataIdN     // The DataIds used in the trigger conditions, required
   DataId1           : tag query            // Metrics tag query for dataId1 metrics
     ...
   DataIdN           : tag query            // Metrics tag query for dataIdN metrics
   "SourceBy"        : TagName1..TagNameN   // *see below*
 

SourceBy

The SourceBy tag specifies the metric tag names used to determine the member trigger population. As an example, consider a group trigger with one CompareCondition: HeapUsed > 80% HeapMax. We want to compare HeapUsed to HeapMax but of course each comparison should be done on metrics from the same machine. We don't want to compare all HeapUsed to all HeapMax for every machine in the data center. We'd want a group trigger tagged something like this:

   "HawkularMetrics" : "GroupTrigger"
   "DataIds"         : "HeapUsed,HeapMax"
   "HeapUsed"        : name = "HeapUsed"
   "HeapMax"         : name = "HeapMax"
   "SourceBy"        : Machine
 

This would result in one member trigger per machine, for machine names common to HeapUsed and HeapMax metrics. So, if we had the following metrics in the database, tagged as specified:

   /machine0/HeapUsed    {name=HeapUsed, Machine=machine0}
   /machine0/HeapMax     {name=HeapMax, Machine=machine0}
   /machine1/HeapUsed    {name=HeapUsed, Machine=machine1}
   /machine1/HeapMax     {name=HeapMax, Machine=machine1}
   /machine2/HeapUsed    {name=HeapUsed}
   /machine2/HeapMax     {name=HeapMax}
   /machine3/HeapUsed    {name=HeapUsed, Machine=machine3}
   /machine4/HeapMax     {name=HeapMax, Machine=machine4}

 

Then we would get two member triggers, one each testing:

   /machine0/HeapUsed < 80% /machine0/HeapMax
   /machine1/HeapUsed < 80% /machine1/HeapMax
 

We would not have a 3rd member trigger because machine2 metrics don't have the necessary tags, machine3 does not have the HeapMax metric, and machine4 does not have the HeapUsed metric.

SourceBy is required, but can be set to '*' to generate member triggers for all value combinations (not recommended when multiple dataIds are involved).

Author:

Jay Shaughnessy, Lucas Ponce

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GroupTriggerManager.TopologyChangeListener

Constructor Summary

Constructors

Constructor and Description
GroupTriggerManager()

Method Summary

Modifier and Type	Method and Description
void	cancel(org.hawkular.alerts.api.model.trigger.Trigger mgt)
void	init()
void	shutdown()
void	start()
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupTriggerManager

public GroupTriggerManager()

Method Detail

init

@PostConstruct
public void init()

start

public void start()

shutdown

@PreDestroy
public void shutdown()

stop

public void stop()

cancel

public void cancel(org.hawkular.alerts.api.model.trigger.Trigger mgt)