App Agent Node Properties (N-R)

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

In general use caution when modifying the agent default settings. If increasing limits specified for an agent, you need to carefully assess and monitor memory consumption by the agent after the change.

nested-exception-message-depth

It defines the levels to which nested exception messages are ignored.
Type Default value Platform(s)
Integer 10 Java, .Net

normalize-prepared-statements

When this flag is set to true, any variables in prepared statement SQL would be substituted with '?' before query text is added to any snapshots.
Type Default value Platform(s)
Boolean true Java

nservicebus-single-threaded

Specify the threading architecture for the NServiceBus message queue. The value defaults to true. For multithreaded queue implementations, change the value to false. See NServiceBus Backends for .NET.
Type Default value Platform(s)
Boolean true .Net

osb-ignore-exit-types

This comma-separated property defines which exits protocols (as configured in the Transport Configuration pane) are excluded from detection as uncorrelated custom backends.

Set the property to 'all', if you do not want to detect any exit.

Type Default value Platform(s)
String http,jms Java

on-demand-snapshots

Collect snapshots for all Business Transactions executed in this node. Does not need a restart. This property is ignored in the Development mode.
Type Default value Platform(s)
Boolean false Java, .Net

percentile-method-option

You can choose one of two different algorithms to calculate percentiles in Splunk AppDynamics:
  • P Square algorithm (default): This option consumes the least amount of storage and incurs the least amount of CPU overhead. The accuracy of the percentile calculated varies depending on the nature of the distribution of the response times. You should use this option unless you doubt the accuracy of the percentiles presented.
  • Quantile Digest algorithm: This option consumes slightly more storage and CPU overhead but may offer better percentiles depending on how the response times are distributed.

Changes to this property do not require that you restart the agent.

Type Supported Values Default value Platform(s)
Numeric
  • 1: P Square
  • 2: Quantile Digest
 1 Java, .Net

prometheus-metric-uri

This property configures the default Prometheus endpoint.
Type Default value Platform(s)
String http://localhost:8080/q/metrics Java

prometheus-metric-report-initial-delay

This property configures the metric report initial delay in seconds.
Type Default value Platform(s)
Integer 60 Java

prometheus-metric-report-interval

This property scales metrics to display a floating-point number between 0 and 1.

The scaled metric can also be renamed. Use the following configuration format.

CODE 
metricName*scalingFactor>newMetricName,metricName2*scalingFactor2>newMetricName2

Example

CODE 
http_request_latency_in_sec*1000>http_request_latency_in_ms

prometheus-metric-drop-labels

Configure this property to remove metric labels. This decrease the total number of metrics. If no metric name is specified, the drop configuration applies to all metrics. Use the original metric name if it has been renamed.

Use the following configuration format:

CODE 
labelName1,labelName2;metricName#labelName1,labelName2;metricName2#labelName1,labelName2

Example

CODE 
netty_allocator_pooled_cache_size#id

quarkus-scheduled-annotation-discovery

Note: This document contains references to third-party documentation. Splunk AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.
Set this property to true to enable the automatic instrumentation of Quarkus scheduled tasks as entry points. For more information on how to schedule period tasks, see Scheduling Periodic Tasks.
Type Default value Platform(s)
Boolean false Java

queue-single-threaded

Specify the threading architecture for the IBM MQ message queue. The value defaults to false.

When the IBM MQ Get() method is called, the transaction/snapshot is ended prematurely. To prevent this, set the agent node property: queue-single-threaded=true.

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

read-only-environment

By default, the Java agent identifies a read-only environment such as Azure Spring Cloud, and functions accordingly. However, this property allows you to manually specify whether the environment should be treated as read-only or not.

When set to true/false, it will override the default detection mechanism and enforce the specified read-only setting. It helps save entries and prevents business transaction loss during the agent restart.

Type Default value Platform(s)
Boolean none Java

reportingFrequencyInMillis

The agent property specifies the frequency of Request Segment Data (RSD) uploads from the agent.
Type Default value Platform(s)
Numeric 10000 ms Java

rest-num-segments

The property, rest-num-segments specifies the n in the first-n-segments parameter in rest-uri-segment-scheme. If this property is 0 or less, then the value of this property is ignored. The value of this property is also ignored if rest-uri-segment-scheme=full.
Type Default value Platform(s)
String 2 Java

rest-transaction-naming

This node property determines the format in which REST-based business transactions are named. You can use variables to populate the name with values bound at runtime. Any characters in the property value that do not match a variable are treated as literal text in the business transaction name, so you can, for example, separate variables with a colon, slash, or another character.

The agent takes each parameter and fills in the proper value based on the annotations and properties of the Java class:

  • {class-name}: The app agent will fill in the name of the Java class mapped to the REST resource.
  • {method-name}: The method being called.
  • {class-annotation}: Class annotation values.
  • {method-annotation}: Method annotation applied to the method (not always present).
  • {rest-uri}: URI of the REST resource. The REST URI is further configured using the following properties:
  • {http-method}: HTTP method of the request, GET, POST, and so on.
  • {param-%d}: A parameter to the method identified by position. Replace %d with the position of the parameter (ZERO-based).
Type Default value Platform(s)
String {class-annotation}/{method-annotation}.{http-method} Java

Examples

See Business Transaction Naming Scheme.

rest-uri-segment-scheme

The property, rest-uri-segment-scheme has three valid values: first-n-segments, last-n-segments, and full. This property indicates how many segments of the URI to use for the URI in {rest-uri}. This option is case-sensitive. If the value of this property is full, then the value of rest-num-segments is ignored.
Type Default value Platform(s)
String first-n-segments Java

rmqsegments

The App Agent for .NET (agent) automatically discovers RabbitMQ remote services. Use the rmqsegments node property to refine the queue backend name to include some or all segments of the routing key. You must be familiar with your implementation RabbitMQ exchanges and routing keys. See RabbitMQ Exchanges and Exchange Types.

The RabbitMQ routing key is a string. The agent treats dot-separated (".") substrings of the routing key as segments. Set the value for rmqsegments to an integer that represents the number of routing key segments to include in the name. For more details, see information on refining backend naming in RabbitMQ Backends for .NET.

Type Value Default value Platform(s)
Numeric Integer representing the number of routing key segments to include in the name. 0 .Net