Ruby Agent Configuration Options


This page should help you tune the configuration for APM Insight Ruby agent configuration profile. The APM Ruby agent configuration profile enables you to set threshold values for key parameters and web transactions. These settings can be configured in apminsight.conf file or from the web client (represented by Web client). Make sure that this file is present in the folder where you have deployed the APM Insight agent.

The APM agent configuration profile is categorized into two parts:

Basic configuration profiles

ConfigurationDescriptionDefault Value
application.name*
  • Specify the desired Application's Display 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

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
8080

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

Parametrize SQLs in transaction trace

  • Enabling this option will parametrize all SQL Queries in Slow Transaction Traces. (if Capture database SQL queries is set to true and Enable transaction tracing is 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 (Second)

The following properties are applicable for Applications Manager build 14440 and above

apm.host*

  • URL where the Applications Manager is running.
  • If an invalid/ unreachable Applications Manager details is entered, the agent throws a 'Connection Refused' Exception and will retry until the correct details is entered in apminsight.conf.
https://localhost:8443

license.key*

  • The license Key for the corresponding Applications Manager.
  • This will be available in the APM Insight tab > Help Card. 
  • Copy and Paste the Key as value for this parameter.
  • This key is Applications Manager specific and do not share it with anyone else. 
Example: 
license.key=APMI_38497e5d7f08c97214db485882372818b854445c98e2927e94
 
The following properties are applicable for Applications Manager build below 14440

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

localhost

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

 

Notes:
  • 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.
  • Any changes to these options will take effect only when the Application Server restarts
  • All options apminsight.conf file can be also provided as environment variables. It can be done by enclosing the environment variable with { }. 

    Example:

    application.name={app_name}
    Here app_name is an environment variable

    Note: The agent looks for the environment variable in ENV hash only

Web transaction configurations

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

Sampling factor

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

1 (request)

Enable transaction tracing

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

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