App Agent Node Properties (D-E)

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

disable-agent

This property enables/disables the agent. When this property is set to true, TransactionEntryPoints will not be monitored. No new BTs or metrics will be registered, metrics, and snapshots will not be reported. Agent background threads will not be stopped. When set to false, the agent becomes active immediately. It does not need a restart.
Type Default value Platform(s)
Boolean False Java

disable-agent-api

This property disables all calls to the agent-api library. The calls function as no-ops when disabled.
Type Default value Platform(s)
Boolean False Java

disable-custom-exit-points-for

Disables certain types of automatically detected exit points: SAP, Mail, LDAP, and so on. Type names are case sensitive. Use commas to separate multiple types.
Type Default value Supported values Platform(s)
String none CASSANDRA, Coherence, DangaMemcache, EHCache, LDAP, Memcache, MongoDB, RABBIT_MQ, REDIS, RMI, SAP, THRIFT Java

disable-dynamic-services

Use this property to disable dynamic services. You can provide a comma-separated string of dynamic service folder names mentioned in the external-services folder. The dynamic services mentioned in this property do not start with the agent.

Example value:

CODE 
netviz,analytics,secapp

You can edit the property in app-agent-config.xml.

Note that:

  • For analytics, you can disable the service using this property. However, the licenses are consumed for Transactional Analytics. To disable the license consumption, you must disable it as a node property in the Controller UI. See Disable Transaction Analytics License Consumption.

  • For .NET agent, you can disable Secure App services by adding secapp to the list of disabled services.
Type Default value Platform(s)
String none .NET, Java

disable-exit-call-correlation-for

Disable exit call correlation for a specific type of call. For example, KAFKA, WCF, WEB_SERVICE, HTTP, JMS, and RMI. By default, all exit call correlations are enabled.
Type Default value Platform(s)
String none Java, .NET

disable-exit-call-metrics-for

Disables exit call monitoring for a specific type of exit call; for example, HTTP, JMS, WEB_SERVICE. If this property is set, the average data—calls/min, avg response time— for the specific exit call type is not collected. However, for a snapshot, all details are collected. Set this property if the application makes a large number of exit calls per transaction and the avg metrics are not important.
Type Default value Platform(s)
String By default, all exit call metrics are enabled. Java, .NET

disable-percentile-metrics

App agents that support percentile metrics enable collection by default. Disable percentile metrics on the Configuration > Slow Transaction Thresholds window or set this node property manually to true to disable percentiles.

Changes to this property do not require an agent restart.

Type Default value Platform(s)
Boolean false Java, .NET

disable-service-monitoring-metrics

This property stops the BT-to-BT incoming cross-application metrics to be reported (but normal cross-application metrics continue to be reported, as expected).
Type Default value Platform(s)
Boolean True Java

disable-soap-header-correlation-non-http

This property controls correlation with web service transactions. When enabled, it prevents injection of the correlation header into a SOAP message if the WCF transport is not over HTTP or HTTPS.
Type Default value Platform(s)
Boolean false Java, .NET
For more information, see WCF Entry Points.

disabled-features

Specifies types of data for which agent reporting to suppress. Use this property provides to disable data collection mechanisms at the agent to limit data reported by the agent for security or privacy reasons. This agent configuration overrides any Controller configuration that affects the data.

You can disable:

  • LOG_PAYLOAD: Log payload, such as the node property log-request-payload
  • RAW_SQL: Raw SQL statements
  • CUSTOM_EXIT_SNAP_DATA: Snapshot data in custom exits
  • METHOD_INV_DATA_COLLECTOR: Diagnostic data collectors, method invocation
  • HTTP_DATA_COLLECTOR: Diagnostic data collectors, HTTP requests
  • INFO_POINT: Information points
  • ALL: All of the above
  • NONE: None of the above. This is equivalent to the default agent behavior.
Type Default value Platform(s)
String none Java

Examples

Configure disabled features in the app-agent-config.xml in the versioned conf directory for the agent. Specify the data category as the value attribute of the disabled-features property. You can have multiple data categories excluded by listing each separated by commas. For example:

With capture-raw-sql enabled, Splunk AppDynamics captures the SQL call in the following form:
CODE 
<app-agent-configuration>
  <configuration-properties>
        ....
        <property name="disabled-features" value="RAW_SQL,LOG_PAYLOAD"/>
  </configuration-properties>
  .....
</app-agent-configuration>

disable-ibmbpm-data-collectors

Sets whether data-collectors for IBM-BPM task business transactions should be disabled (value=true) or enabled (value=false).
Type Default value Platform(s)
Boolean false Java

disable-ibmbpm-usertask-bt-in-process-correlation

