ManageEngine® Applications Manager


APM Insight Agent Configuration Options

<< Prev

Home

Next >>

APM Insight Agent Configuration Options

 

APM Insight Agent works based on the values configured in apminsight.conf file. Make sure that this file is present in the folder where you have deployed the APM Insight agent.

The following table explains all the configurations:

 

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

 
* apm.host
  • Host Name where the Applications Manager is running.

  • If an invalid/ unreachable host names is entered, the agent throws a 'Connection Refused' Exceptionand 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
Default value: 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

Default value: 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.
Default value: 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.
Default value: 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.

Default value: 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.

Default value: 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.
Default value: true
transaction.trace.sql.stacktrace.threshold
  • Enabling this option will collect the stacktrace whenever any sql query executed above this threshold time value.
Default value: 3 (Second)
include.packages
  • APM Insight does not instrument all the classes loaded. APM Insight itself has a predefined list and only those classes will be instrumented.

  • If you need to instrument any of the other classes, you can achieve this by specifying the package name of the class.

  • Use Comma to separate multiple entries
  • For eg., include.packages=com/test/customimpl/.* will include all the packages & classes that start with com.test.customimpl

 
transaction.tracking.request.interval
  • A kind of sampling. If said 20, apminsight 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.
Default value: 1 (request)
apminsight.log.dir
  • Directory path where the APM Insight log should be stored.

  • Use forward slash(/) as path separator
  • example: D:/Tomcat6.0/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.
Default value: INFO (level)

APM Insight will use its default factory value if any invalid value specified for an option.

Other than options listed below, all the other options can be changed at run time.

The following configurations are not supported for .NET agent:

 

Note:

Options marked with a * are mandatory. If any of the mandatory files 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 : www.apdex.org

 

 


<< Prev

Home

Next >>

APM Insight .NET Agent

APM Insight Dashboard