App Agent Node Properties (S-Z)

This reference page contains information about app agent node properties. The properties are listed in alphabetical order.

sensitive-data-filters

Add the filters in the XML format specified in app-agent-config.xml. This node property does not override sensitive filter configuration from app-agent-config.xml and it does not apply to environment-variables and system-properties sent to controller.
Type Default value Platform(s)
String none Java

Example

CODE 
<sensitive-data-filters>
<sensitive-data-filter applies-to="http-headers,http-cookies,jmx-mbeans"
match-type="CONTAINS"
match-pattern="user"/>
</sensitive-data-filters>

sensitive-message-filters

Add the filters in the XML format specified in app-agent-config.xml. This node property does not override other node properties.
Type Default value Platform(s)
String none Java

Example

CODE 
<sensitive-message-filters>
        <sensitive-message-filter message-type="throwable,logger-message,all"
                                  match-type="EQUALS|CONTAINS|STARTSWITH|ENDSWITH|REGEX"
                                  match-pattern="CASESENSITIVE_PATTERN"
                                  redaction-regex="SENSITIVE_INFO_REGEX_GROUP"/>
     </sensitive-message-filters>

sensitive-url-filters

Add the filters in the XML format specified in app-agent-config.xml. This node property does not override sensitive filter configuration from app-agent-config.xml.
Type Default value Platform(s)
String none Java

Example

CODE 
<sensitive-url-filters>
        <sensitive-url-filter delimiter="/"
                                  segment="2,3"
                                  match-filter="EQUALS|INLIST|STARTSWITH|ENDSWITH|CONTAINS|REGEX|NOT_EMPTY"
                                  match-pattern="pattern"
                                  param-pattern=""/>
    </sensitive-url-filters>

show-packages

For the call graphs captured on this node, show the specified packages or class names in addition to the ones configured in the global call graph configuration. Does not need a restart.
Type Default value Platform(s)
String none Java, .NET

slow-request-deviation

The value in milliseconds for the deviation from the current average response time. This setting is used for evaluation of slow in-flight transactions. Also, see the slow-request-threshold property for more details.
Type Default value Range Platform(s)
Integer 200 Minimum=10; Maximum=3600 Java, .NET

slow-request-monitor-interval

In-flight requests are checked for slowness in the interval specified by this property. The value is specified in milliseconds.
Type Default value Range Platform(s)
Integer 100 Minimum=0; Maximum=3600 Java, .NET

slow-request-threshold

In-flight requests taking more time than this threshold (in ms) with a deviation greater than the slow-request-deviation property from the current average response time are monitored to capture hot spots.
Type Default value Range Platform(s)
Integer 500 Minimum=0; Maximum=3600 Java, .NET

socket-enabled

Use this property to enable NetViz monitoring of .NET and Java applications.
Type Default value Platform(s)
Boolean false (.Net) true (Java) .NET, Java

spring-actuator-port

Use this property to change the default port which Java Agent queries to get the application metrics.
Type Default value Platform(s)
Integer 8080 Java

spring-batch-enabled

Use this property to enable or disable OOTB BT Detection for Spring Batch.
Type Default value Platform(s)
Boolean true Java

spring-integration-receive-marker-classes

Use this property to specify the class and method you have identified as suitable POJO entry points for Spring Integration.

Based on the MessageHandler interface, the App Agent for Java by default automatically discovers exits for all channels except DirectChannel. In cases where a lot of application flow happens before the first MessageHandler is executed,

If the application code polls for messages in a loop, the span of each loop iteration is tracked as a transaction. Tracking begins when the loop begins and end it when the iteration ends. To safeguard against cases where pollableChannel.receive() is not called inside a loop, specify this property for each class/method combination that polls messages in a loop.

After setting this property, restart the application server for changes to this property to take effect.

Type Default value Platform(s)
Comma-separated string of fully-qualified class /method name, such as spring-integration-receive-marker-classes = ,<> .... none Java

Examples

For example, to enable tracking for the following:

CODE 
class MessageProcessor
{
void process()
{
   while(true)
   {
          Message message = pollableChannel.receive()
   }
}
}
set this property as follows:
CODE 
spring-integration-receive-marker-classes = MessageProcesser/process

See also Spring Integration Support.

spring-mvc-naming-scheme

Register this node property to modify the naming scheme for Spring MVC transactions. Bean ID cannot be used as a global naming type. Use the bean ID and method name for global.
Type Allowed values Default value Platform(s)
String bean-id, simple-class-name, fully-qualified-class-name, business-interface-name, bean-method-name, ben-id-and-method-name, class-and-method-name none Java

thread-correlation-classes

For multi-threaded applications, use this property to configure classes to be included in Java thread correlation when simple prefix-matching (matching on STARTSWITH) is sufficient to identify the classes.

The thread-correlation-classes property specifies the classes to include for thread correlation. This property can be used together with the thread-correlation-classes-exclude property.

The configured correlation takes effect without requiring a restart of the managed application. Also see, Configure the Thread Correlation in Java Agent.

Type Default value Platform(s)
Comma-separated string of fully-qualified class names or package names none Java

This property is not recommended for use in the Executor Mode.

thread-cpu-capture-overhead-threshold-in-ms

Determines the timeout allotted for collecting and calculating Thread CPU Time for 1000 iterations. If the timeout is exceeded, the Java Agent automatically disables CPU time collection for threads. CPU usage information will then be absent from the BT overview or snapshots in the Controller UI. In addition, an INFO-level log similar to the following appears in the logs:
CODE 
[Thread-0] 22 Oct 2013 14:19:26,346 INFO JVMThreadCPUTimeCalculator - Disabling BT CPU Monitoring. Time taken to calculate Thread CPU Time for [1000] iterations is [15 ms] which is greater than the allowed budget of [10 ms].

This issue may particularly affect JDK 1.6 on Linux due to the issue getCurrentThreadCpuTime is drastically slower than Windows Linux.

Type Default value Platform(s)
Integer 10 ms Java

Examples

You can increase the thread-cpu-capture-overhead-threshold-in-ms property, but it is important to note that this may result in increased overhead on your application. We recommend you use this Java HotSpot VM option instead to speed up the API call itself:

CODE 
-XX:+UseLinuxPosixThreadCPUClocks

Restart is needed after changing this value.

thread-correlation-classes-exclude

For multithreaded applications, use this property to configure classes to be excluded in Java thread correlation when simple prefix-matching (matching on STARTSWITH) is sufficient to identify the classes. This property specifies the classes to exclude from thread correlation. This property can be used in conjunction with the thread-correlation-classes node property.

The configured correlation takes effect without requiring a restart of the managed application. See Configure the Thread Correlation in Java Agent.

Type Default value Platform(s)
Comma-separated string of fully-qualified class names or package names none Java

This property is not recommended for use in the Executor Mode.

websocket-entry-calls-enabled

When set to false, no WebSocket entry calls are detected.
Type Default value Platform(s)
Boolean true Java

wcf-enable-eum

Enable and disable EUM correlation from a WCF node.
Type Default value Platform(s)
Boolean false .NET

Example

The enable EUM correlation, the WCF application must also have the following entry in the Web.Config:

CODE 
<serviceHostingEnvironment aspNetCompatibilityEnabled="true" />

See serviceHostingEnvironment.