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	addAlertTags(String tenantId, Collection<String> alertIds, Map<String,String> tags) Add the provided tags to the specified alerts.
void	addEvents(Collection<Event> events) Persist the provided events and send to the engine for alerts evaluation.
void	addEventTags(String tenantId, Collection<String> eventIds, Map<String,String> tags) Add the provided tags to the specified events.
void	addNote(String tenantId, String alertId, String user, String text) Add a note on an existing Alert.
int	deleteAlerts(String tenantId, AlertsCriteria criteria) Delete the requested Alerts, as described by the provided criteria.
int	deleteEvents(String tenantId, EventsCriteria criteria) Delete the requested Events, as described by the provided criteria.
Alert	getAlert(String tenantId, String alertId, boolean thin)
Page<Alert>	getAlerts(String tenantId, AlertsCriteria criteria, Pager pager)
Event	getEvent(String tenantId, String eventId, boolean thin)
Page<Event>	getEvents(String tenantId, EventsCriteria criteria, Pager pager)
void	persistEvents(Collection<Event> events) Only persist the provided events.
void	removeAlertTags(String tenantId, Collection<String> alertIds, Collection<String> tags) Remove the provided tags from the specified alerts.
void	removeEventTags(String tenantId, Collection<String> eventIds, Collection<String> tags) Remove the provided tags from the specified events.
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

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. "unknown" if not specified.

ackNotes - Optional notes about the acknowledgement. "none" if not specified.

Throws:

Exception - any problem

addAlerts

void addAlerts(Collection<Alert> alerts)
        throws Exception

Persist the provided alerts. Note that every alert will also get a corresponding event.

Parameters:

alerts - Set of unpersisted Alerts.

Throws:

Exception - any problem

addAlertTags

void addAlertTags(String tenantId,
                  Collection<String> alertIds,
                  Map<String,String> tags)
           throws Exception

Add the provided tags to the specified alerts.

Parameters:

tenantId - Tenant where alerts are stored

alertIds - Alerts to be tagged

tags - the tags to add

Throws:

Exception - any problem

addEvents

void addEvents(Collection<Event> events)
        throws Exception

Persist the provided events and send to the engine for alerts evaluation.

Parameters:

events - Set of unpersisted Events.

Throws:

Exception - any problem

addEventTags

void addEventTags(String tenantId,
                  Collection<String> eventIds,
                  Map<String,String> tags)
           throws Exception

Add the provided tags to the specified events.

Parameters:

tenantId - Tenant where alerts are stored

eventIds - Events to be tagged.

tags - the tags to add

Throws:

Exception - any problem

persistEvents

void persistEvents(Collection<Event> events)
            throws Exception

Only persist the provided events.

Parameters:

events - Set of unpersisted Events.

Throws:

Exception - any problem

addNote

void addNote(String tenantId,
             String alertId,
             String user,
             String text)
      throws Exception

Add a note on an existing Alert. If alertId doesn't exist then the note is ignored.

Parameters:

tenantId - Tenant where alerts are stored

alertId - Alert to be added a new note

user - The user adding the note

text - The content of the note

Throws:

Exception - any problem

deleteAlerts

int deleteAlerts(String tenantId,
                 AlertsCriteria criteria)
          throws Exception

Delete the requested Alerts, as described by the provided criteria.

Parameters:

tenantId - Tenant where alerts are stored

criteria - specifying the Alerts to be deleted. Not null.

Throws:

Exception - any problem

deleteEvents

int deleteEvents(String tenantId,
                 EventsCriteria criteria)
          throws Exception

Delete the requested Events, as described by the provided criteria.

Parameters:

tenantId - Tenant where events are stored

criteria - specifying the Events to be deleted. Not null.

Throws:

Exception - any problem

getAlert

Alert getAlert(String tenantId,
               String alertId,
               boolean thin)
        throws Exception

Parameters:

tenantId - Tenant where alerts are stored

alertId - the Alert to get.

thin - If true don't include evalSets and resolveEvalSets in the returned Alert

Returns:

the Alert or null if not found.

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 requirement for fetching alerts. Optional. Return all if null.

Returns:

NotNull, can be empty.

Throws:

Exception - any problem

getEvent

Event getEvent(String tenantId,
               String eventId,
               boolean thin)
        throws Exception

Parameters:

tenantId - Tenant where events are stored

eventId - the Event to get.

thin - If true don't include evalSets in the returned Event

Returns:

the Event or null if not found.

Throws:

Exception - any problem

getEvents

Page<Event> getEvents(String tenantId,
                      EventsCriteria criteria,
                      Pager pager)
               throws Exception

Parameters:

tenantId - Tenant where events are stored

criteria - If null returns all events (not recommended)

pager - Paging requirement for fetching events. Optional. Return all if null.

Returns:

NotNull, can be empty.

Throws:

Exception - any problem

removeAlertTags

void removeAlertTags(String tenantId,
                     Collection<String> alertIds,
                     Collection<String> tags)
              throws Exception

Remove the provided tags from the specified alerts.

Parameters:

tenantId - Tenant where alerts are stored

alertIds - Alerts from which to remove the tags

tags - the tag names to remove.

Throws:

Exception - any problem

removeEventTags

void removeEventTags(String tenantId,
                     Collection<String> eventIds,
                     Collection<String> tags)
              throws Exception

Remove the provided tags from the specified events.

Parameters:

tenantId - Tenant where events are stored

eventIds - Events from which to remove the tags

tags - the tag names to remove

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. If the call leaves the trigger with no unresolved alerts then:
- If the trigger has autoEnable=true it will be enabled, as needed.
- If the trigger has autoResolve=true it will be set to firing mode, as needed.

Parameters:

tenantId - Tenant where alerts are stored

alertIds - Alerts to be acknowledged.

resolvedBy - Optional. Typically the user resolving the alerts. "unknown" if not specified.

resolvedNotes - Optional notes about the resolution. "none" if not specified.

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.
- If the trigger has autoEnable=true it will be enabled, as needed.
- If the trigger has autoResolve=true it will be set to firing mode, as needed.

Parameters:

tenantId - Tenant where alerts are stored

triggerId - Tenant where alerts are stored

resolvedBy - Optional. Typically the user resolving the alerts. "unknown" if not specified.

resolvedNotes - Optional notes about the resolution. "none" if not specified.

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.