On this page:

Your Rating:
Results:
PatheticBadOKGoodOutstanding!
16 rates

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. 

maximum-activity-trace-stack-depth

This determines the depth of the stack trace to capture as part of an activity trace session. By default, the size of the code paths for OIT (Object Instance Tracking), ALD (Automatic Leak Detection) and MIDS (Memory Intensive Data Structures) are set to 10. To increase this limit, use this property.

A larger depth has higher overhead on the system. AppDynamics recommends that you increase the default value of this property only temporarily, and remove it or set it back to 10 once you get the desired output.

Type:

Integer

Default value:

10

Platform(s):

Java

max-async-task-registration-requests-allowed

Adjust this property to increase or decrease the number of asynchronous task registration requests allowed.

 

Type:

Integer

Default value:

500

Platform(s):

Java

max-async-task-registrations-allowed

Adjust this property to increase or decrease the number of asynchronous task registrations allowed.

 

Type:

Integer

Default value:

500

Platform(s):

Java, .NET

max-business-transactions

Sets a limit on the number of business transactions discovered once an agent is started. The limit helps to ensure that the Controller I/O processing capability and agent memory requirements are appropriate for a production environment. See Business Transactions.

Changing this setting can affect the resource consumption of your deployment. Before you change this setting verify your application environment and Controller can handle any increased resource requirements.

Type:

Integer

Default value:

50

Range:

Minimum=N/A; Maximum=200

Platform(s):

Java, .NET

max-call-elements-per-snapshot

This property represents the maximum number of elements that are collected for any call graph for a snapshot. When the limit is reached, the agent stops collecting more data for this call graph, reports what has been collected to that point, and marks the call graph with a warning that the limit was reached. it is not recommended to dramatically increase this number as it may have overhead implications.

Type:

Integer

Default value:

5000

Platform(s):

Java, .NET

max-concurrent-snapshots

The maximum number of total snapshots that are allowed, including continuing transactions. When the queue goes over the value set, additional snapshots are dropped. This property is ignored while in Development mode. 

Type:

Integer

Default value:

20

Range:

Values must be positive integers. No other constraints.

Platform(s):

Java, .NET

max-correlation-header-size

 The maximum size of the correlation header.

Type:

Integer

Default value:

4096

Range:

Values must be positive integers. No other constraints.

Platform(s):

Java

max-error-snapshots-per-minute

A limit for the number of snapshots per minute due to errors. For example, if too many error snapshots are being seen, then tweak this value to reduce noise in the snapshots.

 

 

Type:

Integer

Default value:

5

Platform(s):

Java, .NET

max-jdbc-calls-per-callgraph

Maximum number of JDBC/ADO.NET exit-call stack samples per call graph. Only queries taking more time than the value of min-duration-for-jdbc-call-in-ms are reported. Changing the value does not require a restart.

Type:

Integer

Default value:

100

Range:

Minimum=1; Maximum=1000

Platform(s):

Java, .NET

max-jdbc-calls-per-snapshot

Maximum number of JDBC/ADO.NET exit calls allowed in a snapshot. Calls after the limit are not recorded. Changing the value does not require a restart.

Type:

Integer

Default value:

500

Range:

Minimum=1; Maximum=5000

Platform(s):

Java, .NET

max-metrics-allowed (New in 4.5.7)

This property sets the upper limit to the number of metrics that can be registered by the agent.

 

 

Type:

Integer

Default value:

5000 or as set with –Dappdynamics.agent.maxMetrics=<metricValue>

Platform(s):

Java

Note

Note: If the number of metrics—registered + unregistered—is greater than the new node property value, then the new metrics will not be created.

max-service-end-points-per-async-type

Maximum total number of service endpoints that can be registered for each asynchronous entry point type, such as worker thread. Because a single transaction may spawn many threads, you may expect more asynchronous service endpoint types than for synchronous service endpoint types.

Type:

Integer

Default value:

40

Range:

Minimum=0; Maximum=N/A

Platform(s):

Java

max-service-end-points-per-entry-point-type

Maximum total number of service endpoints that can be registered for each entry point type, such as servlet, struts action, web service, and so on.

Type:

Integer

Default value:

25

Range:

Minimum=0; Maximum=N/A

Platform(s):

Java, .NET

max-service-end-points-per-node

Maximum total number of service endpoints that can be detected on a single node. Increasing the value of this property enables more service endpoints to be detected on a particular node.

Type:

Integer

Default value:

100

Range:

Minimum=0; Maximum=N/A

Platform(s):

Java, .NET

max-service-end-points-per-thread

Maximum number of service endpoints detected on a single thread of transaction execution.

If this property is set to the default value of one and two service endpoints are detected that impact one specific transaction, only one service endpoint will be evaluated at any time. If a second service endpoint is detected in the context of the first one, the second is ignored. But, if the second service endpoint starts after the first one ends, the second service endpoint will be evaluated.

