org.hawkular.alerts.api.services

Interface AlertsService

public interface AlertsService

Interface that allows to send data to the alerts engine and check resulting state.

Author:

Jay Shaughnessy, Lucas Ponce

Method Summary

Modifier and Type	Method and Description
void	ackAlerts(String tenantId, Collection<String> alertIds, String ackBy, String ackNotes) The alerts must already have been added.
void	addAlerts(Collection<Alert> alerts) Persist the provided alerts.
Page<Alert>	getAlerts(String tenantId, AlertsCriteria criteria, Pager pager)
void	resolveAlerts(String tenantId, Collection<String> alertIds, String resolvedBy, String resolvedNotes, List<Set<ConditionEval>> resolvedEvalSets) The alerts must already have been added.
void	resolveAlertsForTrigger(String tenantId, String triggerId, String resolvedBy, String resolvedNotes, List<Set<ConditionEval>> resolvedEvalSets) Set unresolved alerts for the provided trigger to RESOLVED status.
void	sendData(Collection<Data> data) Send data into the alerting system for evaluation.
void	sendData(Data data) Send data into the alerting system for evaluation.

Method Detail

addAlerts

void addAlerts(Collection<Alert> alerts)
        throws Exception

Persist the provided alerts.

Parameters:

alerts - Set of unpersisted Alerts.

Throws:

Exception - any problem

getAlerts

Page<Alert> getAlerts(String tenantId,
                      AlertsCriteria criteria,
                      Pager pager)
               throws Exception

Parameters:

tenantId - Tenant where alerts are stored

criteria - If null returns all alerts (not recommended)

pager - Paging requeriment for fetching alerts. Optional. Return all if null.

Returns:

NotNull, can be empty.

Throws:

Exception - any problem

ackAlerts

void ackAlerts(String tenantId,
               Collection<String> alertIds,
               String ackBy,
               String ackNotes)
        throws Exception

The alerts must already have been added. Set the alerts to ACKNOWLEDGED status. The ackTime will be set to the system time.

Parameters:

tenantId - Tenant where alerts are stored

alertIds - Alerts to be acknowledged.

ackBy - Optional. Typically the user acknowledging the alerts.

ackNotes - Optional notes about the acknowledgement.

Throws:

Exception - any problem

resolveAlerts

void resolveAlerts(String tenantId,
                   Collection<String> alertIds,
                   String resolvedBy,
                   String resolvedNotes,
                   List<Set<ConditionEval>> resolvedEvalSets)
            throws Exception

The alerts must already have been added. Set the alerts to RESOLVED status. The resolvedTime will be set to the system time.

Parameters:

tenantId - Tenant where alerts are stored

alertIds - Alerts to be acknowledged.

resolvedBy - Optional. Typically the user resolving the alerts.

resolvedNotes - Optional notes about the resolution.

resolvedEvalSets - Optional. Typically the evalSets leading to an auto-resolved alert.

Throws:

Exception - any problem

resolveAlertsForTrigger

void resolveAlertsForTrigger(String tenantId,
                             String triggerId,
                             String resolvedBy,
                             String resolvedNotes,
                             List<Set<ConditionEval>> resolvedEvalSets)
                      throws Exception

Set unresolved alerts for the provided trigger to RESOLVED status. The resolvedTime will be set to the system time.

Parameters:

tenantId - Tenant where alerts are stored

triggerId - Tenant where alerts are stored

resolvedBy - Optional. Typically the user resolving the alerts.

resolvedNotes - Optional notes about the resolution.

resolvedEvalSets - Optional. Typically the evalSets leading to an auto-resolved alert.

Throws:

Exception - any problem

sendData

void sendData(Data data)
       throws Exception

Send data into the alerting system for evaluation.

Parameters:

data - Not Null. The data to be evaluated by the alerting engine.

Throws:

Exception - any problem.

sendData

void sendData(Collection<Data> data)
       throws Exception

Send data into the alerting system for evaluation.

Parameters:

data - Not Null. The data to be evaluated by the alerting engine.

Throws:

Exception - any problem.