org.hawkular.apm.api.services

Class AbstractAnalyticsService

java.lang.Object

org.hawkular.apm.api.services.AbstractAnalyticsService

All Implemented Interfaces:

AnalyticsService

public abstract class AbstractAnalyticsService
extends Object
implements AnalyticsService

The abstract base class for implementations of the Analytics Service.

Author:

gbrown

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAnalyticsService.EndpointPart This class represents a node in a tree of endpoint (e.g.

Constructor Summary

Constructors

Constructor and Description
AbstractAnalyticsService()

Method Summary

Modifier and Type	Method and Description
protected static void	buildTree(AbstractAnalyticsService.EndpointPart parent, String[] parts, int index, String endpointType) This method builds a tree.
protected static List<EndpointInfo>	compressEndpointInfo(List<EndpointInfo> endpoints) This method compresses the list of endpoints to identify common patterns.
protected static String	createRegex(String endpoint, boolean meta) This method derives the regular expression from the supplied URI.
protected abstract Collection<CommunicationSummaryStatistics>	doGetCommunicationSummaryStatistics(String tenantId, Criteria criteria) This method returns the flat list of communication summary stats.
protected List<EndpointInfo>	doGetUnboundEndpoints(String tenantId, List<Trace> fragments, boolean compress) This method obtains the unbound endpoints from a list of trace fragments.
protected static List<EndpointInfo>	extractEndpointInfo(AbstractAnalyticsService.EndpointPart root) This method expands a tree into the collapsed set of endpoints.
List<EndpointInfo>	getBoundEndpoints(String tenantId, String transaction, long startTime, long endTime) This method returns the bound endpoints associated with a 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.
ConfigurationService	getConfigurationService() This method gets the configuration service.
protected Set<String>	getEndpoints(String tenantId, Criteria criteria)
protected abstract List<Trace>	getFragments(String tenantId, Criteria criteria) This method returns the list of traces for the supplied criteria.
List<EndpointInfo>	getUnboundEndpoints(String tenantId, long startTime, long endTime, boolean compress) This method returns the unbound endpoints (i.e.
protected static boolean	hasMetrics(CommunicationSummaryStatistics css) This method determines whether the communication summary statistics have defined metrics.
protected static void	initEndpointInfo(EndpointInfo endpoint) This method initialises the endpoint information.
protected static void	initEndpointInfo(List<EndpointInfo> endpoints) This method initialises the list of endpoint information.
protected void	obtainEndpoints(List<Node> nodes, List<EndpointInfo> endpoints) This method collects the information regarding endpoints.
protected void	obtainProducerEndpoints(List<Node> nodes, List<EndpointInfo> endpoints, Map<String,EndpointInfo> map) This method collects the information regarding endpoints for contained producers.
void	setConfigurationService(ConfigurationService cs) This method sets the configuration service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hawkular.apm.api.services.AnalyticsService

clear, getHostNames, getNodeSummaryStatistics, getNodeTimeseriesStatistics, getPropertyInfo, getTraceCompletionCount, getTraceCompletionFaultCount, getTraceCompletionFaultDetails, getTraceCompletionPercentiles, getTraceCompletionPropertyDetails, getTraceCompletions, getTraceCompletionTimeseriesStatistics, getTransactionInfo, storeCommunicationDetails, storeNodeDetails, storeTraceCompletions

Constructor Detail

AbstractAnalyticsService

public AbstractAnalyticsService()

Method Detail

getConfigurationService

public ConfigurationService getConfigurationService()

This method gets the configuration service.

Returns:

The configuration service

setConfigurationService

public void setConfigurationService(ConfigurationService cs)

This method sets the configuration service.

Parameters:

cs - The configuration service

getFragments

protected abstract List<Trace> getFragments(String tenantId,
                                            Criteria criteria)

This method returns the list of traces for the supplied criteria.

Parameters:

tenantId - The tenant

criteria - The criteria

Returns:

The list of fragments

getUnboundEndpoints

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

Description copied from interface: AnalyticsService

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

Specified by:

getUnboundEndpoints in interface AnalyticsService

Parameters:

tenantId - The optional tenant id

startTime - The start time in milliseconds

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

compress - Whether to compress the list and show common patterns

Returns:

The unbound endpoints

getBoundEndpoints

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

Description copied from interface: AnalyticsService

This method returns the bound endpoints associated with a transaction.

Specified by:

getBoundEndpoints in interface AnalyticsService

Parameters:

tenantId - The optional tenant id

transaction - The transaction name

startTime - The start time in milliseconds

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

Returns:

The bound endpoints

compressEndpointInfo

protected static List<EndpointInfo> compressEndpointInfo(List<EndpointInfo> endpoints)

This method compresses the list of endpoints to identify common patterns.

Parameters:

endpoints - The endpoints

Returns:

The compressed list of endpoints

buildTree

protected static void buildTree(AbstractAnalyticsService.EndpointPart parent,
                                String[] parts,
                                int index,
                                String endpointType)

This method builds a tree.

Parameters:

parent - The current parent node

parts - The parts of the URI being processed

index - The current index into the parts array

endpointType - The endpoint type

extractEndpointInfo

protected static List<EndpointInfo> extractEndpointInfo(AbstractAnalyticsService.EndpointPart root)

This method expands a tree into the collapsed set of endpoints.

Parameters:

root - The tree

Returns:

The list of endpoints

initEndpointInfo

protected static void initEndpointInfo(List<EndpointInfo> endpoints)

This method initialises the list of endpoint information.

Parameters:

endpoints - The endpoint information

initEndpointInfo

protected static void initEndpointInfo(EndpointInfo endpoint)

This method initialises the endpoint information.

Parameters:

endpoint - The endpoint information

getCommunicationSummaryStatistics

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

Description copied from interface: AnalyticsService

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.

Specified by:

getCommunicationSummaryStatistics in interface AnalyticsService

Parameters:

tenantId - The tenant id

criteria - The criteria

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

Returns:

The communication summary statistics

getEndpoints

protected Set<String> getEndpoints(String tenantId,
                                   Criteria criteria)

hasMetrics

protected static boolean hasMetrics(CommunicationSummaryStatistics css)

This method determines whether the communication summary statistics have defined metrics.

Parameters:

css - The communication summary structure

Returns:

Whether they include metrics

doGetCommunicationSummaryStatistics

protected abstract Collection<CommunicationSummaryStatistics> doGetCommunicationSummaryStatistics(String tenantId,
                                                                                                  Criteria criteria)

This method returns the flat list of communication summary stats.

Parameters:

tenantId - The tenant id

criteria - The criteria

Returns:

The list of communication summary nodes

doGetUnboundEndpoints

protected List<EndpointInfo> doGetUnboundEndpoints(String tenantId,
                                                   List<Trace> fragments,
                                                   boolean compress)

This method obtains the unbound endpoints from a list of trace fragments.

Parameters:

tenantId - The tenant

fragments - The list of trace fragments

compress - Whether the list should be compressed (i.e. to identify patterns)

Returns:

The list of unbound endpoints

obtainEndpoints

protected void obtainEndpoints(List<Node> nodes,
                               List<EndpointInfo> endpoints)

This method collects the information regarding endpoints.

Parameters:

nodes - The nodes

endpoints - The list of endpoints

obtainProducerEndpoints

protected void obtainProducerEndpoints(List<Node> nodes,
                                       List<EndpointInfo> endpoints,
                                       Map<String,EndpointInfo> map)

This method collects the information regarding endpoints for contained producers.

Parameters:

nodes - The nodes

endpoints - The list of endpoint info

map - The map of endpoints to info

createRegex

protected static String createRegex(String endpoint,
                                    boolean meta)

This method derives the regular expression from the supplied URI.

Parameters:

endpoint - The endpoint

meta - Whether this is a meta endpoint

Returns:

The regular expression