APM Insight Agent Configuration Profile

You can fine-tune your application monitoring by modifying the APM Insight agent configuration profile. The APM Insight agent configuration profile enables you to set threshold values for key parameters for web and background transactions.

Note: Changes to the APM agent configuration profile are applied at the application level, not the instance level. If your application has many instances, changes in the configuration profile are applied to the application as a whole, and will be reflected across all respective instances.

Adding an agent configuration profile

To create an APM Insight agent configuration profile, follow the steps given below:

  1. Log in to your Applications Manager account.
  2. Navigate to Settings → Discovery & Data Collection → APM Insight Agent Configuration Profile → Add New.
  3. Enter your Profile Name and choose your agent type.
  4. Configure other parameters.
  5. Click Save.

 

Note:
  • In general, the default configuration profile (with default parameter values) will be assigned to your applications. Any changes made to the default configuration profile will be automatically reflected across all applicable agents.
  • You can also clone configuration profiles with custom parameter values, and apply it to your respective applications.

Editing the agent configuration profile

  1. Navigate to APM Insight → Your application → Edit APM Insight Application Configuration icon.
  2. Go to Configuration Profile → APM Insight Agent Configuration Profile.
  3. Click on the drop-down menu to access profiles for the respective agent type.
  4. Choose the concerned profile and click Save.

 

Configuration profiles - Parameters and default values

The APM agent configuration profile is categorized into three parts—basic configuration profiles, web transaction configurations, and background transaction configurations. Click on the following links to view the parameters with respect to various agent profiles supported:

JAVA Configuration Profile

Basic Configuration Profiles:

Name Key Description Default value
Capture database SQL Queries sql.capture.enabled Enabling this option will listen to all SQL Queries which gets executed. If this option is disabled, no Database Metrics will be collected. True
Obfuscate SQL Parameters transaction.trace.sql.parametrize Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true). Disabling this option will give you the real query (with parameters). It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc. True
Stacktrace threshold for SQLs in transaction trace transaction.trace.sql.stacktrace.threshold Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value. 3(seconds)
Display Instance Port number show.instance.port.number Port number of application instances will be shown, if this option is enabled. True
Logging level apminsight.log.level The log level at which the APM Insight agent should record information. Supported levels are SEVERE, WARNING, INFO and FINE. INFO
List of URL extensions to be skipped from tracking transaction.skip.listening Web transactions of the specified URL patterns will be skipped while tracking. Use comma (,) to separate multiple entries
Example: transaction.skip.listening=*.jpeg, will skip listening to transactions ending with .jpeg		 *.css, *.js, *.gif, *.jpg, *.jpeg, *.bmp, *.png, *.ico
List of exceptions to be skipped from tracking exceptions.ignore Enter the list of exceptions that need not be tracked. None
Skip Transactions transaction.skip.patterns Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values. None

Web Transactions Configurations:

Name Key Description Default value
Apdex Threshold apdex.threshold Application Performance Index (simply called Apdex) is measurement of an Application's Performance ranging from 0 to 1.

Detailed information about Apdex can be found at www.apdex.org

If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied.

If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated.

If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating.

 0.5 (seconds)
