org.apache.ambari.server.orm.dao

Class AlertsDAO

java.lang.Object

org.apache.ambari.server.orm.dao.AlertsDAO

All Implemented Interfaces:

Cleanable

public class AlertsDAO
extends Object
implements Cleanable

The AlertsDAO class manages the AlertHistoryEntity and AlertCurrentEntity instances. Each AlertHistoryEntity is known as an "alert" that has been triggered and received.

If alert caching is enabled, then updates to AlertCurrentEntity are not immediately persisted to JPA. Instead, they are kept in a cache and periodically flushed. This means that many queries will need to swap in the cached AlertCurrentEntity with that returned from the EclipseLink JPA entity manager.

Constructor Summary

Constructors

Constructor and Description
AlertsDAO(Configuration configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
long	cleanup(TimeBasedCleanupPolicy policy) Performs the cleanup for the entiries the implementing DAO is responsible for.
void	create(AlertCurrentEntity alert) Persists a new current alert.
void	create(AlertHistoryEntity alert) Persists a new alert.
AlertSummaryDTO	findAggregateCounts(long clusterId, String alertName) Finds the aggregate counts for an alert name, across all hosts.
List<AlertHistoryEntity>	findAll() Gets all alerts stored in the database across all clusters.
List<AlertCurrentEntity>	findAll(AlertCurrentRequest request) Finds all AlertCurrentEntity that match the provided AlertCurrentRequest.
List<AlertHistoryEntity>	findAll(AlertHistoryRequest request) Finds all AlertHistoryEntity that match the provided AlertHistoryRequest.
List<AlertHistoryEntity>	findAll(long clusterId) Gets all alerts stored in the database for the given cluster.
List<AlertHistoryEntity>	findAll(long clusterId, Date startDate, Date endDate) Gets all alerts stored in the database for the given cluster and that fall withing the specified date range.
List<AlertHistoryEntity>	findAll(long clusterId, List<AlertState> alertStates) Gets all alerts stored in the database for the given cluster that have one of the specified alert states.
AlertHistoryEntity	findById(long alertId) Gets an alert with the specified ID.
List<AlertCurrentEntity>	findCurrent() Gets the current alerts.
List<AlertCurrentEntity>	findCurrentByCluster(long clusterId) Gets the current alerts for a given cluster.
List<AlertCurrentEntity>	findCurrentByDefinitionId(long definitionId) Gets the current alerts for the specified definition ID.
AlertCurrentEntity	findCurrentByHostAndName(long clusterId, String hostName, String alertName) Locate the current alert for the provided service and alert name.
AlertCurrentEntity	findCurrentById(long alertId) Gets a current alert with the specified ID.
AlertCurrentEntity	findCurrentByNameNoHost(long clusterId, String alertName) Locate the current alert for the provided service and alert name, but when host is not set (IS NULL).
List<AlertCurrentEntity>	findCurrentByService(long clusterId, String serviceName) Gets the current alerts for a given service.
AlertSummaryDTO	findCurrentCounts(long clusterId, String serviceName, String hostName) Retrieves the summary information for a particular scope.
AlertHostSummaryDTO	findCurrentHostCounts(long clusterId) Retrieve the summary alert information for all hosts.
Map<String,AlertSummaryDTO>	findCurrentPerHostCounts(long clusterId) Retrieves the summary information for all the hosts in the provided cluster.
void	flushCachedEntitiesToJPA() Writes all cached AlertCurrentEntity instances to the database and clears the cache.
int	getCount(Predicate predicate) Gets the total count of all AlertHistoryEntity rows that match the specified Predicate.
AlertCurrentEntity	merge(AlertCurrentEntity alert) Merge the speicified current alert with the existing alert in the database.
AlertCurrentEntity	merge(AlertCurrentEntity alert, boolean updateCacheOnly) Updates the internal cache of alerts with the specified alert.
AlertHistoryEntity	merge(AlertHistoryEntity alert) Merge the speicified alert with the existing alert in the database.
void	refresh(AlertCurrentEntity alert) Refresh the state of the current alert from the database.
void	refresh(AlertHistoryEntity alert) Refresh the state of the alert from the database.
void	remove(AlertCurrentEntity alert) Removes the specified current alert from the database.
void	remove(AlertHistoryEntity alert) Removes the specified alert from the database.
void	removeByDefinitionId(long definitionId) Removes alert history and current alerts for the specified alert defintiion ID.
int	removeCurrentByHistoryId(long historyId) Remove a current alert whose history entry matches the specfied ID.
int	removeCurrentByHost(String hostName) Remove the current alert that matches the given host.
int	removeCurrentByService(long clusterId, String serviceName) Remove the current alert that matches the given service.
int	removeCurrentByServiceComponentHost(long clusterId, String serviceName, String componentName, String hostName) Remove the current alert that matches the given service, component and host.
int	removeCurrentDisabledAlerts() Remove all current alerts that are disabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertsDAO

@Inject
public AlertsDAO(Configuration configuration)

Constructor.

Method Detail

findById

public AlertHistoryEntity findById(long alertId)

Gets an alert with the specified ID.

Parameters:

alertId - the ID of the alert to retrieve.

Returns:

the alert or null if none exists.

findAll

public List<AlertHistoryEntity> findAll()

Gets all alerts stored in the database across all clusters.

Returns:

all alerts or an empty list if none exist (never null).

findAll

public List<AlertHistoryEntity> findAll(long clusterId)

Gets all alerts stored in the database for the given cluster.

Parameters:

clusterId - the ID of the cluster.

Returns:

all alerts in the specified cluster or an empty list if none exist (never null).

findAll

public List<AlertHistoryEntity> findAll(long clusterId,
                                        List<AlertState> alertStates)

Gets all alerts stored in the database for the given cluster that have one of the specified alert states.

Parameters:

clusterId - the ID of the cluster.

alertStates - the states to match for the retrieved alerts (not null).

Returns:

the alerts matching the specified states and cluster, or an empty list if none.

findAll

public List<AlertHistoryEntity> findAll(long clusterId,
                                        Date startDate,
                                        Date endDate)

Gets all alerts stored in the database for the given cluster and that fall withing the specified date range. Dates are expected to be in milliseconds since the epoch, normalized to UTC time.

Parameters:

clusterId - the ID of the cluster.

startDate - the date that the earliest entry must occur after, normalized to UTC, or null for all entries that occur before the given end date.

endDate - the date that the latest entry must occur before, normalized to UTC, or null for all entries that occur after the given start date.

Returns:

the alerts matching the specified date range.

findAll

public List<AlertHistoryEntity> findAll(AlertHistoryRequest request)

Finds all AlertHistoryEntity that match the provided AlertHistoryRequest. This method will make JPA do the heavy lifting of providing a slice of the result set.

Parameters:

request -

Returns:

findAll

public List<AlertCurrentEntity> findAll(AlertCurrentRequest request)

Finds all AlertCurrentEntity that match the provided AlertCurrentRequest. This method will make JPA do the heavy lifting of providing a slice of the result set.

Parameters:

request -

Returns:

getCount

public int getCount(Predicate predicate)

Gets the total count of all AlertHistoryEntity rows that match the specified Predicate.

Parameters:

predicate - the predicate to apply, or null for none.

Returns:

the total count of rows that would be returned in a result set.

findCurrent

public List<AlertCurrentEntity> findCurrent()

Gets the current alerts.

Returns:

the current alerts or an empty list if none exist (never null).

findCurrentById

public AlertCurrentEntity findCurrentById(long alertId)

Gets a current alert with the specified ID.

Parameters:

alertId - the ID of the alert to retrieve.

Returns:

the alert or null if none exists.

findCurrentByDefinitionId

public List<AlertCurrentEntity> findCurrentByDefinitionId(long definitionId)

Gets the current alerts for the specified definition ID.

Parameters:

definitionId - the ID of the definition to retrieve current alerts for.

Returns:

the current alerts for the definition or an empty list if none exist (never null).

findCurrentByCluster

public List<AlertCurrentEntity> findCurrentByCluster(long clusterId)

Gets the current alerts for a given cluster.

Returns:

the current alerts for the given cluster or an empty list if none exist (never null).

findCurrentCounts

public AlertSummaryDTO findCurrentCounts(long clusterId,
                                         String serviceName,
                                         String hostName)

Retrieves the summary information for a particular scope. The result is a DTO since the columns are aggregated and don't fit to an entity.

Parameters:

clusterId - the cluster id

serviceName - the service name. Use null to not filter on service.

hostName - the host name. Use null to not filter on host.

Returns:

the summary DTO

findCurrentPerHostCounts

public Map<String,AlertSummaryDTO> findCurrentPerHostCounts(long clusterId)

Retrieves the summary information for all the hosts in the provided cluster. The result is mapping from hostname to summary DTO.

Parameters:

clusterId - the cluster id

Returns:

map from hostnames to summary DTO

findCurrentHostCounts

public AlertHostSummaryDTO findCurrentHostCounts(long clusterId)

Retrieve the summary alert information for all hosts. This is different from findCurrentCounts(long, String, String) since this will return only alerts related to hosts and those values will be the total number of hosts affected, not the total number of alerts.

Parameters:

clusterId - the cluster id

Returns:

the summary DTO for host alerts.

findCurrentByService

public List<AlertCurrentEntity> findCurrentByService(long clusterId,
                                                     String serviceName)

Gets the current alerts for a given service.

Returns:

the current alerts for the given service or an empty list if none exist (never null).

findCurrentByHostAndName

public AlertCurrentEntity findCurrentByHostAndName(long clusterId,
                                                   String hostName,
                                                   String alertName)

Locate the current alert for the provided service and alert name. This method will first consult the cache if configured with Configuration.isAlertCacheEnabled().

Parameters:

clusterId - the cluster id

hostName - the name of the host (not null).

alertName - the name of the alert (not null).

Returns:

the current record, or null if not found

removeByDefinitionId

public void removeByDefinitionId(long definitionId)

Removes alert history and current alerts for the specified alert defintiion ID. This will invoke EntityManager.clear() when completed since the JPQL statement will remove entries without going through the EM.

Parameters:

definitionId - the ID of the definition to remove.

removeCurrentByHistoryId

public int removeCurrentByHistoryId(long historyId)

Remove a current alert whose history entry matches the specfied ID.

Parameters:

historyId - the ID of the history entry.

Returns:

the number of alerts removed.

removeCurrentDisabledAlerts

public int removeCurrentDisabledAlerts()

Remove all current alerts that are disabled.

Returns:

the number of alerts removed.

removeCurrentByService

public int removeCurrentByService(long clusterId,
                                  String serviceName)

Remove the current alert that matches the given service. This is used in cases where the service was removed from the cluster.

This method will also fire an AggregateAlertRecalculateEvent in order to recalculate all aggregates.

Parameters:

clusterId - the ID of the cluster.

serviceName - the name of the service that the current alerts are being removed for (not null).

Returns:

the number of alerts removed.

removeCurrentByHost

public int removeCurrentByHost(String hostName)

Remove the current alert that matches the given host. This is used in cases where the host was removed from the cluster.

This method will also fire an AggregateAlertRecalculateEvent in order to recalculate all aggregates.

Parameters:

hostName - the name of the host that the current alerts are being removed for (not null).

Returns:

the number of alerts removed.

removeCurrentByServiceComponentHost

public int removeCurrentByServiceComponentHost(long clusterId,
                                               String serviceName,
                                               String componentName,
                                               String hostName)

Remove the current alert that matches the given service, component and host. This is used in cases where the component was removed from the host.

This method will also fire an AggregateAlertRecalculateEvent in order to recalculate all aggregates.

Parameters:

clusterId - the ID of the cluster.

serviceName - the name of the service that the current alerts are being removed for (not null).

componentName - the name of the component that the current alerts are being removed for (not null).

hostName - the name of the host that the current alerts are being removed for (not null).

Returns:

the number of alerts removed.

create

public void create(AlertHistoryEntity alert)

Persists a new alert.

Parameters:

alert - the alert to persist (not null).

refresh

public void refresh(AlertHistoryEntity alert)

Refresh the state of the alert from the database.

Parameters:

alert - the alert to refresh (not null).

merge

public AlertHistoryEntity merge(AlertHistoryEntity alert)

Merge the speicified alert with the existing alert in the database.

Parameters:

alert - the alert to merge (not null).

Returns:

the updated alert with merged content (never null).

remove

public void remove(AlertHistoryEntity alert)

Removes the specified alert from the database.

Parameters:

alert - the alert to remove.

create

public void create(AlertCurrentEntity alert)

Persists a new current alert.

Parameters:

alert - the current alert to persist (not null).

refresh

public void refresh(AlertCurrentEntity alert)

Refresh the state of the current alert from the database.

Parameters:

alert - the current alert to refresh (not null).

merge

public AlertCurrentEntity merge(AlertCurrentEntity alert)

Merge the speicified current alert with the existing alert in the database.

Parameters:

alert - the current alert to merge (not null).

Returns:

the updated current alert with merged content (never null).

merge

public AlertCurrentEntity merge(AlertCurrentEntity alert,
                                boolean updateCacheOnly)

Updates the internal cache of alerts with the specified alert. Unlike merge(AlertCurrentEntity), this is not transactional and only updates the cache.

The alert should already exist in JPA - this is mainly to update the text and timestamp.

Parameters:

alert - the alert to update in the cache (not null).

updateCacheOnly - if true, then only the cache is updated and not JPA.

See Also:

Configuration.isAlertCacheEnabled()

remove

public void remove(AlertCurrentEntity alert)

Removes the specified current alert from the database.

Parameters:

alert - the current alert to remove.

findAggregateCounts

public AlertSummaryDTO findAggregateCounts(long clusterId,
                                           String alertName)

Finds the aggregate counts for an alert name, across all hosts.

Parameters:

clusterId - the cluster id

alertName - the name of the alert to find the aggregate

Returns:

the summary data

findCurrentByNameNoHost

public AlertCurrentEntity findCurrentByNameNoHost(long clusterId,
                                                  String alertName)

Locate the current alert for the provided service and alert name, but when host is not set (IS NULL). This method will first consult the cache if configured with Configuration.isAlertCacheEnabled().

Parameters:

clusterId - the cluster id

alertName - the name of the alert

Returns:

the current record, or null if not found

flushCachedEntitiesToJPA

public void flushCachedEntitiesToJPA()

Writes all cached AlertCurrentEntity instances to the database and clears the cache.

cleanup

public long cleanup(TimeBasedCleanupPolicy policy)

Description copied from interface: Cleanable

Performs the cleanup for the entiries the implementing DAO is responsible for.

Specified by:

cleanup in interface Cleanable

Parameters:

policy - the policy with the parameters of the cleanup

Returns:

the number of affected records if available