org.hawkular.btm.api.services

Interface AnalyticsService

public interface AnalyticsService

This interface represents the available analytics capabilities.

Author:

gbrown

Method Summary

Modifier and Type	Method and Description
int	getAlertCount(String tenantId, String name) This method returns the number of alerts associated with the specified business transaction.
List<String>	getBoundURIs(String tenantId, String businessTransaction, long startTime, long endTime) This method returns the bound URIs associated with a business transaction.
long	getCompletionCount(String tenantId, BusinessTransactionCriteria criteria) This method returns the number of completed transactions, of the specified named business transaction, that were executed during the time range.
long	getCompletionFaultCount(String tenantId, BusinessTransactionCriteria criteria) This method returns the number of completed transactions, of the specified named business transaction, that were executed during the time range and returned a fault.
Percentiles	getCompletionPercentiles(String tenantId, BusinessTransactionCriteria criteria) This method returns the percentiles, for the specified criteria, that were executed during the time range.
List<URIInfo>	getUnboundURIs(String tenantId, long startTime, long endTime) This method returns the unbound URIs (i.e.
void	storeCompletionTimes(String tenantId, List<CompletionTime> completionTimes) This method stores the supplied list of completion times.
void	storeResponseTimes(String tenantId, List<ResponseTime> responseTimes) This method stores the supplied list of completion times.

Method Detail

getUnboundURIs

List<URIInfo> getUnboundURIs(String tenantId,
                             long startTime,
                             long endTime)

This method returns the unbound URIs (i.e. ones not associated with a business transaction).

Parameters:

tenantId - The optional tenant id

startTime - The start time

endTime - The end time (if 0, then current time)

Returns:

The unbound URIs

getBoundURIs

List<String> getBoundURIs(String tenantId,
                          String businessTransaction,
                          long startTime,
                          long endTime)

This method returns the bound URIs associated with a business transaction.

Parameters:

tenantId - The optional tenant id

businessTransaction - The business transaction name

startTime - The start time

endTime - The end time (if 0, then current time)

Returns:

The bound URIs

getCompletionCount

long getCompletionCount(String tenantId,
                        BusinessTransactionCriteria criteria)

This method returns the number of completed transactions, of the specified named business transaction, that were executed during the time range. The business transaction name must be specified as part of the criteria.

Parameters:

tenantId - The tenant id

criteria - The criteria

Returns:

The transaction count

getCompletionFaultCount

long getCompletionFaultCount(String tenantId,
                             BusinessTransactionCriteria criteria)

This method returns the number of completed transactions, of the specified named business transaction, that were executed during the time range and returned a fault. The business transaction name must be specified as part of the criteria.

Parameters:

tenantId - The tenant id

criteria - The criteria

Returns:

The transaction fault count

getCompletionPercentiles

Percentiles getCompletionPercentiles(String tenantId,
                                     BusinessTransactionCriteria criteria)

This method returns the percentiles, for the specified criteria, that were executed during the time range. The business transaction name must be specified as part of the criteria.

Parameters:

tenantId - The tenant id

criteria - The criteria

Returns:

The transaction percentiles

getAlertCount

int getAlertCount(String tenantId,
                  String name)

This method returns the number of alerts associated with the specified business transaction.

Parameters:

tenantId - The tenant id

name - The business transaction name

Returns:

The number of alerts

storeResponseTimes

void storeResponseTimes(String tenantId,
                        List<ResponseTime> responseTimes)
                 throws Exception

This method stores the supplied list of completion times.

Parameters:

tenantId - The tenant id

completionTimes - The completion times

Throws:

Exception - Failed to store

storeCompletionTimes

void storeCompletionTimes(String tenantId,
                          List<CompletionTime> completionTimes)
                   throws Exception

This method stores the supplied list of completion times.

Parameters:

tenantId - The tenant id

completionTimes - The completion times

Throws:

Exception - Failed to store