Python Agent Configuration Options


The APM Insight Python Agent Configuration file helps you fine tune the configuration for tracking web based transactions. These settings can be configured from the web client.

Editing the configuration settings

These settings can be configured using the edit option available in the web client.

Browse through the following topics to view the agent configuration profile for the respective categories of Python agent:

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 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, *.properties, *.jsf, *.ttf, *.woff, *.woff2, *.otf, *.svg, *.webp

Normalize DB Operation Names  
  • Replaces alphanumeric values in the DB operation names with a question mark (*), if enabled.
False

Web transaction 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) or 10(seconds)

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

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 CPU Time per Transaction?

 

  • Record CPU time for every HTTP request, if enabled.

True

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
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
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)