Schedule demo

APM Insight .NET Agent Configuration Options


The APM Insight .NET agent provides configuration options to control transaction tracking, trace collection, data capture, and other monitoring settings. You can modify these settings either through the Web Client or directly in the apminsight.conf file. This page describes the available settings, their configuration keys, and their default values.

Configuring settings through the Web Client

To modify the agent configuration settings through the Web Client, navigate to the required APM Insight agent configuration profile and click the Edit option. You can then update the available settings for the selected profile.

Applications Manager APM Insight .NET Agent Configuration Options: Editing agent configuration settings

The .NET agent configuration settings are organized into the following profiles:

DOTNET configuration profile

The DOTNET configuration profile contains the following categories of settings:

Note: The red asterisk (*) indicates that the corresponding default value applies to Applications Manager versions later than v16470.

Basic configuration settings

NameKeyDescriptionDefault value
Capture database SQL Queriessql.capture.enabled
  • When enabled, the agent captures the SQL queries executed by the application.
  • When disabled, database metrics are not collected. Confirm whether this applies to all database metrics or only SQL query-related metrics.
True
Obfuscate SQL Parameterstransaction.trace.sql.parametrize
  • When enabled, the agent parameterizes SQL queries in slow transaction traces. This setting applies when sql.capture.enabled and transaction.trace.enabled are enabled.
  • When disabled, the actual SQL query, including its parameter values, is displayed.

Note: Enable this option if queries contain confidential values, such as credit card numbers or passwords.

True
Stacktrace threshold for SQLs in transaction tracetransaction.trace.sql.stacktrace.threshold
  • Specifies the execution time threshold, in seconds, above which the agent collects the stack trace for an SQL query.
3 seconds
Display Instance Port Numbershow.instance.port.number
  • When enabled, the port number of each application instance is displayed.
True
Logging levelapminsight.log.level
  • Specifies the logging level at which the APM Insight agent records information.
  • Supported levels are SEVERE, WARNING, INFO, and FINE.
CRITICAL
List of URL extensions to be skipped from trackingtransaction.skip.listening
  • Specifies the URL patterns of web transactions that the agent should skip while tracking.
  • Separate multiple entries with commas.

Example:transaction.skip.listening=*.jpeg skips transactions with URLs ending in .jpeg.

*.css, *.js, *.gif, *.jpg, *.jpeg, *.bmp, *.png, *.ico
List of exceptions to be skipped from trackingexceptions.ignore
  • Specifies the exceptions that the agent should exclude from tracking.
None
Skip Transactionstransaction.skip.patterns
  • Specifies the regular expression patterns or transaction names that the agent should exclude from tracking.
  • Separate multiple entries with commas.
None
Normalize DB Operation Names 
  • When enabled, replaces alphanumeric values in database operation names with a question mark (*).
False

Web transaction settings

NameKeyDescriptionDefault value
Apdex Thresholdapdex.threshold
  • Application Performance Index (Apdex) measures application performance on a scale from 0 to 1.
  • For more information, see Apdex.
  • A transaction with a response time greater than four times the configured Apdex threshold is classified as Frustrated.
  • A transaction with a response time equal to or greater than the Apdex threshold, but not exceeding four times the threshold, is classified as Tolerating.
0.5 seconds
Sampling factortransaction.tracking.request.interval
  • Specifies the sampling factor used to determine how frequently the agent tracks transactions.
  • For example, if the value is set to 5, the agent tracks one out of every five requests of the same kind.
5 requests or 10 requests*
Enable transaction tracingtransaction.trace.enabled
  • When enabled, the agent collects traces for slow transactions.
  • You can view the collected traces in the Traces tab of the APM Insight monitor.
True
Transaction tracing thresholdtransaction.trace.threshold
  • Specifies the response time threshold, in seconds, above which the agent collects a transaction trace. This setting applies when transaction.trace.enabled is enabled.
  • Use the collected trace to analyze and troubleshoot transaction performance.
2 seconds or 5 seconds*
Capture trace if external calls exceedcomponent.trace.threshold
  • Specifies the minimum number of external component calls (such as MySQL and Memcached calls) required for the agent to capture a trace snapshot for an HTTP request.
30
Capture HTTP parameters?webtransaction.trace.input.params.record
  • When enabled, captures parameters from GET and POST web requests.
  • To exclude specific parameters, configure the webtransaction.trace.input.params.ignore key.
  • You can view the captured parameters by selecting the required transaction in the Traces tab.
False
List of HTTP parameters to ignorewebtransaction.trace.input.params.ignore
  • Specifies the names of request parameters that the agent should exclude from capture, such as passwords, PINs, or other confidential values.
  • Separate multiple entries with commas. Values are case-sensitive.
  • When parameter capture is enabled, and no value is specified for this key, all request parameters are recorded.
password, authKey
Capture HTTP headers?webtransaction.trace.request.headers.record
  • When enabled, it captures the HTTP request headers for GET and POST requests.
False
List of Request headers to ignorewebtransaction.trace.request.headers.ignore
  • Specifies the HTTP request header names that the agent should exclude from tracking. Consider adding sensitive headers, such as Cookie and Host, to this list.
