ProbeBuilder Directives Reference

ProbeBuilder Directive (PBD) files define how the Introscope ProbeBuilder adds probes, such as timers and counters, to instrument an application. PBD files govern which metrics your agents report to the Introscope Enterprise Manager.
apmdevops106
ProbeBuilder Directive (PBD) files define how the Introscope ProbeBuilder adds probes, such as timers and counters, to instrument an application. PBD files govern which metrics your agents report to the Introscope Enterprise Manager.
You can use the default PBD files or create custom PBD files to track any classes or methods to obtain specific information about your applications. ProbeBuilder Directives are defined in two types of files:
  • ProbeBuilder Directive (PBD) --
    contains directives used by ProbeBuilder to instrument your applications. This file determines which metrics the agents report to the Enterprise Manager.
  • ProbeBuilder List (PBL) --
    contains a list of multiple PBD filenames. Multiple PBL files can refer to the same PBD files.
The complete list of ProbeBuilder Directives supported by the agents is as follows:
ProbeBuilder Directives
PHP Agent
Java Agent
.NET Agent
Node.js Agent
No
Yes
No
No
Yes
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
Yes
No
Yes
Yes
Yes
Yes
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
Yes
Yes
No
Yes
No
Yes
No
No
No
Yes
Yes
No
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
Yes
Yes
No
Yes
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
Yes
Yes
No
Yes
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
Yes
Yes
No
Yes
Yes
Yes
No
Yes
No
Yes
No
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
Yes
Yes
No
Yes
Yes
Yes
Yes
Yes
No
Yes
No
No
Yes
Yes
No
Yes
Yes
Yes
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
Yes
Yes
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
Yes
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
No
No
No
Yes
Yes
No
No
Yes
Yes
No
No
Yes
Yes
No
No
Yes
No
No
No
Yes
Yes
No
No
Yes
Yes
No
No
Yes
Yes
No
No
Yes
Yes
No
No
Yes
No
No
No
Yes
No
No
Yes
Yes
Yes
Yes
No
Yes
Yes
No
Yes
Yes
Yes
Yes
No
Yes
Yes
No
Yes
Yes
Yes
Yes
No
Yes
No
No
Yes
Yes
Yes
Yes
No
Yes
No
No
Yes
Yes
No
Yes
No
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
No
No
Yes
Yes
Yes
No
No
Yes
No
No
Yes
Yes
No
No
No
Yes
No
No
Yes
Yes
Yes
No
Yes
Yes
Yes
No
Yes
Yes
Yes
No
ConditionallyTraceOneMethodWithLabelIfInherits
Args: 8
Traces a specific method in all subclasses of the specified class or in all implementations of the specified interface, conditionally to the fact that the calling method in the calling class is part of the Thread stack. The specified classes or interfaces names should be the fully qualified.The label parameter assigned to the tracer is used for query by DI API.
The expected syntax is "ConditionallyTraceOneMethodWithLabelIfInherits: <class-name> <method> <label> <Tracer-group> <Tracer-name> <Resource-Metric> <calling-class> <calling-method>".
ConditionallyTraceOneMethodWithLabelOfClass
Args: 8
This directive traces a specific method of the specified class. The tracing requires the calling method in the calling class is part of the thread stack.
The tracer is applied on methods and classes with these elements:
  • Methods belong to class name given in the class name argument
  • Methods belong to any class included in trace group
  • Methods are not skipped by the tracer group
  • Classes are not skipped by the tracer group.