Increase this property to monitor additional service endpoints on a thread. This number ensures a maximum limit on overhead and number of metrics due to service endpoints on each thread execution. 

Type:

Integer

Default value:

1

Range:

Minimum=0; Maximum=N/A

Platform(s):

Java, .NET

max-urls-per-error-code

Increases the number of URLs the agent can track that produced a certain error. Once the maximum has been reached, all remaining errors are classified as unknown.

Type:

Integer

Default value:

50

Platform(s):

Java

min-duration-for-jdbc-call-in-ms

A JDBC/ADO.NET call taking more time than the specified time (in milliseconds) is captured in the call graph. The query continues to show up in a transaction snapshot. Setting this value too low (< 10ms) may affect application response times. Changing the value does not require a restart.

Type:

Integer

Default value:

10

Range:

Minimum=0; Maximum=N/A

Platform(s):

Java, .NET

min-load-per-minute-diagnostic-session-trigger

Indicates the number of requests per Business Transaction to evaluate before triggering a diagnostic session. This is useful to prevent diagnostic sessions when there is not enough load.

Type:

Integer

Default value:

10

Range:

Minimum=0; Maximum=N/A

Platform(s):

Java, .NET

minimum-age-for-evaluation-in-minutes

Automatic Leak Detection (ALD) tracks all frequently used Collections. For a Collection object to be identified and monitored it must meet the conditions defined by the ALD properties. This property is the first criteria that needs to be met. The value is the minimum age of the Collection in minutes. The property takes effect after node restart.

From the point the collection is captured, it is monitored if it is still available for the specified period without getting
garbage collected. If it survives then it is evaluated for size checks and if it meets the criteria then it is monitored for long term growth in size.

Warning: If you reduce the default there may be a performance hit on the CPU and memory because AD needs to process more collections.

Type:

Integer

Default value:

30

Range:

Minimum=5; Maximum=N/A

Platform(s):

Java

minimum-number-of-elements-in-collection-to-deep-size

Automatic Leak Detection (ALD) tracks all frequently used Collections. For a Collection object to be identified and monitored for it must meet the conditions defined by the ALD properties. This property sets the number of elements threshold.

Warning: If you reduce the default there may be a performance hit on the CPU and memory because AD is processing more collections.

Type:

Integer

Default value:

1000

Platform(s):

Java

minimum-size-for-evaluation-in-mb

Automatic Leak Detection (ALD) tracks all frequently used Collections. For a Collection object to be identified and monitored it must meet the conditions defined by the ALD properties. This property sets the minimum initial size in megabytes for a collection to qualify for monitoring. The collection must also survive for the period specified in the minimum-age-for-evaluation-in-minutes property.

Warning: If you reduce the default there may be a performance hit on the CPU and memory because AD is processing more collections.

Type:

Integer

Default value:

5

Range:

Minimum=1; Maximum,=N/A

Platform(s):

Java

msmq-correlation-field

By default, the .NET agent disables downstream correlation for MSMQ message queues. Register this node property on both the publishing and receiving tiers to enable downstream correlation for MSMQ and to specify the field where the agent writes correlation data.

The agent supports Extension or Label fields. By default, the agent writes correlation data to the Extension field, however, some frameworks built on MSMQ write data to the Extension field. Only use Label when the Extension field is not available because it is already in use by the framework. The NServiceBus implementation of MSMQ uses the Extension field, so for NServiceBus use Label. See MSMQ Backends for .NET.

Type:

String

Supported Values:

None: Disable downstream correlation for MSMQ
Label: Store correlation information in the label field
Extension: Store correlation information in the extension field

Default value:

none

Platform(s):

.NET

msmq-single-threaded

Specify the threading architecture for the MSMQ message queue. The value defaults to false. For multithreaded queue implementations, change the value to false. See MSMQ Backends for .NET.

Type:

Boolean

Default value:

false

Platform(s):

.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:

Boolean

Default value:

true

Platform(s):

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:

Boolean

Default value:

true

Platform(s):

.NET

on-demand-snapshots

Collect snapshots for all business transactions executed in this node. Does not need a restart. This property is ignored while in Development mode. 

Type:

Boolean

Default value:

false

Platform(s):

Java, .NET

percentile-method-option

You can choose one of two different algorithms to calculate percentiles in 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:

Numeric

Supported Values:

1: P Square

2: Quantile Digest

Default value:

1

Platform(s):

Java, .NET

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:

Boolean

Default value:

false

Platform(s):

Java, .NET

reportingFrequencyInMillis

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

 

 

Type:

Numeric

Default value:

10000ms

Platform(s):

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:

String

Default value:

2

Platform(s):

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:

String

Default value:

{class-annotation}/{method-annotation}.{http-method}

Platform(s):

Java

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:

String

Default value:

first-n-segments

Platform(s):

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:

Numeric

Values:

Integer representing the number of routing key segments to include in the name.

Default value:

0

Platform(s):

.NET

  • No labels