Sampling factor transaction.tracking.request.interval Sampling factor helps in tracking sampled transactions. If set to 5, APM Insight tracks only 1 in 5 requests of the same kind. 1 (request)
Enable transaction tracing transaction.trace.enabled Enabling this option will construct Trace for Slow Transactions. You can view the traces collected in APM Insight Page by selecting Traces tab. True
Transaction tracing threshold transaction.trace.threshold Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true. The trace can be used to analyze, troubleshoot the transaction working. 2 (seconds)
Capture trace if external calls exceeds webtransaction.trace.external.components.count.threshold Trace snapshot will be taken for all HTTP request(s) which has total external components (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number. 50 (Count)
Capture CPU time per transaction? webtransaction.record.cputime.enabled Record CPU time for every HTTP request, if enabled. True
Capture Memory allocation per transaction? webtransaction.record.memory.allocation.enabled When enabled, memory allocations for all web transactions will be captured. 2 (seconds)
Capture HTTP parameters? webtransaction.trace.input.params.record

Enabling this option captures parameters of all GET & POST web requests

To skip capturing specific parameters use webtransaction.trace.input.params.ignore key

Captured parameters can be viewed by selecting the required transaction in Traces tab

 False
List of HTTP parameters to ignore webtransaction.trace.input.params.ignore

To skip capturing specific web request parameters like password, PIN or any confidential values, specify those parameter names for this key

Use comma(,) to separate multiple entries. Values specified for this key are case-sensitive

If no value is specified, all request parameters will be recorded

 password, pswd, pass, authKey, parentId, parentID, resourceId, resourceID, id, ID
List of HTTP error codes to be ignored from tracking http.errors.ignore This is the list of HTTP error codes, like 400, 401, and 500, that will not be tracked. None
Capture HTTP Bytes capture.http.network.bytes Captures Bytes in and out in network requests, if this option is enabled. True

Background Transactions Configurations:

Name Key Description Default value
Track background transactions bgtransaction.tracking.enabled

Enabling this option, APM Insight agent starts tracking background transactions

All transactions other than HTTP are considered as background transactions

 True
Capture traces bgtransaction.trace.enabled Enabling this option, the agent collects traces for slow background transactions, provided bgtransaction.tracking.enabled is set to true True
Transaction trace threshold bgtransaction.trace.threshold Traces will be collected for background transactions whose response time have crossed the specified threshold value, provided bgtransaction.trace.enabled is set to true 5 (seconds)
Capture trace if external calls exceeds  bgtransaction.trace.external.components.count.threshold Trace snapshot will be taken for background transactions which has total external components (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number. 50 (Count)
Capture CPU time per transaction? bgtransaction.record.cputime.enabled Record CPU time for every background transaction, if enabled. False
Capture Memory allocation per transaction? bgtransaction.record.memory.allocation.enabled Memory allocated for background transactions will be captured, if this option is enabled. False
Sampling factor bgtransaction.tracking.request.interval

Sampling factor for background transactions

If value is set to 1, agent tracks every transaction. If value is set to n, agent tracks 1 in n transactions of same kind

 1 (Request)

DOTNET Configuration profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Stacktrace threshold for SQLs in transaction trace

transaction.trace.sql.stacktrace.threshold

Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.

3(seconds)

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

Logging level

apminsight.log.level

The log level at which the APM Insight agent should record information.

Supported levels are SEVERE,WARNING, INFO and FINE.

CRITICAL

List of URL extensions to be skipped from tracking

transaction.skip.listening

Web transactions of the specified URL patterns will be skipped while tracking

Use comma(,) to separate multiple entries
Example: transaction.skip.listening=*.jpeg, will skip listening to transactions ending with .jpeg

*.css, *.js, *.gif, *.jpg, *.jpeg, *.bmp, *.png, *.ico

List of exceptions to be skipped from tracking

exceptions.ignore

Enter the list of exceptions that need not be tracked.

None

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None

Web Transactions Configurations:

Name Key Description Default value

Apdex Threshold

apdex.threshold

Application Performance Index (simply called Apdex) is measurement of an Application's Performance ranging from 0 to 1.

Detailed information about Apdex can be found at www.apdex.org

If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied.

If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated.

If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating.

0.5 (seconds)

Sampling factor

transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

5 (request)

Enable transaction tracing

transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

True

Transaction tracing threshold

transaction.trace.threshold

Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.

The trace can be used to analyze, troubleshoot the transaction working.

2 (seconds)

Capture trace if external calls exceeds

component.trace.threshold

Trace snapshot will be taken for all HTTP request(s) which has total external components (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number.

30 (Count)

Capture HTTP parameters?

webtransaction.trace.input.params.record

Enabling this option captures parameters of all GET & POST web requests

To skip capturing specific parameters use webtransaction.trace.input.params.ignore key

Captured parameters can be viewed by selecting the required transaction in Traces tab

False

List of HTTP parameters to ignore

webtransaction.trace.input.params.ignore

To skip capturing specific web request parameters like password, PIN or any confidential values, specify those parameter names for this key

Use comma(,) to separate multiple entries. Values specified for this key are case-sensitive

If no value is specified, all request parameters will be recorded

password, authKey
Capture HTTP headers?  webtransaction.trace.request.headers.record Captures the parameters sent in the http(s) headers (both GET & POST), if this option is enabled. False
List of Request headers to ignore webtransaction.trace.request.headers.ignore The values of these parameters in the http(s) headers (both GET & POST) will be ignored from tracking. Sensitive and confidential keys like Cookie, Host and others should be mentioned here. None
Capture Custom Parameters? custom.parameters.record Captures the Custom parameters which are defined in your application code, if this option is enabled. False
Capture CPU Time? cputime.capture.enabled Record CPU time for every HTTP request, if enabled. False
CPU Time threshold cputime.threshold cpu time will get collected whenever any transaction cpu consumes above this threshold value 60%

Background Transaction Configurations

Name Key Description Default value

Track background transactions

bgtransaction.tracking.enabled

Enabling this option, APM Insight agent starts tracking background transactions

All transactions other than HTTP are considered as background transactions

True

Capture traces

bgtransaction.trace.enabled

Enabling this option, the agent collects traces for slow background transactions, provided bgtransaction.tracking.enabled is set to true

True

Transaction trace threshold

bgtransaction.trace.threshold

Traces will be collected for background transactions whose response time have crossed the specified threshold value, provided bgtransaction.trace.enabled is set to true

2 (seconds)

Sampling factor

bgtransaction.tracking.request.interval

Sampling factor for background transactions

If value is set to 1, agent tracks every transaction. If value is set to n, agent tracks 1 in n transactions of same kind

5 (Request)
Track Web Services as background bgtransaction.enable.web.services Enabling this option will collect background web service transaction False

DOTNET SERVICE Configuration Profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Stacktrace threshold for SQLs in transaction trace

transaction.trace.sql.stacktrace.threshold

Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.

3(seconds)

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

Logging level

apminsight.log.level

The log level at which the APM Insight agent should record information.

Supported levels are SEVERE,WARNING, INFO and FINE.

CRITICAL

List of exceptions to be skipped from tracking

exceptions.ignore

Enter the list of exceptions that need not be tracked.

None

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None
Sampling factor transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

 5(request)
Enable transaction tracing transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

 True
Transaction tracing threshold webtransaction.trace.external.components.count.threshold Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.
The trace can be used to analyze, troubleshoot the transaction working.		 2 (seconds)
Capture trace, if external call exceeds component.trace.threshold Trace snapshot will be taken for all HTTP request(s) which has total external components (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number. 30
Capture CPU Time? cputime.capture.enabled Record CPU time for every HTTP request, if enabled. False
CPU Time Threshold cputime.threshold cpu time will get collected whenever any transaction cpu consumes above this threshold value 60%

DOTNET DESKTOP Configuration profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Stacktrace threshold for SQLs in transaction trace

transaction.trace.sql.stacktrace.threshold

Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.

3(seconds)

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

Logging level

apminsight.log.level

The log level at which the APM Insight agent should record information.

Supported levels are SEVERE,WARNING, INFO and FINE.

CRITICAL

List of exceptions to be skipped from tracking

exceptions.ignore

Enter the list of exceptions that need not be tracked.

None

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None
Sampling factor transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

 5(requests)
Enable transaction tracing transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

 True
Transaction tracing threshold webtransaction.trace.external.components.count.threshold Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.
The trace can be used to analyze, troubleshoot the transaction working.		 2 (seconds)
Capture trace, if external call exceeds component.trace.threshold Trace snapshot will be taken for all HTTP request(s) which has total external components (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number. 30
Capture CPU Time? cputime.capture.enabled Record CPU time for every HTTP request, if enabled. False
CPU Time Threshold cputime.threshold cpu time will get collected whenever any transaction cpu consumes above this threshold value 60%

DOTNET CORE Configuration profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Stacktrace threshold for SQLs in transaction trace

transaction.trace.sql.stacktrace.threshold

Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.

3(seconds)

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

Logging level

apminsight.log.level

The log level at which the APM Insight agent should record information.

Supported levels are SEVERE,WARNING, INFO and FINE.

CRITICAL

List of exceptions to be skipped from tracking

exceptions.ignore

Enter the list of exceptions that need not be tracked.

None

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None

Web Transactions Configurations:

Name Key Description Default value

Apdex Threshold

apdex.threshold

Application Performance Index (simply called Apdex) is measurement of an Application's Performance ranging from 0 to 1.

Detailed information about Apdex can be found at www.apdex.org

If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied.

If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated.

If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating.

0.5 (seconds)

Sampling factor

transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

5 (requests)

Enable transaction tracing

transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

True

Transaction tracing threshold

transaction.trace.threshold

Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.

The trace can be used to analyze, troubleshoot the transaction working.

2 (seconds)

Capture trace if external calls exceeds

component.trace.threshold

Trace snapshot will be taken for all HTTP request(s) which has total external components (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number.

30 (Count)

Capture HTTP parameters?

webtransaction.trace.input.params.record

Enabling this option captures parameters of all GET & POST web requests

To skip capturing specific parameters use webtransaction.trace.input.params.ignore key

Captured parameters can be viewed by selecting the required transaction in Traces tab

False

List of HTTP parameters to ignore

webtransaction.trace.input.params.ignore

To skip capturing specific web request parameters like password, PIN or any confidential values, specify those parameter names for this key

Use comma(,) to separate multiple entries. Values specified for this key are case-sensitive

If no value is specified, all request parameters will be recorded

password, authKey
Capture CPU Time? cputime.capture.enabled Record CPU time for every HTTP request, if enabled. False
CPU Time threshold cputime.threshold CPU time will get collected whenever any transaction CPU consumes above this threshold value 60%

Background Transactions Configurations:

Name Key Description Default value

Track background transactions

bgtransaction.tracking.enabled

Enabling this option, APM Insight agent starts tracking background transactions

All transactions other than HTTP are considered as background transactions

True

Capture traces

bgtransaction.trace.enabled

Enabling this option, the agent collects traces for slow background transactions, provided bgtransaction.tracking.enabled is set to true

True
Track Web Services as background bgtransaction.enable.web.services Enabling this option will collect background web service transaction False

PHP Configuration profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

Logging level

apminsight.log.level

The log level at which the APM Insight agent should record information.

Supported levels are SEVERE,WARNING, INFO and FINE.

WARNING

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None
Apdex Threshold apdex.threshold

Application Performance Index (simply called Apdex) is measurement of an Application's Performance ranging from 0 to 1.

Detailed information about Apdex can be found at www.apdex.org

If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied.

If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated.

If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating.

 0.5 (seconds)
Sampling factor transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

 3(requests)
Enable transaction tracing transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

 True
Transaction tracing threshold webtransaction.trace.external.components.count.threshold Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.
The trace can be used to analyze, troubleshoot the transaction working.		 2 (seconds)

PHP - WINDOWS Configuration profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

Logging level

apminsight.log.level

The log level at which the APM Insight agent should record information.

Supported levels are SEVERE,WARNING, INFO and FINE.

WARNING

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None
Apdex Threshold apdex.threshold

Application Performance Index (simply called Apdex) is measurement of an Application's Performance ranging from 0 to 1.

Detailed information about Apdex can be found at www.apdex.org

If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied.

If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated.

If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating.

 0.5 (seconds)
Sampling factor transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

 3 (requests)
Enable transaction tracing transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

 True
Transaction tracing threshold webtransaction.trace.external.components.count.threshold Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.
The trace can be used to analyze, troubleshoot the transaction working.		 2 (seconds)

NODEJS Configuration profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Stacktrace threshold for SQLs in transaction trace

transaction.trace.sql.stacktrace.threshold

Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.

3(seconds)

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

Logging level

apminsight.log.level

The log level at which the APM Insight agent should record information.

Supported levels are SEVERE,WARNING, INFO and FINE.

CRITICAL

List of URL extensions to be skipped from tracking

transaction.skip.listening

Web transactions of the specified URL patterns will be skipped while tracking

Use comma(,) to separate multiple entries
Example: transaction.skip.listening=*.jpeg, will skip listening to transactions ending with .jpeg

*.css, *.js, *.gif, *.jpg, *.jpeg, *.bmp, *.png, *.ico

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None

Web Transactions Configurations:

Name Key Description Default value

Apdex Threshold

apdex.threshold

Application Performance Index (simply called Apdex) is measurement of an Application's Performance ranging from 0 to 1.

Detailed information about Apdex can be found at www.apdex.org

If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied.

If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated.

If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating.

0.5 (seconds)

Sampling factor

transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

1 (request)

Enable transaction tracing

transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

True

Transaction tracing threshold

transaction.trace.threshold

Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.

The trace can be used to analyze, troubleshoot the transaction working.

2 (seconds)

Capture trace if external calls exceeds

webtransaction.trace.external.components.count.threshold

Trace snapshot will be taken for all HTTP request(s) which has total external components (like MYSQL, MEMCACHED, etc) call count equal or higher than the configured number.

30 (Count)

Web transaction tracker drop threshold

webtransaction.tracker.drop.threshold

Trackers with resp time less than this threshold will be dropped

10(ms)

Background Transactions Configurations:

Name Key Description Default value

Track background transactions

bgtransaction.tracking.enabled

Enabling this option, APM Insight agent starts tracking background transactions

All transactions other than HTTP are considered as background transactions

True

Capture traces

bgtransaction.trace.enabled

Enabling this option, the agent collects traces for slow background transactions, provided bgtransaction.tracking.enabled is set to true

True

Transaction trace threshold

bgtransaction.trace.threshold

Traces will be collected for background transactions whose response time have crossed the specified threshold value, provided bgtransaction.trace.enabled is set to true

5 (seconds)

RUBY Configuration profile

Basic Configuration Profiles:

Name Key Description Default value

Capture database SQL Queries

sql.capture.enabled

Enabling this option will listen to all SQL Queries which gets executed.

If this option is disabled, no Database Metrics will be collected.

True

Obfuscate SQL Parameters

transaction.trace.sql.parametrize

Enabling this option will parameterize all SQL Queries in Slow Transaction Traces. (if sql.capture.enabled set to true & transaction.trace.enabled set to true)

Disabling this option will give you the real query (with parameters).

It is recommended to enable this option if there are queries getting executed using confidential parameters like credit card number, passwords, etc.

True

Stacktrace threshold for SQLs in transaction trace

transaction.trace.sql.stacktrace.threshold

Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.

3(seconds)

Display Instance Port number

show.instance.port.number

Port number of application instances will be shown, if this option is enabled.

True

List of exceptions to be skipped from tracking

exceptions.ignore

Enter the list of exceptions that need not be tracked.

*.css, *.js, *.gif, *.jpg, *.jpeg, *.bmp, *.png, *.ico

Skip Transactions

transaction.skip.patterns

Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.

None
Apdex Threshold apdex.threshold

Application Performance Index (simply called Apdex) is measurement of an Application's Performance ranging from 0 to 1.

Detailed information about Apdex can be found at www.apdex.org

If any transaction response time scores values below the apdex.threshold value, the transaction is labeled as Satisfied.

If any transaction response time scores above four times the apdex.threshold, the transaction is labeled as Frustrated.

If it is exactly equal to apdex.threshold or in between satisfied and frustrated threshold value it is labeled as Tolerating.

 0.5 (seconds)
Sampling factor transaction.tracking.request.interval

Sampling factor helps in tracking sampled transactions.

If set to 5, APMInsight tracks only 1 in 5 requests of the same kind

 1 Transaction
Enable transaction tracing transaction.trace.enabled

Enabling this option will construct Trace for Slow Transactions.

You can view the traces collected in APM Insight Page by selecting Traces tab.

 True
Transaction tracing threshold webtransaction.trace.external.components.count.threshold Trace of any transaction whose response time scoring above the specified threshold value will be collected, provided if transaction.trace.enabled is set to true.
The trace can be used to analyze, troubleshoot the transaction working.		 2 (seconds)

Configurations available only in apminsight.conf file (common for all agent)

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

Name Key Description Default value

Application Name

application.name

Specify the desired Application's 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 traces

license.key*

The API Key for the corresponding user.

This will be available in the APM Insight home page, after login.

Copy and Paste the Key as value for this parameter.

This key is user specific. Do not share with anyone else.

none

Configure Proxy

behind.proxy

Specify whether the Agent installed Application Server is under a proxy network.

If set True, Proxy credential information should be given in order 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

Agent Server Port

agent.server.port*

Specify the port number in which your application is running on the server.

Each port number ios treated as an individual instance and will be grouped under the same application name.

80