com.apptelemetry.apm

Class APMModule

java.lang.Object

com.apptelemetry.apm.APMModule

public class APMModule
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
APMModule(java.lang.String name) Create a new Software-Telemetry module and register it on the app.telemetry Server.

Method Summary

Modifier and Type	Method and Description
void	Event(long eventId, byte level, byte flags) Call Event function to log the occurrence of a certain event.
void	EventArgs(long eventId, byte level, byte flags, java.lang.Object... args) Call the EventArgs function to log the occurrence of a certain event.
void	EventInt(long eventId, byte level, byte flags, int param) Call EventInt function to log the occurrence of a certain event with a single parameter of type 'int'.
void	EventLong(long eventId, byte level, byte flags, long param) Call EventLong function to log the occurrence of a certain event with a single parameter of type 'long'.
void	EventParam(long eventId, byte level, byte flags, APMParameter param) Call EventParam function to log the occurrence of a certain event with a given APMParameter object.
void	EventStr(long eventId, byte level, byte flags, java.lang.String param) Call EventStr function to log the occurrence of a certain event.
void	RegisterEvent(long eventId, java.lang.String eventDescription, java.lang.String parameterDescription) Call ModuleRegisterEvent to provide information about every eventId used for event tracing.
void	Unregister() Call Unregister to cleanup data structures immediately.

Methods inherited from class java.lang.Object

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

Constructor Detail

APMModule

public APMModule(java.lang.String name)

Create a new Software-Telemetry module and register it on the app.telemetry Server. (Each new module object is associated with a new module handle.)

Parameters:

name - (String) Module name to register.

Method Detail

Unregister

public void Unregister()

Call Unregister to cleanup data structures immediately. Otherwise Unregister will be called on Object destruction by JVM. Be careful that the object may be referenced by the native JNI library so you should always use the unregister function explicitly.

RegisterEvent

public void RegisterEvent(long eventId,
                          java.lang.String eventDescription,
                          java.lang.String parameterDescription)

Call ModuleRegisterEvent to provide information about every eventId used for event tracing.

Parameters:

eventId - Unique ID of event.

eventDescription - Description string of event

parameterDescription - Name of event parameters. If more parameters are used in one event, separate the parameter names by semi-colon(;). For example: "name;count;size"

Event

public void Event(long eventId,
                  byte level,
                  byte flags)

Call Event function to log the occurrence of a certain event.

Parameters:

eventId - ID of the event being processed.

level - Event detail level for filtering.

flags - Flags to mark events with Enter-, Leave- or Wait-semantic.

EventArgs

public void EventArgs(long eventId,
                      byte level,
                      byte flags,
                      java.lang.Object... args)

Call the EventArgs function to log the occurrence of a certain event.

Parameters:

eventId - ID of the event being processed.

level - Event detail level for filtering.

flags - Flags to mark events with Enter-, Leave- or Wait-semantic.

args - Additional arguments for this event (as var-args object array).

EventStr

public void EventStr(long eventId,
                     byte level,
                     byte flags,
                     java.lang.String param)

Call EventStr function to log the occurrence of a certain event.

Parameters:

eventId - ID of the event being processed.

level - Event detail level for filtering.

flags - Flags to mark events with Enter-, Leave- or Wait-semantic.

param - Parameter string.

EventInt

public void EventInt(long eventId,
                     byte level,
                     byte flags,
                     int param)

Call EventInt function to log the occurrence of a certain event with a single parameter of type 'int'.

Parameters:

eventId - ID of the event being processed.

level - Event detail level for filtering.

flags - Flags to mark events with Enter-, Leave- or Wait-semantic.

param - Parameter integer value 'int'.

EventLong

public void EventLong(long eventId,
                      byte level,
                      byte flags,
                      long param)

Call EventLong function to log the occurrence of a certain event with a single parameter of type 'long'.

Parameters:

eventId - ID of the event being processed.

level - Event detail level for filtering.

flags - Flags to mark events with Enter-, Leave- or Wait-semantic.

param - Parameter long value 'long'.

EventParam

public void EventParam(long eventId,
                       byte level,
                       byte flags,
                       APMParameter param)

Call EventParam function to log the occurrence of a certain event with a given APMParameter object.

Parameters:

eventId - ID of the event being processed.

level - Event detail level for filtering.

flags - Flags to mark events with Enter-, Leave- or Wait-semantic.

param - Complex parameter object of type 'APMParameter'.