None
Capture Custom Parameters?custom.parameters.record
  • When enabled, captures custom parameters defined in the application code.
False
Capture CPU Time?cputime.capture.enabled
  • When enabled, records the CPU time consumed by each HTTP request.
False
CPU Time thresholdcputime.threshold
  • Specifies the CPU usage threshold above which the agent collects CPU time for a transaction.
60%
Capture HTTP Response Headerswebtransaction.trace.response.headers.record
  • When enabled, captures the HTTP response headers for a trace. You can view them in the Trace Details tab.
FALSE
List of HTTP Response Headers to be ignoredwebtransaction.trace.response.headers.ignore
  • Specifies the HTTP response header names that the agent should exclude from capture.
  • Separate multiple entries with commas. Values are case-sensitive.
  • When no value is specified, all HTTP response headers are captured.
password, pswd, pass, authKey, parentId, parentID, resourceId, resourceID, id, ID
Capture External Call Request Headerswebtransaction.trace.ext.request.headers.record
  • When enabled, captures the request headers of external calls in a trace. You can view them in the Trace Details tab.
FALSE
List of External Request Headers to be ignoredwebtransaction.trace.ext.request.headers.ignore
  • Specifies the external request header names that the agent should exclude from capture.
  • Separate multiple entries with commas. Values are case-sensitive.
  • When no value is specified, all external request headers are recorded.
password, pswd, pass, authKey, parentId, parentID, resourceId, resourceID, id, ID
Capture External Call Response Headerswebtransaction.trace.ext.response.headers.record
  • When enabled, captures the response headers of external calls in a trace. You can view them in the Trace Details tab.
FALSE
List of External Response Headers to be ignoredwebtransaction.trace.ext.response.headers.ignore
  • Specifies the external response header names that the agent should exclude from capture.
  • Separate multiple entries with commas. Values are case-sensitive.
  • When no value is specified, all external response headers are recorded.
password, pswd, pass, authKey, parentId, parentID, resourceId, resourceID, id, ID
Capture Traces for Unique Executions?transaction.trace.unique.execution
  • When enabled, the agent captures traces for unique executions.
FALSE

Background transaction settings

NameKeyDescriptionDefault value
Track background transactionsbgtransaction.tracking.enabled
  • When enabled, the APM Insight agent tracks background transactions.
  • Transactions other than HTTP transactions are considered background transactions.
True
Capture tracesbgtransaction.trace.enabled
  • When enabled, the agent collects traces for slow background transactions. This setting applies when bgtransaction.tracking.enabled is enabled.
True
Transaction trace thresholdbgtransaction.trace.threshold
  • Specifies the response time threshold above which the agent collects traces for background transactions. This setting applies when bgtransaction.trace.enabled is enabled.
2 seconds
Sampling factorbgtransaction.tracking.request.interval
  • Specifies the sampling factor for background transactions.
  • If the value is set to 1, the agent tracks every transaction. If the value is set to n, the agent tracks one out of every n transactions of the same kind.
5 requests
Track Web Services as backgroundbgtransaction.enable.web.services
  • When enabled, the agent tracks web service transactions as background transactions.
False

DOTNET SERVICE configuration profile

Basic configuration settings

NameKeyDescriptionDefault value
Capture database SQL Queriessql.capture.enabled
  • When enabled, the agent captures the SQL queries executed by the application.
  • When disabled, database metrics are not collected. Confirm whether this applies to all database metrics or only SQL query-related metrics.
True
Obfuscate SQL Parameterstransaction.trace.sql.parametrize
  • When enabled, the agent parameterizes SQL queries in slow transaction traces. This setting applies when sql.capture.enabled and transaction.trace.enabled are enabled.
  • When disabled, the actual SQL query, including its parameter values, is displayed.

Note: Enable this option if queries contain confidential values, such as credit card numbers or passwords.

True
Stacktrace threshold for SQLs in transaction tracetransaction.trace.sql.stacktrace.threshold
  • Specifies the execution time threshold, in seconds, above which the agent collects the stack trace for an SQL query.
3 seconds
Display Instance Port Numbershow.instance.port.number
  • When enabled, the port number of each application instance is displayed.
True
Logging levelapminsight.log.level
  • Specifies the logging level at which the APM Insight agent records information.
  • Supported levels are SEVERE, WARNING, INFO, and FINE.
CRITICAL
List of exceptions to be skipped from trackingexceptions.ignore
  • Specifies the exceptions that the agent should exclude from tracking.
None
Skip Transactionstransaction.skip.patterns
  • Specifies the regular expression patterns or transaction names that the agent should exclude from tracking.
  • Separate multiple entries with commas.
None
Sampling factortransaction.tracking.request.interval
  • Specifies the sampling factor used to determine how frequently the agent tracks transactions.
  • For example, if the value is set to 5, the agent tracks one out of every five requests of the same kind.
5 requests or 10 requests*
Enable transaction tracingtransaction.trace.enabled
  • When enabled, the agent collects traces for slow transactions.
  • You can view the collected traces in the Traces tab of the APM Insight monitor.
