View Source

<style>
.panel {
  max-width: 85%;
  min-width: 40%;
  margin: 5px;
  margin-left: 0px;
  margin-right: 5px;
}
.panelContent { 
  padding:0px;
margin: 1px;
}
.panelContent h2 {
  font-size: 36px;
}
.table-wrap {
  margin:0px;
}
.sectionColumnWrapper {
  margin: 0px;
  padding: 0px;
}
.sectionMacroWithBorder {
  padding:0px;
  margin: 0px;
}
</style>

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.

It defines the levels to which nested exception messages are ignored.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Integer</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>10</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java, .Net</td>
    </tr>
   </tbody>
</table>

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Boolean</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>true</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Boolean</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>true</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>.NET</td>
    </tr>
   </tbody>
</table>

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>String</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>http,jms</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

Collect snapshots for all Business Transactions executed in this node. Does not need a restart. This property is ignored in the Development mode.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Boolean</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>false</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java, .NET</td>
    </tr>
   </tbody>
</table>

You can choose one of two different algorithms to calculate percentiles in :

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Numeric</td>
    </tr>
    <tr>
      <td><strong>Supported Values:</strong></td>
	  <td>
          <ul>
            <li>1: P Square</li>
            <li>2: Quantile Digest</li>
          </ul>
      </td>
    </tr>
         <tr>
      <td><strong>Default value:</strong></td><td>1</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java, .NET</td>
    </tr>
   </tbody>
</table>

This property configures the default Prometheus endpoint.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>String</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>http://localhost:8080/q/metrics</td>
    </tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

This property configures the metric report initial delay in seconds.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Integer</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>60</td>
    </tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

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.

metricName*scalingFactor>newMetricName,metricName2*scalingFactor2>newMetricName2

Example: http_request_latency_in_sec*1000>http_request_latency_in_ms

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Integer</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>None</td>
    </tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

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.

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

Example: netty_allocator_pooled_cache_size#id

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Integer</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>None</td>
    </tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

This document contains references to third-party documentation. Cisco 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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Boolean</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>false</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Boolean</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>false</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java, .NET</td>
    </tr>
   </tbody>
</table>

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Boolean</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>none</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

The agent property specifies the frequency of Request Segment Data (RSD) uploads from the agent.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Numeric</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>10000 ms</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>String</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>2</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

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:
- rest-uri-segment-scheme
- rest-num-segments
{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).

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>String</td>
    </tr>
    <tr>
      <td><strong>Default value:</strong></td><td>{class-annotation}/{method-annotation}.{http-method}</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

Examples

See Using Default Settings and Using rest-transaction-naming Properties.

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>String</td>
    </tr>
        <tr>
      <td><strong>Default value:</strong></td><td>first-n-segments</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>Java</td>
    </tr>
   </tbody>
</table>

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.

<table style="cellpadding: 5px; font-size: 24px" class="conf-macro output-block confluenceTable" frame="below">
  <tbody>
    <tr>
      <td><strong>Type:</strong></td><td>Numeric</td>
    </tr>
        <tr>
      <td><strong>Value:</strong></td><td>Integer representing the number of routing key segments to include in the name.</td>
    </tr>
	<tr>
      <td><strong>Default value:</strong></td><td>0</td>
    </tr>
    <tr>
      <td><strong>Platform(s):</strong></td><td>.NET</td>
    </tr>
   </tbody>
</table>