A unique label for the directive. This is a mandatory parameter.

Test:
  ...
Test2:
  ...
Test3:
  ...

The name of the class you want to monitor. You must specify the full class name, including the package.

Test:  
  class_name: "com.oracle.apm.samples.servlet.OutboundTestServlet"

A regular expression (regex) pattern to monitor any class that matches it.

For the regex pattern, instead of using "." for the package, use "/". For example, if you want to monitor a class called a.b.c.d.ClassName, then the regex pattern should match against a/b/c/d/ClassName.

If both class_name_regex and class_name are specified, then class_name is ignored.

Test:
  # Monitor all classes under the com.oracle.apm.test package
  class_name_regex: "com/oracle/apm/test/.*"

The name of the method you want to monitor. This does not include method parameters.

If method_name is not specified, then all methods are monitored.

Test:
  class_name: "com.oracle.apm.samples.servlet.OutboundTestServlet"
  method_name "performHttpURLConnectionCall"

A regex pattern to monitor any method that matches it.

If method_name_regex is not specified, then all methods are monitored.

If both method_name_regex and method_name are specified, then method_name is ignored.

Test:
  class_name: "com.oracle.apm.samples.servlet.OutboundTestServlet"
  # Monitor all methods that start with "perform"
  method_name_regex: "perform.*"

The full class name of the annotation you want to monitor. Any class with the specified annotation is monitored.

Test:
  class_annotation: "javax.jws.WebService"

The full class name of the annotation you want to monitor. Any method with the specified annotation is monitored.

Test:
  method_annotation: "javax.jws.WebMethod"

A regex pattern to monitor any class annotation that matches it.

For the regex pattern, instead of using "." for the package, use "/". Also, the value should begin with "L" and end with ";". For example, if you want to monitor an annotation called a.b.c.d.Annotation, then the regex pattern should match against La/b/c/d/Annotation;.

If both class_annotation_regex and class_annotation are specified, then class_annotation is ignored.

Test:
  # Monitor all Path annotations in javax
  class_annotation_regex: "Ljavax/.*/Path;"
Test2:
  # Monitor all annotations that end with "Path"
  # The L in the beginning is not required since .* includes it
  class_annotation_regex: ".*/Path;"
Test3:
  # Monitor all annotations with the javax.jws package
  # The ; at the end is not required since .* includes it
  class_annotation_regex: "Ljavax/jws/.*"

A regex pattern to monitor any method annotation that matches it.

For the regex pattern, instead of using "." for the package, use "/". Also, the value should begin with "L" and end with ";". For example, if you want to monitor an annotation called a.b.c.d.Annotation, then the regex pattern should match against La/b/c/d/Annotation;.

If both method_annotation_regex and method_annotation are specified, then method_annotation is ignored.

Test:
  # Monitor all Path annotations in javax
  method_annotation_regex: "Ljavax/.*/Path;"
Test2:
  # Monitor all annotations that end with "Path"
  # The L in the beginning is not required since .* includes it
  method_annotation_regex: ".*/Path;"
Test3:
  # Monitor all annotations with the javax.jws package
  # The ; at the end is not required since .* includes it
  method_annotation_regex: "Ljavax/jws/.*"

Specify if subclasses of the target class must be monitored. By default, this is set to false.

Test:
  class_name: "com.oracle.apm.samples.servlet.OutboundTestServlet"
  method_name "performHttpURLConnectionCall"
  include_sub_classes: true

The name of the span created during monitoring. If the span_name is not specified, "${class_name}.${method_name}" is used by default.

Note that you can specify a name for the span, as shown under the Test label in the corresponding example, which will then be used every time the monitored target is invoked.

When specifying the span_name parameter, you can also use variables, ${variable_name} and Advanced Variables, to acquire additional information regarding the parameters you're monitoring and display them in the name of the span. In the corresponding example, under the Test2 label, the param# variable denotes the parameters aligned with the method you're monitoring.

Test:
  ...
  # The same name will be used every time the target class/method is invoked
  span_name: "SpecialName"
Test2:
  ...
  # Use the toString result of the first parameter passed to the monitored method
  span_name: "${param1}"

The tags (names and values) to be included in the span.

As in the case of the span_name parameter, you can use variables when specifying values for tags to acquire and display additional information regarding the parameters you're monitoring.

Note that the tags you specify are displayed as Dimensions in the Trace Explorer user interface.

For tag values, an optional type can be specified. You can specify the tag value to be of type String, Boolean, Integer, Long, Float, or Double by using the appropriate syntax and keyword (as shown in the example). The default tag value type will be String. This will be used if no type or an incompatible type is specified. If an incompatible type is specified for a tag value, the type will revert to the default of String, and there will be a log message about the incompatibility. The span dimension value can be confirmed through queries with aggregations that leverage numeric values (if applicable) in the Trace Explorer.

Test:
  ...
  tags:
    importantInfo: "${param1}"
    consistentTag: "AlwaysTheSame"
    returnValue: "${return}"
    #The below tag will have value of default type String since no type was specified
    defaultTagType: "${param1}"
    #The below tag will have value of type Integer
    integerTag: "${param1} | integer"
    #The below tag will have value of type String, because the actual value type String, and the specified type Double are incompatible. Therefore it will default to String.
    booleanTag: "${param2} | double"

The logs (names and values) you want to be included in the span.

As in the case of the span_name and tags parameters, you can also use variables when specifying values for the logs parameter to acquire and display additional information regarding the parameters you are monitoring.

Note that the logs you specify are displayed as Span Logs in the Trace Explorer user interface.

Test:
  ...
  logs:
    importantInfoLog: "${param1}"
    consistentLog: "AlwaysTheSame"
    returnValueLog: "${return}"
  ...