Sets whether business transactions in-process correlation for IBM-BPM UserTask business transactions should be disabled (value=true) or enabled (value=false).
Type Default value Platform(s)
Boolean false Java

disable-ibmbpm-usertask-bt-naming

Sets whether business transactions naming scheme for IBM-BPM UserTask Business Transactions should be disabled (value=true) or enabled (value=false).When it is set to true,the Business Transactions would be named as per the default URL and not the meaningful names.
Type Default value Platform(s)
Boolean false Java

dev-mode-suspend-cpm

The maximum number of transactions monitored per minute during development mode before the system switches out of development mode into normal operation mode.
Type Default value Range Platform(s)
Integer 500 Minimum=0; Maximum=N/A Java

dont-show-packages

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

downstream-tx-detection-enabled

If the agent cannot reach the controller for a prolonged period, it turns off most services and notifies the continuing tiers that upstream transaction was detected and is not being monitored. Set this property to true to enable the continuing tiers to detect their own transactions in the event of network failure on the upstream tiers.
Type Default value Platform(s)
Boolean false Java, .NET

enable-all-rsd-error-propagation

This property enables the agent to recognize errors that occur in calls outside of or tangential to business transactions.

false: All business transaction errors are reported, but errors outside of the business transaction are not reported.

true: All business transaction errors are reported. In addition, errors outside of the business transaction are reported. For example, errors generated from tracking analytics for a business transaction are reported.

full-disable: No asynchronous errors are recognized.

Type Default value Platform(s)
Boolean false Java, .NET

enable-async-service-endpoints

By default the Java Agent automatically detects service endpoints for worker threads. Set this property to "false" to disable service endpoint detection for worker threads. This has the same effect as the Automatic Service Endpoint Detection checkbox for other types of service endpoints on Configuration > Instrumentation > Service Endpoints.
Type Default value Platform(s)
Boolean true Java

enable-async2-eum-context-lookup

When EUM is enabled on applications implemented using the Servlet3 async dispatch mechanism, it is possible that multiple EUM correlation headers are added to the response.

This node property prevents duplicate ADRUM headers being injected in the HTTP response from Java Agent.

Type Default value Platform(s)
Boolean false Java

enable-axon-entry

This node property is used to disable axon entry. By default, it is enabled.
Type Default value Platform(s)
Boolean true (By default, axon entry is enabled.) Java

enable-boundedcollection-overflow-capture

When set to true, the Bounded Collection errors (Agent errors) are reported along with application errors.

You can edit the property in app-agent-config.xml.

Type Default value Platform(s)
Boolean false Java

enable-axon-exit

This node property is used to disable axon exit. By default, it is enabled.
Type Default value Platform(s)
Boolean true (By default, axon entry is enabled.) Java

enable-bt-block-wait-time-monitoring

This property controls capture of per BT block and wait time metrics. It is disabled by default.
Type Default value Platform(s)
Boolean false - (Disabled by default) Java

enable-bt-cpu-time-monitoring

This property controls whether the agent captures the CPU time taken by a business transaction.
Type Default value Platform(s)
Boolean true Java

enable-default-http-error-code-reporter

This property disables or enables automatic HTTP error code reporting for error codes between 400 to 505.
Type Default value Platform(s)
Boolean true Java, .NET

enable-eum-bt-duration

Set this property to true to inject the business transaction duration value in the EUM metadata for HttpServlets in cookies/headers. If you are not EUM user, you must not configure this property to avoid the cost related to business transaction duration calculations. To know how mobile network requests correlate with business transactions, see

Correlate Business Transactions for Mobile RUM .

Type Default value Platform(s)
Boolean false Java

enable-http-error-code-url-report

Set this node property to true to enable URL reporting of detected HTTP error codes in snapshots.
Type Default value Platform(s)
Boolean false Java

enable-ignore-nested-exception-message

When set to true, it ignores the nested exception messages.
Type Default value Platform(s)
Boolean false Java, .NET

enable-info-point-data-in-snapshots

This property disables or enables the capture of information point calls in snapshots. When this property is set to true, information point calls appear in the User Data section of the snapshot.
Type Default value Platform(s)
Boolean false Java, .NET

enable-instance-monitoring

This property enables or disables Instance tracking on this node. Does not need a JVM restart.
Type Default value Platform(s)
Boolean false Java

enable-interceptors-for-security

This property enables or disables security interceptors on this node. Set this property to true in environments where the Java 2 Security Manager is enabled. If the Java 2 Security Manager is enabled, and this property is not set to true, then the agent will encounter Security Exceptions, and will not be able to collect the data that it should. Does not need a JVM restart.
Type Default value Platform(s)
Boolean false Java

