org.hawkular.btm.api.services

Interface AnalyticsService

All Known Implementing Classes:

AbstractAnalyticsService

public interface AnalyticsService

This interface represents the available analytics capabilities.

Author:

gbrown

Method Summary

Modifier and Type	Method and Description
void	clear(String tenantId) This method clears the analytics data for the specified tenant.
int	getAlertCount(String tenantId, String name) This method returns the number of alerts associated with the specified business transaction.
List<EndpointInfo>	getBoundEndpoints(String tenantId, String businessTransaction, long startTime, long endTime) This method returns the bound endpoints associated with a business transaction.
Collection<CommunicationSummaryStatistics>	getCommunicationSummaryStatistics(String tenantId, Criteria criteria, boolean asTree) This method returns the communication summary statistics, for the specified criteria, that were executed during the time range.
long	getCompletionCount(String tenantId, Criteria 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, Criteria 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.
List<Cardinality>	getCompletionFaultDetails(String tenantId, Criteria criteria) This method returns the completion time fault details, for the specified criteria, that were executed during the time range.
Percentiles	getCompletionPercentiles(String tenantId, Criteria criteria) This method returns the completion time percentiles, for the specified criteria, that were executed during the time range.
List<Cardinality>	getCompletionPropertyDetails(String tenantId, Criteria criteria, String property) This method returns the completion time property details, for the specified criteria, that were executed during the time range.
List<CompletionTimeseriesStatistics>	getCompletionTimeseriesStatistics(String tenantId, Criteria criteria, long interval) This method returns the completion timeseries statistics, for the specified criteria, that were executed during the time range.
List<String>	getHostNames(String tenantId, Criteria criteria) This method returns the list of host names where activities were executed, subject to the supplied criteria.
Collection<NodeSummaryStatistics>	getNodeSummaryStatistics(String tenantId, Criteria criteria) This method returns the node summary statistics, for the specified criteria, that were executed during the time range.
List<NodeTimeseriesStatistics>	getNodeTimeseriesStatistics(String tenantId, Criteria criteria, long interval) This method returns the node timeseries statistics, for the specified criteria, that were executed during the time range.
List<PrincipalInfo>	getPrincipalInfo(String tenantId, Criteria criteria) This method returns the principals associated with the specified criteria.
List<PropertyInfo>	getPropertyInfo(String tenantId, Criteria criteria) This method returns the properties associated with the specified criteria.
List<EndpointInfo>	getUnboundEndpoints(String tenantId, long startTime, long endTime, boolean compress) This method returns the unbound endpoints (i.e.
void	storeBTxnCompletionTimes(String tenantId, List<CompletionTime> completionTimes) This method stores the supplied list of completion times for end to end business transactions.
void	storeCommunicationDetails(String tenantId, List<CommunicationDetails> communicationDetails) This method stores the supplied list of communication details.
void	storeFragmentCompletionTimes(String tenantId, List<CompletionTime> completionTimes) This method stores the supplied list of completion times for individual fragments.
void	storeNodeDetails(String tenantId, List<NodeDetails> nodeDetails) This method stores the supplied list of node details.

Method Detail

getUnboundEndpoints

List<EndpointInfo> getUnboundEndpoints(String tenantId,
                                       long startTime,
                                       long endTime,
                                       boolean compress)

This method returns the unbound endpoints (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)

compress - Whether to compress the list and show common patterns

Returns:

The unbound endpoints

getBoundEndpoints

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

This method returns the bound endpoints 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 endpoints

getPropertyInfo

List<PropertyInfo> getPropertyInfo(String tenantId,
                                   Criteria criteria)

This method returns the properties associated with the specified criteria.

Parameters:

tenantId - The optional tenant id

criteria - The criteria

Returns:

The list of property info

getPrincipalInfo

List<PrincipalInfo> getPrincipalInfo(String tenantId,
                                     Criteria criteria)

This method returns the principals associated with the specified criteria.

Parameters:

tenantId - The optional tenant id

criteria - The criteria

Returns:

The list of principal info

getCompletionCount

long getCompletionCount(String tenantId,
                        Criteria 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,
                             Criteria 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,
                                     Criteria criteria)

This method returns the completion time 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 completion time percentiles

getCompletionTimeseriesStatistics

List<CompletionTimeseriesStatistics> getCompletionTimeseriesStatistics(String tenantId,
                                                                       Criteria criteria,
                                                                       long interval)

This method returns the completion timeseries statistics, 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

interval - The aggregation interval (in milliseconds)

Returns:

The completion timeseries statistics

getCompletionFaultDetails

List<Cardinality> getCompletionFaultDetails(String tenantId,
                                            Criteria criteria)

This method returns the completion time fault details, 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 completion time fault details

getCompletionPropertyDetails

List<Cardinality> getCompletionPropertyDetails(String tenantId,
                                               Criteria criteria,
                                               String property)

This method returns the completion time property details, 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

property - The property name

Returns:

The completion time property details

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

getNodeTimeseriesStatistics

List<NodeTimeseriesStatistics> getNodeTimeseriesStatistics(String tenantId,
                                                           Criteria criteria,
                                                           long interval)

This method returns the node timeseries statistics, for the specified criteria, that were executed during the time range.

Parameters:

tenantId - The tenant id

criteria - The criteria

interval - The aggregation interval (in milliseconds)

Returns:

The node timeseries statistics

getNodeSummaryStatistics

Collection<NodeSummaryStatistics> getNodeSummaryStatistics(String tenantId,
                                                           Criteria criteria)

This method returns the node summary statistics, for the specified criteria, that were executed during the time range.

Parameters:

tenantId - The tenant id

criteria - The criteria

Returns:

The node summary statistics

getCommunicationSummaryStatistics

Collection<CommunicationSummaryStatistics> getCommunicationSummaryStatistics(String tenantId,
                                                                             Criteria criteria,
                                                                             boolean asTree)

This method returns the communication summary statistics, for the specified criteria, that were executed during the time range. The representation can either be returned as flat list of nodes, each node optionally defning the links that connect them to other nodes, or as pre-built trees.

Parameters:

tenantId - The tenant id

criteria - The criteria

asTree - Whether to build the nodes and links in a tree

Returns:

The communication summary statistics

storeNodeDetails

void storeNodeDetails(String tenantId,
                      List<NodeDetails> nodeDetails)
               throws Exception

This method stores the supplied list of node details.

Parameters:

tenantId - The tenant id

nodeDetails - The node details

Throws:

Exception - Failed to store

storeCommunicationDetails

void storeCommunicationDetails(String tenantId,
                               List<CommunicationDetails> communicationDetails)
                        throws Exception

This method stores the supplied list of communication details.

Parameters:

tenantId - The tenant id

communicationDetails - The communication details

Throws:

Exception - Failed to store

storeBTxnCompletionTimes

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

This method stores the supplied list of completion times for end to end business transactions.

Parameters:

tenantId - The tenant id

completionTimes - The completion times

Throws:

Exception - Failed to store

storeFragmentCompletionTimes

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

This method stores the supplied list of completion times for individual fragments.

Parameters:

tenantId - The tenant id

completionTimes - The completion times

Throws:

Exception - Failed to store

getHostNames

List<String> getHostNames(String tenantId,
                          Criteria criteria)

This method returns the list of host names where activities were executed, subject to the supplied criteria.

Parameters:

tenantId - The tenant id

criteria - The criteria

Returns:

The list of host names

clear

void clear(String tenantId)

This method clears the analytics data for the specified tenant.

Parameters:

tenantId - The tenant id