com.apptelemetry.apm
Class APMModule

java.lang.Object
  com.apptelemetry.apm.APMModule

public class APMModule
extends java.lang.Object

Constructor Summary

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

Method Summary

void	Event(long eventId, byte level, byte flags) Call Event function to log the occurrence of a certain event.
void	EventParam(long eventId, byte level, byte flags, APMParameter param) Call EventParam function to log the occurrence of a certain event.
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.

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.

EventParam

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

Call EventParam 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 - Complex parameter.