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.
void	clear() Reset session state.
List<Alert>	getAlerts(String tenantId, AlertsCriteria criteria)
void	reload() Reload all Triggers.
void	reloadTrigger(String tenantId, String triggerId) Reload the specified Trigger.
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)
void	sendData(Data data)

Method Detail

sendData

void sendData(Data data)

sendData

void sendData(Collection<Data> data)

clear

void clear()

Reset session state.

reload

void reload()

Reload all Triggers.

reloadTrigger

void reloadTrigger(String tenantId,
                   String triggerId)

Reload the specified Trigger. Removes any existing definition from the engine. If enabled then loads the firing condition set and dampening. If safetyEnabled then also loads the safety condition set and dampening.

Parameters:

tenantId - Tenant where Trigger is stored

triggerId - Trigger id to be reloaded

getAlerts

List<Alert> getAlerts(String tenantId,
                      AlertsCriteria criteria)
               throws Exception

Parameters:

tenantId - Tenant where alerts are stored

criteria - If null returns all alerts (not recommended)

Returns:

NotNull, can be empty.

Throws:

Exception - any problem

addAlerts

void addAlerts(Collection<Alert> alerts)
        throws Exception

Persist the provided alerts.

Parameters:

alerts - Set of unpersisted Alerts.

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