org.hawkular.apm.client.collector.internal

Class DefaultTraceCollector

java.lang.Object

org.hawkular.apm.client.collector.internal.DefaultTraceCollector

All Implemented Interfaces:

SessionManager, TraceCollector

public class DefaultTraceCollector
extends Object
implements TraceCollector, SessionManager

Author:

gbrown

Constructor Summary

Constructors

Constructor and Description
DefaultTraceCollector()
DefaultTraceCollector(BatchTraceRecorder batchTraceRecorder)

Method Summary

Modifier and Type	Method and Description
boolean	activate(String uri, String operation) This method is a guard condition for instrumentation rules, used to determine whether the invoker should be permitted to create and record a node as part of a trace fragment.
boolean	activate(String uri, String operation, String id) This method is a guard condition for Consumer based instrumentation rules, used to determine whether the invoker should be permitted to create and record a Consumer as part of a trace fragment.
void	appendInBuffer(String location, Object obj, byte[] data, int offset, int len) This method appends data to the buffer associated with the supplied object.
void	appendOutBuffer(String location, Object obj, byte[] data, int offset, int len) This method appends data to the buffer associated with the supplied out object.
void	assertComplete() This method asserts that the current thread of execution is complete.
protected void	checkForCompletion(FragmentBuilder builder, Node node) This method checks whether the supplied fragment has been completed and therefore should be processed.
void	completeCorrelation(String id, boolean allowSpawn) This method ends the correlation between the current thread of execution and another associated with the supplied id.
void	componentEnd(String location, String uri, String type, String operation) This method indicates the end of a component invocation.
void	componentStart(String location, String uri, String type, String operation) This method indicates the start of a component invocation.
void	consumerEnd(String location, String uri, String type, String operation) This method indicates the end of a message being consumed.
void	consumerStart(String location, String uri, String type, String operation, String id) This method indicates the start of a message being consumed.
void	correlate(String id) This method associates the current thread of execution with the session associated with the supplied correlation id.
void	deactivate() This method deactivates an active session.
protected void	diagnostics() This method reports diagnostic information to the log.
protected int	getCode(Object obj) This method returns a code associated with the supplied object.
protected FragmentManager	getFragmentManager() This method provides access to the fragment manager.
protected String	getHeaderValueText(Object value) This method returns a textual representation of the supplied header value.
String	getLevel() This method returns the reporting level.
Object	getState(Object context, String name, boolean session) This method returns the state associated with the name and optional context.
String	getTenantId()
String	getTraceId() This method returns the trace id.
String	getTransaction() This method returns the name of the transaction.
void	ignoreNode() This method indicates that the current node can be ignored if handled out of order.
protected void	initConfig() This method initialises the configuration.
void	initiateCorrelation(String id) This method initiates a correlation between this thread of execution and one or more based on the supplied id.
void	initInBuffer(String location, Object obj) This method initialises a data buffer associated with the supplied object.
void	initOutBuffer(String location, Object obj) This method initialises a data buffer associated with the supplied out object.
protected void	initRefreshCycle() This method initialises the refresh cycle.
boolean	isActive() This method determines if there is an active session associated with this thread of execution.
boolean	isCorrelated(String id) This method identifies whether a correlation with the supplied id is currently active (i.e.
boolean	isInBufferActive(String location, Object obj) This method determines if there is an active in data buffer for the supplied object.
boolean	isInContentProcessed(String location) This method identifies whether the in content for the current trace and node will be processed to extract information.
boolean	isInProcessed(String location) This method identifies whether the in data (content and headers) for the current trace and node will be processed to extract information.
boolean	isOutBufferActive(String location, Object obj) This method determines if there is an active out data buffer for the supplied object.
boolean	isOutContentProcessed(String location) This method identifies whether the out content for the current trace and node will be processed to extract information.
boolean	isOutProcessed(String location) This method identifies whether the out data (content and headers) for the current trace and node will be processed to extract information.
protected void	mergeProducer(Producer inner, Producer outer) This method merges an inner Producer node information into its containing Producer node, before removing the inner node.
protected <T extends Node> T	pop(String location, FragmentBuilder builder, Class<T> cls, String uri) This method pops an existing node from the trace fragment.
void	processIn(String location, Map<String,?> headers, Object... values) This method processes the supplied in headers and content.
protected void	processInContent(String location, FragmentBuilder builder, int hashCode) This method processes the in content if available.
void	processOut(String location, Map<String,?> headers, Object... values) This method processes the supplied out headers and content.
protected void	processOutContent(String location, FragmentBuilder builder, int hashCode) This method processes the out content if available.
protected void	processValues(Trace trace, Node node, Direction direction, Map<String,?> headers, Object[] values) This method processes the values associated with the start or end of a scoped activity.
void	producerEnd(String location, String uri, String type, String operation) This method indicates the end of a message being produced.
void	producerStart(String location, String uri, String type, String operation, String id) This method indicates the start of a message being produced.
protected void	push(String location, FragmentBuilder builder, Node node) This method pushes a new node into the trace fragment.
void	recordInBuffer(String location, Object obj) This method records the data within a buffer associated with the supplied in object.
void	recordOutBuffer(String location, Object obj) This method records the data within a buffer associated with the supplied object.
void	releaseNode(String id) This method indicates that the identified node, for this thread of execution, should be released.
void	retainNode(String id) This method indicates that the current node, for this thread of execution, should be retained temporarily pending further changes.
Node	retrieveNode(String id) This method returns the node associated, for this thread of execution, identified by the supplied id.
SessionManager	session() This method returns the session manager associated with the current thread of execution.
protected void	setConfigurationService(ConfigurationService configService) This method sets the configuration service.
void	setLevel(String location, String level) This method sets the reporting level.
void	setProperty(String location, String name, String value) This method sets a property on the trace.
void	setState(Object context, String name, Object value, boolean session) This method stores state information associated with the name and optional context.
void	setTenantId(String tenantId)
void	setTraceId(String location, String value) This method sets the id of the trace.
void	setTransaction(String location, String name) This method sets the name of the trace.
protected void	spawnFragment(FragmentBuilder parentBuilder, Node node, int position, FragmentBuilder spawnedBuilder) This method creates a new linked fragment to handle some asynchronous activities.
void	suppress() This method suppressed recording of any child nodes under the current transaction fragment node.
void	unlink() Unlink the current "linked" thread of execution from the target thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTraceCollector

public DefaultTraceCollector()

DefaultTraceCollector

public DefaultTraceCollector(BatchTraceRecorder batchTraceRecorder)

Method Detail

setConfigurationService

protected void setConfigurationService(ConfigurationService configService)

This method sets the configuration service.

Parameters:

configService - The configuration service

initConfig

protected void initConfig()

This method initialises the configuration.

initRefreshCycle

protected void initRefreshCycle()

This method initialises the refresh cycle.

getTenantId

public String getTenantId()

Returns:

the tenantId

setTenantId

public void setTenantId(String tenantId)

Parameters:

tenantId - the tenantId to set

setTraceId

public void setTraceId(String location,
                       String value)

Description copied from interface: TraceCollector

This method sets the id of the trace.

Specified by:

setTraceId in interface TraceCollector

Parameters:

location - The instrumentation location

value - The trace id

getTraceId

public String getTraceId()

Description copied from interface: TraceCollector

This method returns the trace id.

Specified by:

getTraceId in interface TraceCollector

Returns:

The trace id

setTransaction

public void setTransaction(String location,
                           String name)

Description copied from interface: TraceCollector

This method sets the name of the trace.

Specified by:

setTransaction in interface TraceCollector

Parameters:

location - The instrumentation location

name - The transaction name

getTransaction

public String getTransaction()

Description copied from interface: TraceCollector

This method returns the name of the transaction.

Specified by:

getTransaction in interface TraceCollector

Returns:

The transaction name, or empty string if not defined

setLevel

public void setLevel(String location,
                     String level)

Description copied from interface: TraceCollector

This method sets the reporting level.

Specified by:

setLevel in interface TraceCollector

Parameters:

location - The instrumentation location

level - The reporting level

getLevel

public String getLevel()

Description copied from interface: TraceCollector

This method returns the reporting level.

Specified by:

getLevel in interface TraceCollector

Returns:

The reporting level

consumerStart

public void consumerStart(String location,
                          String uri,
                          String type,
                          String operation,
                          String id)

Description copied from interface: TraceCollector

This method indicates the start of a message being consumed.

Specified by:

consumerStart in interface TraceCollector

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

operation - The operation

id - The unique interaction id

consumerEnd

public void consumerEnd(String location,
                        String uri,
                        String type,
                        String operation)

Description copied from interface: TraceCollector

This method indicates the end of a message being consumed.

Specified by:

consumerEnd in interface TraceCollector

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

operation - The operation

componentStart

public void componentStart(String location,
                           String uri,
                           String type,
                           String operation)

Description copied from interface: TraceCollector

This method indicates the start of a component invocation.

Specified by:

componentStart in interface TraceCollector

Parameters:

location - The instrumentation location

uri - The uri

type - The component type

operation - The operation

componentEnd

public void componentEnd(String location,
                         String uri,
                         String type,
                         String operation)

Description copied from interface: TraceCollector

This method indicates the end of a component invocation.

Specified by:

componentEnd in interface TraceCollector

Parameters:

location - The instrumentation location

uri - The uri

type - The component type

operation - The operation

producerStart

public void producerStart(String location,
                          String uri,
                          String type,
                          String operation,
                          String id)

Description copied from interface: TraceCollector

This method indicates the start of a message being produced.

Specified by:

producerStart in interface TraceCollector

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

operation - The operation

id - The unique interaction id

producerEnd

public void producerEnd(String location,
                        String uri,
                        String type,
                        String operation)

Description copied from interface: TraceCollector

This method indicates the end of a message being produced.

Specified by:

producerEnd in interface TraceCollector

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

operation - The operation

mergeProducer

protected void mergeProducer(Producer inner,
                             Producer outer)

This method merges an inner Producer node information into its containing Producer node, before removing the inner node.

Parameters:

inner -

outer -

isInProcessed

public boolean isInProcessed(String location)

Description copied from interface: TraceCollector

This method identifies whether the in data (content and headers) for the current trace and node will be processed to extract information.

Specified by:

isInProcessed in interface TraceCollector

Parameters:

location - The instrumentation location

Returns:

Whether the in message is processed

isInContentProcessed

public boolean isInContentProcessed(String location)

Description copied from interface: TraceCollector

This method identifies whether the in content for the current trace and node will be processed to extract information.

Specified by:

isInContentProcessed in interface TraceCollector

Parameters:

location - The instrumentation location

Returns:

Whether the in content is processed

isOutProcessed

public boolean isOutProcessed(String location)

Description copied from interface: TraceCollector

This method identifies whether the out data (content and headers) for the current trace and node will be processed to extract information.

Specified by:

isOutProcessed in interface TraceCollector

Parameters:

location - The instrumentation location

Returns:

Whether the out message is processed

isOutContentProcessed

public boolean isOutContentProcessed(String location)

Description copied from interface: TraceCollector

This method identifies whether the out content for the current trace and node will be processed to extract information.

Specified by:

isOutContentProcessed in interface TraceCollector

Parameters:

location - The instrumentation location

Returns:

Whether the out content is processed

processIn

public void processIn(String location,
                      Map<String,?> headers,
                      Object... values)

Description copied from interface: TraceCollector

This method processes the supplied in headers and content.

Specified by:

processIn in interface TraceCollector

Parameters:

location - The instrumentation location

headers - The header values

values - The values

processOut

public void processOut(String location,
                       Map<String,?> headers,
                       Object... values)

Description copied from interface: TraceCollector

This method processes the supplied out headers and content.

Specified by:

processOut in interface TraceCollector

Parameters:

location - The instrumentation location

headers - The header values

values - The values

setProperty

public void setProperty(String location,
                        String name,
                        String value)

Description copied from interface: TraceCollector

This method sets a property on the trace.

Specified by:

setProperty in interface TraceCollector

Parameters:

location - The instrumentation location

name - The property name

value - The property value

initInBuffer

public void initInBuffer(String location,
                         Object obj)

Description copied from interface: TraceCollector

This method initialises a data buffer associated with the supplied object.

Specified by:

initInBuffer in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

getCode

protected int getCode(Object obj)

This method returns a code associated with the supplied object.

Parameters:

obj - The optional object

Returns:

The code, or 0 if no object supplied

isInBufferActive

public boolean isInBufferActive(String location,
                                Object obj)

Description copied from interface: TraceCollector

This method determines if there is an active in data buffer for the supplied object.

Specified by:

isInBufferActive in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

Returns:

Whether there is an active data buffer

appendInBuffer

public void appendInBuffer(String location,
                           Object obj,
                           byte[] data,
                           int offset,
                           int len)

Description copied from interface: TraceCollector

This method appends data to the buffer associated with the supplied object.

Specified by:

appendInBuffer in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

data - The data to be appended

offset - The offset of the data

len - The length of data

recordInBuffer

public void recordInBuffer(String location,
                           Object obj)

Description copied from interface: TraceCollector

This method records the data within a buffer associated with the supplied in object.

Specified by:

recordInBuffer in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

processInContent

protected void processInContent(String location,
                                FragmentBuilder builder,
                                int hashCode)

This method processes the in content if available.

Parameters:

location - The instrumentation location

builder - The builder

hashCode - The hash code, or -1 to ignore the hash code

initOutBuffer

public void initOutBuffer(String location,
                          Object obj)

Description copied from interface: TraceCollector

This method initialises a data buffer associated with the supplied out object.

Specified by:

initOutBuffer in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

isOutBufferActive

public boolean isOutBufferActive(String location,
                                 Object obj)

Description copied from interface: TraceCollector

This method determines if there is an active out data buffer for the supplied object.

Specified by:

isOutBufferActive in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

Returns:

Whether there is an active data buffer

appendOutBuffer

public void appendOutBuffer(String location,
                            Object obj,
                            byte[] data,
                            int offset,
                            int len)

Description copied from interface: TraceCollector

This method appends data to the buffer associated with the supplied out object.

Specified by:

appendOutBuffer in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

data - The data to be appended

offset - The offset of the data

len - The length of data

recordOutBuffer

public void recordOutBuffer(String location,
                            Object obj)

Description copied from interface: TraceCollector

This method records the data within a buffer associated with the supplied object.

Specified by:

recordOutBuffer in interface TraceCollector

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

processOutContent

protected void processOutContent(String location,
                                 FragmentBuilder builder,
                                 int hashCode)

This method processes the out content if available.

Parameters:

location - The instrumentation location

builder - The builder

hashCode - The hash code, or -1 to ignore the hash code

push

protected void push(String location,
                    FragmentBuilder builder,
                    Node node)

This method pushes a new node into the trace fragment.

Parameters:

location - The instrumentation location

builder - The fragment builder

node - The node

pop

protected <T extends Node> T pop(String location,
                                 FragmentBuilder builder,
                                 Class<T> cls,
                                 String uri)

This method pops an existing node from the trace fragment.

Parameters:

location - The instrumentation location

The - class to pop

The - optional URI to match

Returns:

The node

processValues

protected void processValues(Trace trace,
                             Node node,
                             Direction direction,
                             Map<String,?> headers,
                             Object[] values)

This method processes the values associated with the start or end of a scoped activity.

Parameters:

trace - The trace

node - The node

direction - The direction

headers - The optional headers

values - The values

getHeaderValueText

protected String getHeaderValueText(Object value)

This method returns a textual representation of the supplied header value.

Parameters:

value - The original value

Returns:

The text representation, or null if no suitable found

checkForCompletion

protected void checkForCompletion(FragmentBuilder builder,
                                  Node node)

This method checks whether the supplied fragment has been completed and therefore should be processed.

Parameters:

node - The most recently popped node

builder - The fragment builder

activate

public boolean activate(String uri,
                        String operation)

Description copied from interface: SessionManager

This method is a guard condition for instrumentation rules, used to determine whether the invoker should be permitted to create and record a node as part of a trace fragment. If the fragment is not currently active, then the URI and optional operation will be checked against any filters that have been configured. If it passes, then the instrumentation rule will be permitted to proceed and create the appropriate node in the trace fragment.

Specified by:

activate in interface SessionManager

Parameters:

uri - The URI

operation - The optional operation

Returns:

Whether the fragment is already, or can be, active

activate

public boolean activate(String uri,
                        String operation,
                        String id)

Description copied from interface: SessionManager

This method is a guard condition for Consumer based instrumentation rules, used to determine whether the invoker should be permitted to create and record a Consumer as part of a trace fragment. If the fragment is not currently active, then the id will be check first, and if defined then the function will return true, allowing the Consumer node to be created. If the id is null, then the URI and optional operation will be checked against any filters that have been configured. If the URI and operation passes, then the instrumentation rule will be permitted to proceed and create the Consumer node in the trace fragment.

Specified by:

activate in interface SessionManager

Parameters:

uri - The URI

operation - The optional operation

id - The id

Returns:

Whether the fragment is already, or can be, active

isActive

public boolean isActive()

Description copied from interface: SessionManager

This method determines if there is an active session associated with this thread of execution.

Specified by:

isActive in interface SessionManager

Returns:

Whether the current thread of execution has an active session

deactivate

public void deactivate()

Description copied from interface: SessionManager

This method deactivates an active session. This will result in the current fragment builder being discarded.

Specified by:

deactivate in interface SessionManager

retainNode

public void retainNode(String id)

Description copied from interface: SessionManager

This method indicates that the current node, for this thread of execution, should be retained temporarily pending further changes. IMPORTANT: Make sure the node is released, as otherwise this will prevent the fragment from being completed (and therefore reported).

Specified by:

retainNode in interface SessionManager

Parameters:

id - The identifier used to later on to identify the node

releaseNode

public void releaseNode(String id)

Description copied from interface: SessionManager

This method indicates that the identified node, for this thread of execution, should be released. IMPORTANT: It is important that any previously retained node is released before the trace fragment can be considered complete and therefore reported.

Specified by:

releaseNode in interface SessionManager

Parameters:

id - The identifier used to identify the node

retrieveNode

public Node retrieveNode(String id)

Description copied from interface: SessionManager

This method returns the node associated, for this thread of execution, identified by the supplied id.

Specified by:

retrieveNode in interface SessionManager

Parameters:

id - The identifier used to identify the node

Returns:

The node, or null if not found

initiateCorrelation

public void initiateCorrelation(String id)

Description copied from interface: SessionManager

This method initiates a correlation between this thread of execution and one or more based on the supplied id.

Specified by:

initiateCorrelation in interface SessionManager

Parameters:

id - The id

isCorrelated

public boolean isCorrelated(String id)

Description copied from interface: SessionManager

This method identifies whether a correlation with the supplied id is currently active (i.e. awaiting completion).

Specified by:

isCorrelated in interface SessionManager

Parameters:

id - The id

Returns:

Whether the correlation is active

correlate

public void correlate(String id)

Description copied from interface: SessionManager

This method associates the current thread of execution with the session associated with the supplied correlation id.

Specified by:

correlate in interface SessionManager

Parameters:

id - The id associated with the target thread of execution

completeCorrelation

public void completeCorrelation(String id,
                                boolean allowSpawn)

Description copied from interface: SessionManager

This method ends the correlation between the current thread of execution and another associated with the supplied id.

Specified by:

completeCorrelation in interface SessionManager

Parameters:

id - The id associated with the target thread of execution

allowSpawn - Determine if completing correlation can spawn fragment if required

spawnFragment

protected void spawnFragment(FragmentBuilder parentBuilder,
                             Node node,
                             int position,
                             FragmentBuilder spawnedBuilder)

This method creates a new linked fragment to handle some asynchronous activities.

unlink

public void unlink()

Description copied from interface: SessionManager

Unlink the current "linked" thread of execution from the target thread.

Specified by:

unlink in interface SessionManager

suppress

public void suppress()

Description copied from interface: SessionManager

This method suppressed recording of any child nodes under the current transaction fragment node.

Specified by:

suppress in interface SessionManager

ignoreNode

public void ignoreNode()

Description copied from interface: SessionManager

This method indicates that the current node can be ignored if handled out of order.

Specified by:

ignoreNode in interface SessionManager

assertComplete

public void assertComplete()

Description copied from interface: SessionManager

This method asserts that the current thread of execution is complete. It has no impact on trace reporting, but is used as a sanity check to ensure the collection is working correctly.

Specified by:

assertComplete in interface SessionManager

setState

public void setState(Object context,
                     String name,
                     Object value,
                     boolean session)

Description copied from interface: SessionManager

This method stores state information associated with the name and optional context.

Specified by:

setState in interface SessionManager

Parameters:

context - The optional context

name - The name

value - The value

session - Whether related to session

getState

public Object getState(Object context,
                       String name,
                       boolean session)

Description copied from interface: SessionManager

This method returns the state associated with the name and optional context.

Specified by:

getState in interface SessionManager

Parameters:

context - The optional context

name - The name

session - Whether related to session

Returns:

The state, or null if not found

session

public SessionManager session()

Description copied from interface: TraceCollector

This method returns the session manager associated with the current thread of execution.

Specified by:

session in interface TraceCollector

Returns:

The session manager

getFragmentManager

protected FragmentManager getFragmentManager()

This method provides access to the fragment manager.

Returns:

The fragment manager

diagnostics

protected void diagnostics()

This method reports diagnostic information to the log.