True
Transaction tracing thresholdtransaction.trace.threshold
  • Specifies the response time threshold, in seconds, above which the agent collects a transaction trace. This setting applies when transaction.trace.enabled is enabled.
  • Use the collected trace to analyze and troubleshoot transaction performance.
2 seconds or 5 seconds*
Capture trace if external calls exceedcomponent.trace.threshold
  • Specifies the minimum number of external component calls (such as MySQL and Memcached calls) required for the agent to capture a trace snapshot for an HTTP request.
30
Capture CPU Time?cputime.capture.enabled
  • When enabled, records the CPU time consumed by each HTTP request.
False
CPU Time Thresholdcputime.threshold
  • Specifies the CPU usage threshold above which the agent collects CPU time for a transaction.
60%

DOTNET DESKTOP configuration profile

Basic configuration settings

NameKeyDescriptionDefault value
Capture database SQL Queriessql.capture.enabled
  • When enabled, the agent captures the SQL queries executed by the application.
  • When disabled, database metrics are not collected. Confirm whether this applies to all database metrics or only SQL query-related metrics.
True
Obfuscate SQL Parameterstransaction.trace.sql.parametrize
  • When enabled, the agent parameterizes SQL queries in slow transaction traces. This setting applies when sql.capture.enabled and transaction.trace.enabled are enabled.
  • When disabled, the actual SQL query, including its parameter values, is displayed.

Note: Enable this option if queries contain confidential values, such as credit card numbers or passwords.

True
Stacktrace threshold for SQLs in transaction tracetransaction.trace.sql.stacktrace.threshold
  • Specifies the execution time threshold, in seconds, above which the agent collects the stack trace for an SQL query.
3 seconds
Display Instance Port Numbershow.instance.port.number
  • When enabled, the port number of each application instance is displayed.
True
Logging levelapminsight.log.level
  • Specifies the logging level at which the APM Insight agent records information.
  • Supported levels are SEVERE, WARNING, INFO, and FINE.
CRITICAL
List of exceptions to be skipped from trackingexceptions.ignore
  • Specifies the exceptions that the agent should exclude from tracking.
None
Skip Transactionstransaction.skip.patterns
  • Specifies the regular expression patterns or transaction names that the agent should exclude from tracking.
  • Separate multiple entries with commas.
None
Sampling factortransaction.tracking.request.interval
  • Specifies the sampling factor used to determine how frequently the agent tracks transactions.
  • For example, if the value is set to 5, the agent tracks one out of every five requests of the same kind.
5 requests or 10 requests*
Enable transaction tracingtransaction.trace.enabled
  • When enabled, the agent collects traces for slow transactions.
  • You can view the collected traces in the Traces tab of the APM Insight monitor.
True
Transaction tracing thresholdtransaction.trace.threshold
  • Specifies the response time threshold, in seconds, above which the agent collects a transaction trace. This setting applies when transaction.trace.enabled is enabled.
  • Use the collected trace to analyze and troubleshoot transaction performance.
2 seconds or 5 seconds*
Capture trace if external calls exceedcomponent.trace.threshold
  • Specifies the minimum number of external component calls (such as MySQL and Memcached calls) required for the agent to capture a trace snapshot for an HTTP request.
30
Capture CPU Time?cputime.capture.enabled
  • When enabled, records the CPU time consumed by each HTTP request.
False
CPU Time Thresholdcputime.threshold
  • Specifies the CPU usage threshold above which the agent collects CPU time for a transaction.
60%

Configurations available only in apminsight.conf file

Note: This is only applicable to agent versions below 4.0.

Certain configuration files cannot be modified from the client. These settings can be configured in apminsight.conf file.

NameKeyDescriptionDefault value
Application Nameapplication.name
  • Specify the desired application name to show in Applications Manager.
  • If there are multiple instances of your application and you would like to group them, then specify the same application name in all installed APM Insight Agent Configuration files.
    Example: myonlineshopping.com
True
Capture traceslicense.key
  • The API Key for the corresponding user.
  • This will be available on the APM Insight home page after logging in.
  • Copy and paste the Key as the value for this parameter.
  • This key is user-specific. Do not share with anyone else.
none
Configure Proxybehind.proxy
  • Specify whether the Agent-installed Application Server is under a proxy network.
  • If set to True, Proxy credential information should be provided to send the metric data from the agent to Applications Manager.
  • If behind.proxy is set to true, specify values for the following keys:
  • proxy.server.host: Host name of the proxy server
  • proxy.server.port: Proxy server's port
  • proxy.auth.username: User name of the proxy server
  • proxy.auth.password: password for the proxy server
False

Loved by customers all over the world

"Standout Tool With Extensive Monitoring Capabilities"

★★★★★

It allows us to track crucial metrics such as response times, resource utilization, error rates, and transaction performance. The real-time monitoring alerts promptly notify us of any issues or anomalies, enabling us to take immediate action.

Reviewer Role: Research and Development

carlos-rivero
"I like Applications Manager because it helps us to detect issues present in our servers and SQL databases."
Carlos Rivero

Tech Support Manager, Lexmark

Trusted by thousands of leading businesses globally