Use the fully qualified name for the specified class or interface. The dynamic instrumentation API uses the label parameter that is assigned to the tracer for querying.
The expected syntax is "ConditionallyTraceOneMethodWithLabelOfClass: <class-name> <method> <label> <Tracer-group> <Tracer-name><Resource-Metric> <calling-class> <calling-method>".
DoNotSkipMethodForClass
Args: 2
Include method in tracing even, if there is a skip directive that matches it. It is used to make exceptions for class or package based skip directives. The expected syntax is "DoNotSkipMethodForClass: <class-name> <method>".
IdentifyAllClassesAs
Args: 1
Associates all classes inspected by ProbeBuilder to the specified Tracer Group. Do NOT use in production environments.
The expected syntax is "IdentifyAllClassesAs: <Tracer-group>".
IdentifyAnnotatedClassAs
Args: 2
Associates a class to the specified Tracer Group, if it has specified annotation. Annotation name should be fully qualified.
The expected syntax is "IdentifyAnnotatedClassAs: <annotation-class> <Tracer-group>".
IdentifyClassAs
Args: 2
Associates a specific class to the specified Tracer Group. Class name should be fully qualified.
The expected syntax is "IdentifyClassAs: <class-name> <Tracer-group>".
IdentifyCorbaAs
Args: 1
Associates all CORBA classes to the specified Tracer Group. CORBA classes are limited to stubs and skeleton classes, and are identified by matching the patterns "_st_" & "_sk_" in class names.
The expected syntax is "IdentifyCorbaAs: <Tracer-group>".
IdentifyDeepInheritedAnnotatedClassAs
Args: 2
Associates a subclasses of an annotated class or interface to the 2 specified Tracer Group, if it has specified annotation. Annotation name should be fully qualified. The annotated class or interface is also associated to the Tracer Group.
The expected syntax is "IdentifyDeepInheritedAnnotatedClassAs: <annotation-class> <Tracer-group>".
IdentifyDeepInheritedAs
Args: 2
Associates all subclasses of the specified class or all implementations of the specified interface to the Tracer Group. The specified class or interface should be the fully qualified name. The specified class or interface is also associated to the Tracer Group.
The expected syntax is "IdentifyDeepInheritedAs: <class-name> <Tracer-group>".
IdentifyFlagAs
Args: 2
Assigns the classes associated with the 1st Tracer Group listed to also be associated with the 2nd Tracer Group. In addition, the 2nd Tracer Group can be activated by turning on either the 1st Tracer Group or the 2nd Tracer Group. See java2.pbd for examples.
The expected syntax is "IdentifyFlagAs: <Tracer-group> <Tracer-group>".
IdentifyInheritedAnnotatedClassAs
Args: 2
Associates all direct subclasses of an annotated class or all direct implementations of an annotated interface to the specified Tracer Group. Annotation name should be fully qualified.
The expected syntax is "IdentifyInheritedAnnotatedClassAs: <annotation¬class> <Tracer-group>".
IdentifyInheritedAs
Args: 2
Associates all direct subclasses of the specified class or all direct implementations of the specified interface to the Tracer Group. The specified class or interface should be the fully qualified name.
The expected syntax is "IdentifyInheritedAs: <class-name> <Tracer¬group>".
IdentifyMatchingClassesAs
Args: 2
Associates all classes that match the class name expression to the specified Tracer Group. The class name expression must be surrounded by quotes. The class name expression can only contain one type of wildcard * which matches any number of any characters. The wildcard may appear as many times as desired. Requires agent be at 6.0 or later.
The expected syntax is "IdentifyMatchingClassesAs: <class-pattern> <Tracer-group>".
IdentifyTwoFlagIntersectionAsAggregateFlag
Args: 3
Identifies an Aggregate Tracer Group for two member Tracer Groups. When the Aggregate Tracer Group is associated with tracing Directives, activation is dependent on both member Tracer Groups being turned on with the TurnOn Directive. See j2ee.pbd for examples.
The expected syntax is "IdentifyTwoFlagIntersectionAsAggregateFlag: <Tracer-group1> <Tracer-group2> <Aggregate-Tracer-group>".
IdentifyTwoFlagUnionAsAggregateFlag
Args: 3
Identifies an Aggregate Tracer Group for two member Tracer Groups. When the Aggregate Tracer Group is associated with tracing Directives, activation is dependent on either member Tracer Group being turned on with the TurnOn Directive. Classes associated with activated member Tracer Groups will be probed with the tracing Directives associated with the Aggregate Tracer Group. See taglibs.pbd for examples.
The expected syntax is "IdentifyTwoFlagUnionAsAggregateFlag: <Tracer¬group1> <Tracer-group2> <Aggregate-Tracer-group>".
InstrumentBootstrapClass
Args: 2
Force instrumentation of the class at bootstrap. It overrules any skip directive. If the parameter specified is "true", then the class is instrumented before the pre-main method returns, i.e. before any code is executed on the monitored application.
The expected syntax is "InstrumentBootstrapClass: <class-name> <true> <false>".
InstrumentPoint
Args: 1
A toggle for enabling or disabling capturing ThrownException and CaughtException stack traces. Also used to initialize the starting of the agent when not using JVM AutoProbe (AgentInitialization).
The expected syntax is "InstrumentPoint: <ThrowException|CatchException|AgentInitialization>".
InstrumentTraceClass
Args: 1
Set the name of the class that will trace events generated by the instrumented classes. The class must provide a one static method for each instrumentation point.
The expected syntax is "InstrumentTraceClass: <class-name>".
MarkNotToggled
Args: 1
Used to define the tracer groups that cannot be toggled on or off
The expected syntax is "MarkNotToggled: <Tracer-group>".
NoticeConstructorCompletionIfFlagged
Args: 2 This directive is for internal system use only.
NoticeFieldAssignmentIfFlagged
Args: 2 This directive is for internal system use only.
NoticeObjectCreationIfFlagged
Args: 2 This directive is for internal system use only.
NoticeScopedFieldAssignmentIfFlagged
Args: 2 This directive is for internal system use only.
NoticeScopedObjectCreationIfFlagged
Args: 2 This directive is for internal system use only.
SetFlag
Args: 1
Declaration for a new Tracer Group identified by its Flag.
The expected syntax is "SetFlag: <Tracer-group>".
SetTracerClassMapping
Args: 3
Creates a mapping between class that implements a tracer and Tracer-Name. It also specifies resource validator class for tracer. In most cases validator class is com.wily.introscope.probebuilder.validate.ResourceNameValidator.
The expected syntax is "SetTracerClassMapping: <Tracer-name> <Tracer-class> <Validator-class>".
SetTracerOrdering
Args: 2
Specifies order in which the tracers are run, if multiple tracers are put on single method. The tracers with lower order number are executed first.
The expected syntax is "SetTracerOrdering: <Tracer-name> <priority>".
SetTracerParameter
Args: 3
Sets a Tracer parameter. For example, the amount that incrementors add and the amount that decrementors subtract from a perpetual counter.
The expected syntax is "SetTracerParameter: <Tracer-name> <param¬name> <param-value>".
SkipAnnotatedForFlag
Args: 2
Prevents all classes that are explicitly annotated with specified annotation from being traced by the specified Tracer Group. Annotation name must be fully qualified.
The expected syntax is "SkipAnnotatedForFlag: <annotation-class> <Tracer-group>".
SkipAssembly
Args: 1
Prevents all classes in the specified assembly from being traced.
The expected syntax is "SkipAssembly: <assembly-name>".
SkipAssemblyForFlag
Args: 2
Prevents all classes in the specified assembly from being traced by the specified Tracer Group.
The expected syntax is "SkipAssemblyForFlag: <assembly-name> <Tracer-group>".
SkipAssemblyPrefix
Args: 1
Prevents all classes that begin with the specified assembly prefix from being traced by the specified Tracer Group.
The expected syntax is "SkipAssemblyPrefix: <assembly-prefix>".
SkipClass
Args: 1
Prevents the specified class from being traced.
The expected syntax is "SkipClass: <class-name>".
SkipClassForFlag
Args: 2
Prevents the specified class from being traced by the specified Tracer Group.
The expected syntax is "SkipClassForFlag: <class-name> <Tracer-group>".
SkipIfInheritedForFlag
Args: 2
Prevents all direct subclasses of a class from being traced by the specified Tracer Group. Class name must be fully qualified.
The expected syntax is "SkipIfInheritedForFlag: <class-name> <Tracer-group>".
SkipMatchingClassesForFlag
Args: 2
Prevents all classes that match the class name expression from being traced by the specified Tracer Group.
The expected syntax is "SkipMatchingClassesForFlag: <class-pattern> <Tracer-group>".
SkipMatchingMethodsForFlag
Args: 2
Prevents all methods that match the method name expression from being traced by the specified Tracer Group.
The expected syntax is "SkipMatchingMethodsForFlag: <method-pattern> <Tracer-group>".
SkipMethodForClass
Args: 2
Prevents the specified method in the associated class from being traced. Class name must be fully qualified.
The expected syntax is "SkipMethodForClass: <class-name> <method>".
SkipMethodForFlag
Args: 2
Prevents the specified method(s) from being traced by the specified Tracer Group.
The expected syntax is "SkipMethodForFlag: <Tracer-group> <method>".
SkipNamespace
Args: 1
Prevents all classes in the specified namespace from being traced.
The expected syntax is "SkipNamespace: <namespace>".
SkipNamespaceForFlag
Args: 2
Prevents all classes in the specified namespace from being traced by the specified Tracer Group.
The expected syntax is "SkipNamespaceForFlag: <namespace> <Tracer-group>".
SkipNamespacePrefix
Args: 1
Prevents all classes that begin with the specified namespace prefix from being traced.
The expected syntax is "SkipNamespacePrefix: <namespace-prefix>".
SkipNamespacePrefixForFlag
Args: 2
Prevents all classes that begin with the specified namespace prefix from being traced by the specified Tracer Group.
The expected syntax is "SkipNamespacePrefixForFlag: <package-prefix> <Tracer-group>".
SkipPackage
Args: 1
Prevents all classes in the specified package from being traced.
The expected syntax is "SkipPackage: <package-name>".
SkipPackageForFlag
Args: 2
Prevents all classes in the specified package from being traced by the specified Tracer Group.
The expected syntax is "SkipPackageForFlag: <package-name> <Tracer-group>".
SkipPackagePrefix
Args: 1
Prevents all classes that begin with the specified package prefix from being traced.
The expected syntax is "SkipPackagePrefix: <package-prefix>".
SkipPackagePrefixForFlag
Args: 2
Prevents all classes that begin with the specified package prefix from being traced by the specified Tracer Group.
The expected syntax is "SkipPackagePrefixForFlag: <package-prefix> <Tracer-group>".
SkipStaticMethodsForFlag
Args: 1
Prevents all static methods from being traced by the specified Tracer Group.
The expected syntax is "SkipStaticMethodsForFlag: <Tracer-group>".
SubstituteClass
Args: 2 This directive is for internal system use only.
SubstituteClassIfFlagged
Args: 2 This directive is for internal system use only.
SubstituteResultByNamedProxyIfFlagged
Args: 2 This directive is for internal system use only.
SubstituteResultIfFlagged
Args: 2 This directive is for internal system use only.
SubstituteStaticField
Args: 2 This directive is for internal system use only.
SubstituteStaticFieldIfFlagged
Args: 2 This directive is for internal system use only.
SubstituteStaticMethod
Args: 2 This directive is for internal system use only.
SubstituteStaticMethodIfFlagged
Args: 2 This directive is for internal system use only.
TraceAllComplexMethodsIfFlagged
Args: 3
The expected syntax is "TraceAllComplexMethodsIfFlagged: <Tracer¬group> <Tracer-name> <Resource-Metric>".
TraceAllComplexMethodsWithThresholdIfFlagged
Args: 4
The expected syntax is "TraceAllComplexMethodsWithThresholdIfFlagged: <Tracer-group> <Tracer-name> <Resource-Metric> <threshold>".
TraceAllMethodsIfCorba
Args: 2
Traces all methods except for constructors (<init>) and static initializers (<clinit>) for CORBA-related classes. CORBA classes are limited to stubs and skeleton classes, and are identified by matching the patterns "_st_" & "_sk_" in class names. For use with Single-Metric Tracers.
The expected syntax is "TraceAllMethodsIfCorba: <Tracer-name> <Resource-Metric>".
TraceAllMethodsIfFlagged
Args: 3
Traces all methods except for constructors (<init>) and static initializers (<clinit>) for classes associated with specified Tracer Group.
The expected syntax is "TraceAllMethodsIfFlagged: <Tracer-group> <Tracer-name> <Resource-Metric>".
TraceAllMethodsIfInherits
Args: 3
Traces all methods except for constructors (<init>) and static initializers (<clinit>) in all direct subclasses of the specified class or direct implementations of the specified interface. The specified class or interface should be the fully qualified name.
The expected syntax is "TraceAllMethodsIfInherits: <class-name> <Tracer-name> <Resource-Metric>".
TraceAllMethodsOfClass
Args: 3
Traces all methods except for constructors (<init>) and static initializers (<clinit>) in the specified class. Class name should be fully qualified.
The expected syntax is "TraceAllMethodsOfClass: <class-name> <Tracer-name> <Resource-Metric>".
TraceAllMethodsWithThresholdIfFlagged
Args: 4
Traces all methods that finish before or beyond the threshold specified in milliseconds except for constructors (<init>) and static initializers (<clinit>) for classes associated with specified Tracer Group. Works with variations of the following Tracers: StalledMethodTracer, OverThresholdPerIntervalCounter, and UnderThresholdPerIntervalCounter.
The expected syntax is "TraceAllMethodsWithThresholdIfFlagged: <Tracer-group> <Tracer-name> <Resource-Metric> <threshold>".
TraceAllMethodsWithThresholdOfClass
Args: 4
Traces all methods that finish before or beyond the threshold specified in milliseconds except for constructors (<init>) and static initializers (<clinit>) for the specified class. Works with variations of the following Tracers: StalledMethodTracer, OverThresholdPerIntervalCounter, and UnderThresholdPerIntervalCounter. Class name should be fully qualified.
The expected syntax is "TraceAllMethodsWithThresholdOfClass: <class¬name> <Tracer-name> <Resource-Metric> <threshold>".
TraceAnnotatedMethodsIfFlagged
Args: 4
Traces all methods that are annotated with specified annotation for classes associated with specified Tracer Group.
The expected syntax is "TraceAnnotatedMethodsIfFlagged: <Tracer¬group> <class> <Tracer-name> <Resource-Metric>".
TraceAnnotatedMethodsWithParametersIfFlagged
Args: 4
Traces all methods that are annotated with specified annotation for classes associated with specified Tracer Group and reports metrics separately by value(s) of parameter(s) passed. The Metric name can include strings like "{#}" that are substituted with the value of the parameter at index # (where 0 is the first parameter, 1 is the second parameter, etc).
The expected syntax is "TraceAnnotatedMethodsWithParametersIfFlagged: <Tracer-group> <class> <Tracer-name> <Resource-Metric>".
TraceComplexMethodsIfFlagged
Args: 3
On Java, traces all public or package-visible non-synthetic methods that call any other method, except constructors (<init>) and static initializers (<clinit>) for classes associated with specified Tracer Group. On .NET, traces all public non-synthetic methods that call any other method, except instance constructors (“.ctor”) and class constructors (“.cctor”) for classes associated with specified Tracer Group. Synthetic methods are ones that do not appear in the source code and are added by the compiler.
The expected syntax is "TraceComplexMethodsIfFlagged: <Tracer-group> <Tracer-name> <Resource-Metric>".
Note:
For more information, see TEC1383568.
TraceComplexMethodsWithParametersIfFlagged
Args: 3
Traces all public or package-visible non-synthetic methods that call any other method, except constructors (<init>) and static initializers (<clinit>) for classes associated with specified Tracer Group and reports metrics separately by value(s) of parameter(s) passed. The Metric name can include strings like "{#}" that are substituted with the value of the parameter at index # (where 0 is the first parameter, 1 is the second parameter, etc). Synthetic methods are ones that do not appear in the source code and are added by the compiler.
The expected syntax is "TraceComplexMethodsWithParametersIfFlagged: <Tracer-group> <Tracer-name> <Resource-Metric>".
TraceComplexMethodsWithThresholdIfFlagged
Args: 4
On Java, traces all public or package-visible non-synthetic methods that call any other method, except constructors (<init>) and static initializers (<clinit>), which finish before or beyond the threshold specified in milliseconds, for classes associated with specified Tracer Group. On .NET, traces all public non-synthetic methods that call any other method, except instance constructors (“.ctor”) and class constructors (“.cctor”), which finish before or beyond the threshold specified in milliseconds, for classes associated with specified Tracer Group. Synthetic methods are ones that do not appear in the source code and are added by the compiler. Works with variations of the following Tracers: StalledMethodTracer, OverThresholdPerIntervalCounter, and UnderThresholdPerIntervalCounter.
The expected syntax is "TraceComplexMethodsWithThresholdIfFlagged: <Tracer-group> <Tracer-name> <Resource-Metric> <threshold>".
TraceMatchingMethodsIfFlagged
Args: 4
Traces all methods that match the method name expression for classes associated with specified Tracer Group.
The expected syntax is "TraceMatchingMethodsIfFlagged: <Tracer-group> <method-pattern> <Tracer-name> <Resource-Metric>".
TraceOneMethodIfCorba
Args: 3
Traces a specific method in CORBA classes. CORBA classes are limited to stubs and skeleton classes, and are identified by matching the patterns "_st_" & "_sk_" in class names.
The expected syntax is "TraceOneMethodIfCorba: <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodIfFlagged
Args: 4
Traces a specific method in all classes associated with the specified Tracer Group.
The expected syntax is "TraceOneMethodIfFlagged: <Tracer-group> <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodIfInherits
Args: 4
Traces a specific method in all direct subclasses of the specified class or in all direct implementations of the specified interface. The specified class or interface should be the fully qualified name.
The expected syntax is "TraceOneMethodIfInherits: <class-name> <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodOfClass
Args: 4
Traces a specific method in the specified class. Class name should be fully qualified.
The expected syntax is "TraceOneMethodOfClass: <class-name> <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodWithLabelIfInherits
Args: 6
Traces a specific method in all subclasses of the specified class or in all implementations of the specified interface. The specified class or interface should be the fully qualified name. The label parameter assigned to the tracer is used for query by DI API.
The expected syntax is "TraceOneMethodWithLabelIfInherits: <class-name> <method> <label> <Tracer-name> <Tracer-group> <Resource-Metric>".
TraceOneMethodWithLabelOfClass
Args: 6
The expected syntax is "TraceOneMethodWithLabelOfClass: <class-name> <method> <label> <Tracer-name> <Tracer-group> <Resource-Metric>".
TraceOneMethodWithParametersIfCorba
Args: 3
Traces a specific method in CORBA classes and reports metrics separately by the value of arguments passed. CORBA classes are limited to stubs and skeleton classes, and are identified by matching the patterns "_st_" & "_sk_" in class names. The Metric name can include strings like "{#}" that are substituted with the value of the parameter at index # (where 0 is the first parameter, 1 is the second parameter, etc).
The expected syntax is "TraceOneMethodWithParametersIfCorba: <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodWithParametersIfFlagged
Args: 4
Traces a specific method in all classes associated with the specified Tracer Group. In addition, records passed argument values. Primarily used to capture argument values passed in method invocations to display separate Metrics per argument value or with ErrorDetector-related Tracer Types to display error messages in Error Snapshots. The Metric name can include strings like “{#}” that are substituted with the value of the parameter at index # (where 0 is the first parameter, 1 is the second parameter, etc).
The expected syntax is "TraceOneMethodWithParametersIfFlagged: <Tracer-group> <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodWithParametersIfInherits
Args: 4
Traces a specific method in all direct subclasses of the specified class or in all direct implementations of the specified interface. In addition, records passed argument values. Primarily used to capture argument values passed in method invocations to display separate Metrics per argument value or with ErrorDetector-related Tracer Types to display error messages in Error Snapshots. The specified class or interface should be the fully qualified name. The Metric name can include strings like “{#}” that are substituted with the value of the parameter at index # (where 0 is the first parameter, 1 is the second parameter, etc).
The expected syntax is "TraceOneMethodWithParametersIfInherits: <class-name> <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodWithParametersOfClass
Args: 4
Traces a specific method in the specified class. In addition, records passed argument values. Primarily used to capture argument values passed in method invocations to display separate Metrics per argument value or with ErrorDetector-related Tracer Types to display error messages in Error Snapshots. Class name should be fully qualified. The Metric name can include strings like “{#}” that are substituted with the value of the parameter at index # (where 0 is the first parameter, 1 is the second parameter, etc).
The expected syntax is "TraceOneMethodWithParametersOfClass: <class-name> <method> <Tracer-name> <Resource-Metric>".
TraceOneMethodWithThresholdIfFlagged
Args: 5
Traces a specific method for classes associated with specified Tracer Group and reports metrics for invocations that finish before or beyond the threshold specified in milliseconds. Works with variations of the following Tracers: StalledMethodTracer, OverThresholdPerIntervalCounter, and UnderThresholdPerIntervalCounter.
The expected syntax is "TraceOneMethodWithThresholdIfFlagged: <Tracer-group> <method> <Tracer-name> <Resource-Metric> <threshold>".
TraceOneMethodWithThresholdOfClass
Args: 5
Traces a specific method for a specified class and reports metrics for invocations that finish before or beyond the threshold specified in milliseconds. Class name should be fully qualified. Works with variations of the following Tracers: StalledMethodTracer, OverThresholdPerIntervalCounter, and UnderThresholdPerIntervalCounter.
The expected syntax is "TraceOneMethodWithThresholdOfClass: <class-name> <method> <Tracer-name> <Resource-Metric> <threshold>".
TraceRemoteMethodsIfCorba
Args: 2
Traces methods exposed via RMI in CORBA classes. CORBA classes are limited to stubs and skeleton classes, and are identified by matching the patterns "_st_" & "_sk_" in class names. Directive selects methods based on whether or not they throw an RMIException.
The expected syntax is "TraceRemoteMethodsIfCorba: <Tracer-name> <Resource-Metric>".
TraceRemoteMethodsIfFlagged
Args: 3
Traces methods exposed via RMI in classes associated with the specified Tracer Group. Directive selects methods based on whether or not they throw an RMIException.
The expected syntax is "TraceRemoteMethodsIfFlagged: <Tracer-group> <Tracer-name> <Resource-Metric>"
TraceRemoteMethodsIfInherits
Args: 3
Traces methods exposed via RMI in all direct subclasses of the specified class or in all direct implementations of the specified interface. Directive selects methods based on whether or not they throw an RMIException. The specified class or interface should be the fully qualified name.
The expected syntax is "TraceRemoteMethodsIfInherits: <class-name> <Tracer-name> <Resource-Metric>".
TraceRemoteMethodsOfClass
Args: 3
Traces methods exposed via RMI in the specified class. Directive selects methods based on whether or not they throw an RMIException. Class name should be fully qualified.
The expected syntax is "TraceRemoteMethodsOfClass: <class-name> <Tracer-name> <Resource-Metric>".
TurnOff
Args: 1
A toggle for deactivating the specified Tracer Group. It overrules the TurnOn directive.
The expected syntax is "TurnOff: <Tracer-group>".
TurnOn
Args: 1
A toggle for activating the specified Tracer Group.
The expected syntax is "TurnOn: <Tracer-group>".