Help APM APM Insight Configuration

APM Insight Configuration

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

Contents:

  1. Add the APM agent configuration profile
  2. Edit the APM configuration profile
  3. Configuration profiles - Parameters and default values
 
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.

1. Add the APM agent configuration profile

To create APM agent configuration profile:

  1. Log in to your Site24x7 account.
  2. Navigate to Admin > Configuration Profile > APM Agent Configuration> Add APM Agent Configuration Profile.
  3. Enter your Profile Name and choose your agent type.
  4. Configure other parameters.
  5. Click Save.

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.

2. Edit the APM agent configuration profile

  1. Navigate to APM Insight > Your application > Edit.
  2. Go to Configuration Profile > APM 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.

 

3. 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. The parameters for each profile are explained below.

Basic Configuration Profile

Basic configuration Profiles

Logging level
  • The log level at which the APM Insight agent should record information.
  • Supported levels are SEVERE,WARNING, INFO and FINE.
INFO (Log Level)
Configuration Description Default Value
Capture database SQL queries
  • 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
  • Enabling this option will parametrize 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
  • Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.
3 (seconds)
Agent Auto-upgrade
  • On setting this value to true, agent will be upgraded automatically to the latest available version.
False 
Display Instance Port number
  • Port number of application instances will be shown, if this option is enabled.
True
Enable Down ALerts
  • Alerts will be sent whenever your application goes into Down state.
  • Supported only for non-cloud monitors.
Disabled
List of URL extensions to be skipped from tracking
  • 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
  • Enter the list of exceptions that need not be tracked.
None
Skip Transactions
  • Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.
None


Web Transaction Configurations

Web Transactions Configurations

Configuration Description Default Value
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
  • 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
  • Enabling this option will construct Trace for Slow Transactions.
  • You can view the traces collected in Site24x7 APM Insight Edition Page by selecting Traces tab.
True
Transaction tracing 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
  • 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 CPU time per transaction?
  • Record CPU time for every HTTP request, if enabled.
True
Capture Memory allocation per transaction?
  • When enabled, memory allocations for all web transactions will be captured.
2 (seconds)
Capture HTTP parameters?
  • 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
  • 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
List of HTTP error codes to be ignored from tracking
  • This is the list of HTTP error codes, like 400, 401, and 500, that will not be tracked.
None
Capture HTTP Bytes
  • Captures Bytes in and out in network requests, if this option is enabled.
True


Background Transaction Configurations

Background Transactions Configurations

Configuration Description Default Value
Track background transactions
  • Enabling this option, APM Insight agent starts tracking background transactions
  • All transactions other than HTTP are considered as background transactions
True
 Capture traces
  • Enabling this option, the agent collects traces for slow background transactions, provided bgtransaction.tracking.enabled is set to true
True
Transaction 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 exceed
  • 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.
40 (Count)
Capture CPU time per transaction
  • Record CPU time for every background transaction, if enabled.
False
Capture memory allocation per transaction
  • Memory allocated for background transactions will be captured, if this option is enabled.
False
Sampling factor
  • 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)

Configurations available only in apminsight.conf

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

Configuration Description Default Value
application.name
  • Specify the desired Application's Name to show in Site24x7.
  • 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
 My Application
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.
 
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 Site24x7.
  • 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*
  • 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

* - Mandatory values. If any of these entries are not provided or invalid, the Agent cannot be initialized/started. However the Application Server (where the Agent is deployed) will start normally

 

Was this document helpful?
Thanks for taking the time to share your feedback. We’ll use your feedback to improve our online help resources.

Help APM APM Insight Configuration