enable-json-bci-rules

Set this property to true to enable JSON bytecode instrumentation rules. Splunk AppDynamics instruments the get and getString methods within the package/class org.json.JSONObject when you set this value to true. Needs a JVM restart.
Type Default value Platform(s)
Boolean true (This only affects new applications; applications created with a 3.7.x controller will still have this property set by default to false.) Java

enable-kafka-consumer

Set the enable-kafka-consumer to true to enable Apache Kafka consumer entry points. For more information see 'Apache Kafka Backends' on Java Backend Detection.
Type Default value Platform(s)
Boolean false Java

enable-object-size-monitoring

This property is related to Automatic Leak Detection (ALD) and enables or disables Object Size monitoring on this node. Changing this property does not need a JVM restart. ALD is supported for JVM version 1.6 and up.
Type Default value Platform(s)
Boolean false Java

enable-openai-metrics

When set to true, this property enables OpenAI API metrics monitoring and reporting on Java Agent. See Monitor OpenAI API with Java Agent.
Type Default value Platform(s)
Boolean false Java

enable-quarkus-resteasy-vertx-entry

This property enables the Vert.x entry point for Quarkus. This is applicable in rare situations where Netty instrumentation negatively impacts performance for Quarkus RestEasy, and the netty-enabled setting is configured to false.
Type Default value Platform(s)
Boolean false Java

enable-reverse-proxy

When set to true, it enables the reverse proxy for Java Agent.
Type Default value Platform(s)
Boolean false Java

enable-soap-header-correlation

This property controls correlation with web service transactions. When enabled, a node which receives a web service transaction may correlate that transaction with any downstream transactions. The ability to correlate depends on the particular web services framework. Currently, correlation is supported only by Apache Synapse and CXF frameworks. When disabled, the agent will not perform correlation through any web service tiers.
Type Default value Platform(s)
Boolean false Java, .NET

enable-spring-actuator-metrics

Set this property to true to enable the reporting of application metrics. You must configure the spring-actuator-port node property if you are using a custom port.
Type Default value Platform(s)
Boolean false Java

enable-spring-integration-entry-points

This property disables or enables the default detection of Spring Integration entry points. Set to false to disable.

Default detection of Spring Integration entry points is based on MessageHandler. In cases where a lot of application flow happens before the first MessageHandler is executed:

See also Spring Integration Support.

Type Default value Platform(s)
Boolean true Java

enable-spring-rest-client-correlation

This property disables or enables the correlation support for the Spring Rest client.
Type Default value Platform(s)
Boolean none Java

enable-spring-ws-dom-parser-rules

This property enables to split web service business transactions on the SOAP XML payload. Set the value to true to enable the property. You can modify namespace context mapping (mapping of the prefix to URI) to parse SOAP message property in the app-agent-config.xml file.
Type Default value Platform(s)
Boolean false Java

enable-startup-snapshot-policy

This property disables or enables the policy for start-up transaction snapshot. This means snapshots are collected for all BTs for all invocations for the first 2 minutes of application server startup.
Type Default value Platform(s)
Boolean false Java, .NET

enable-transaction-correlation

This property disables or enables transaction correlation. It does not require a restart.
Type Default value Platform(s)
Boolean true Java, .NET

enable-vertx-http

Enable or disable servlet HTTP entry points and exit points for Vert.x.
Type Default value Platform(s)
Boolean true Java

enable-vertx-message-entry

Enable or disable Vert.x verticle message entry points for continuing transactions.
Type Default value Platform(s)
Boolean true Java

enable-xml-bci-rules

This property enables Java XML Binding and DOM Parser bytecode instrumentation rules. Set to true to enable. The change takes effect after a JVM restart.
Type Default value Platform(s)
Boolean true (This only affects new applications; applications created with a 3.7.x Controller will still have this property set by default to false.) Java

end-to-end-message-latency-threshold-millis

Enables end-to-end message latency monitoring for distributed asynchronous systems by setting up a threshold. Any message taking more time than the threshold is viewable through the Event Viewer.
Type Default value Range Platform(s)
Integer 0 Minimum=0; Maximum=36000 Java

exceptions-to-ignore

By default, configuring an exception to be ignored in the error detection settings prevents the ignored exception thus marking any Business Transaction that experiences it as in error. However, it does not prevent the occurrences of the exception being tracked in the Errors and Exceptions dashboard.

To completely ignore certain exceptions, provide their fully qualified class names in this node property.

For example, oracle.jdbc.DatabaseException.

Multiple exceptions can be added that are comma-separated.

Note: It is recommended to use this property with caution because it removes all visibility of the impact of exceptions configured in this way.
Type Default value Platform(s)
String 0 Java