org.hawkular.btm.client.api

Interface BusinessTransactionCollector

public interface BusinessTransactionCollector

This interface represents the collector used to register activity related to a business transaction execution.

Author:

gbrown

Field Summary

Fields

Modifier and Type	Field and Description
static String	BATCH_SIZE The maximum number of business transactions to batch before sending to the server.
static String	BATCH_THREADS The thread pool size for reporting a batch of business transactions to the server.
static String	BATCH_TIME The maximum time (in milliseconds) before sending a batch of business transactions to the server.

Method Summary

Modifier and Type	Method and Description
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	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) This method indicates the end of a message being consumed.
void	consumerStart(String location, String uri, String type, String id) This method indicates the start of a message being consumed.
String	getName() This method returns the name of the business transaction.
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.
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 business transaction 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 business transaction 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 business transaction 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 business transaction and node will be processed to extract information.
void	processIn(String location, Map<String,?> headers, Object... values) This method processes the supplied in headers and content.
void	processOut(String location, Map<String,?> headers, Object... values) This method processes the supplied out headers and content.
void	producerEnd(String location, String uri, String type) This method indicates the end of a message being produced.
void	producerStart(String location, String uri, String type, String id) This method indicates the start of a message being produced.
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.
SessionManager	session() This method returns the session manager associated with the current thread of execution.
void	setDetail(String location, String name, String value, String nodeType, boolean onStack) This method sets a detail on the current node.
void	setFault(String location, String value, String description) This method sets a fault on the current node.
void	setName(String location, String name) This method sets the name of the business transaction.
void	setProperty(String location, String name, String value) This method sets a property on the business transaction.

Field Detail

BATCH_SIZE

static final String BATCH_SIZE

The maximum number of business transactions to batch before sending to the server.

See Also:

Constant Field Values

BATCH_TIME

static final String BATCH_TIME

The maximum time (in milliseconds) before sending a batch of business transactions to the server.

See Also:

Constant Field Values

BATCH_THREADS

static final String BATCH_THREADS

The thread pool size for reporting a batch of business transactions to the server.

See Also:

Constant Field Values

Method Detail

setName

void setName(String location,
             String name)

This method sets the name of the business transaction.

Parameters:

location - The instrumentation location

name - The business transaction name

getName

String getName()

This method returns the name of the business transaction.

Returns:

The business transaction name, or empty string if not defined

consumerStart

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

This method indicates the start of a message being consumed.

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

id - The unique interaction id

consumerEnd

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

This method indicates the end of a message being consumed.

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

componentStart

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

This method indicates the start of a component invocation.

Parameters:

location - The instrumentation location

uri - The uri

type - The component type

operation - The operation

componentEnd

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

This method indicates the end of a component invocation.

Parameters:

location - The instrumentation location

uri - The uri

type - The component type

operation - The operation

producerStart

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

This method indicates the start of a message being produced.

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

id - The unique interaction id

producerEnd

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

This method indicates the end of a message being produced.

Parameters:

location - The instrumentation location

uri - The uri

type - The endpoint type

isInProcessed

boolean isInProcessed(String location)

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

Parameters:

location - The instrumentation location

Returns:

Whether the in message is processed

isInContentProcessed

boolean isInContentProcessed(String location)

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

Parameters:

location - The instrumentation location

Returns:

Whether the in content is processed

isOutProcessed

boolean isOutProcessed(String location)

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

Parameters:

location - The instrumentation location

Returns:

Whether the out message is processed

isOutContentProcessed

boolean isOutContentProcessed(String location)

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

Parameters:

location - The instrumentation location

Returns:

Whether the out content is processed

processIn

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

This method processes the supplied in headers and content.

Parameters:

location - The instrumentation location

headers - The header values

values - The values

processOut

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

This method processes the supplied out headers and content.

Parameters:

location - The instrumentation location

headers - The header values

values - The values

setFault

void setFault(String location,
              String value,
              String description)

This method sets a fault on the current node.

Parameters:

location - The instrumentation location

value - The fault value

description - The optional fault description

setProperty

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

This method sets a property on the business transaction.

Parameters:

location - The instrumentation location

name - The property name

value - The property value

setDetail

void setDetail(String location,
               String name,
               String value,
               String nodeType,
               boolean onStack)

This method sets a detail on the current node. If the optional node type is specified, then the details will be applied to the first node of the named type that appears on either the stack (if onStack is true) or recently popped (in scope of the current node). If not node of the correct type is found, then the details will not be applied.

Parameters:

location - The instrumentation location

name - The detail name

value - The detail value

nodeType - The optional node type

onStack - The optional indicator of whether the nodeType is on the stack

initInBuffer

void initInBuffer(String location,
                  Object obj)

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

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

isInBufferActive

boolean isInBufferActive(String location,
                         Object obj)

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

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

Returns:

Whether there is an active data buffer

appendInBuffer

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

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

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

void recordInBuffer(String location,
                    Object obj)

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

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

initOutBuffer

void initOutBuffer(String location,
                   Object obj)

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

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

isOutBufferActive

boolean isOutBufferActive(String location,
                          Object obj)

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

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

Returns:

Whether there is an active data buffer

appendOutBuffer

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.

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

void recordOutBuffer(String location,
                     Object obj)

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

Parameters:

location - The instrumentation location

obj - The object associated with the buffer

session

SessionManager session()

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

Returns:

The session manager