APM Insight Agent Configuration Options

Configuration

Description

Default Value

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

My Application

apm.host*

• Host Name where the Applications Manager is running.
• If an invalid/ unreachable host names is entered, the agent throws a 'Connection Refused' Exception and will retry until the correct host name is entered in apminsight.conf.
• It accepts either the host name or an Ipv4 address

Example: mymachine.mydomain.com

apm.protocol.https

• Specify true if the data to the Applications Manager should be sent through HTTPS Protocol.
• If false, data will be sent through HTTP Protocol

false

apm.port*

• Specify the HTTP Port of the Applications Manager. If apm.protocol.https is true, specify the HTTPS Port.
• If the service is not running in the specified port, the agent throws a 'Connection Refused' Exception and will retry until the correct port is entered in apminsight.conf.

Example: 9090

behind.proxy

• Specify weather 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*

• Specify the HTTP listening port of the Application Server.
• It will be useful to distinguish Instances when more than one Application Server runs in same host.Example: 8080

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

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

transaction.trace.enabled

• Enabling this option will construct Trace for Slow Transactions.
• You can view the traces collected in Applications Manger APM Insight Page by selecting Traces tab

true

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)

transaction.trace.sql.parametrize

• 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

transaction.trace.sql.stacktrace.threshold

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

3 (Second)

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

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

webtransaction.naming.use.requesturl

• To display complete URL of web transactions, use webtransaction.naming.use.requesturl=true in the apminsight.conf file. This is a hidden configuration and it's default value is false.

webtransaction.encoding.charset

• To specify encoding charset when handling application data, use webtransaction.encoding.charset=Windows-1252 in the apminsight.conf file. It's default value is UTF-8

transaction.skip.listening

• Web transactions of the specified URL patterns will be skipped while tracking
• Use comma(,) to separate multiple entries
• For ex: transaction.skip.listening=*.jpeg, will skip listening to transactions ending with .jpeg

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

transaction.tracking.request.interval

• A kind of sampling. If said 20, APM Insight will only track request after every 20 requests of same kind. i.e it will track 1st, 21st, 41st.. request of its kind.
• The request count maintained will be reset after every one minute.

1 (request)

include.components

• By default, APM Insight groups transaction into different components like STRUTS, SERVLET, MYSQL, etc.
• Custom components can be added by specifying the package name in below mentioned format : packagename/.*:Component_Name
• All packages and classes under the specified package will be grouped into specified component
• For Ex: include.components=com/test/custom/.*:CUSTOM, all packages and classes under the package com/test/custom/ will be grouped into CUSTOM component
• Use comma(,) to separate multiple entries

Note: The specified package names, by default will be included for instrumentation and you need not repeat this in custom_instrumentation.conf

apminsight.log.dir

• Directory path where the APM Insight log should be stored.
• Use forward slash(/) as path separator
• example: D:/apminsight/
• Defaults to the directory where APM Insight agent jar is installed if commented or mentioned incorrectly or unable to create the configured directory.

apminsight.log.level

• The log level at which the APM Insight agent should record information.
• Supported levels are SEVERE,WARNING, INFO and FINE.

INFO (level)

autoupgrade.enabled

• Enabling this option agent will automatically download and install the latest available version

false

Note
Options marked with a * are mandatory. If any of the mandatory entries are not provided, the Agent cannot be initialized / started. However the Application Server (where the Agent is deployed) will start normally.
For more detailed information about APDEX threshold go to : http://apdex.org/overview.html

• Enabling this option, APM Insight agent starts tracking background transactions
• All transactions other than HTTP are considered as background transactions

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

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

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

Note:

• These values cannot be changed during run-time for java agent. For the changes to be effective, server restart is required.
• Restart is not required servers using .Net agent, the values will be updated in run-time.

Note:

It requires a application server restart for the changes to be effective

Case 1: Usage on Class
@ApmTracker
public class Category {
...
}

Case 3: Usage on Methods
public class Product {
@ApmTracker
public int getPrice(String product, String brand) {
...
}
...
@ApmTracker(component="FetchBrand")
private List fetchAllBrandsList(String product) {
...
}
}

public class AppService {

@ApmRootTracker(txnName="Service-Initialisation")

public void init() {

...

}

Note:

Service restart is not required to take effect of this configuration change.

The changes will be affected in the next minute onwards.