Help Docs

PHP Agent Configuration

PHP Agent Configuration file helps you fine tune the configuration for tracking web based transactions.

Editing the configuration settings

To edit the PHP agent configuration profile:

  1. Navigate to APM > APM Insight > your PHP application.
  2. Click the hamburger icon (Hamburger icon) near the Application/Instance drop-down menu and select the Edit option.
  3. Go to Configuration Profiles > APM Agent Configuration Profile.
  4. Click on the drop-down menu to select the required profile.

    You can update the configurations by clicking on the pencil icon.

  5. Choose the concerned profile and click Save.

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

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.


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.
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.
Display Instance Port Number
  • Port number of application instances will be shown, if this option is enabled.
Enable Down Alert
  • Alerts will be sent whenever your application goes into Down state.
  • Supported only for non-cloud monitors.
Suppress Instance Alerts
  • Enabling this option will suppress the alerts for all instances. 
  • All alerting modes including SMS, voice, instant messenger (IM), mobile and web browser push notifications will be disabled.
Normalize DB Operation Names
  •  If you enable this option, alphanumeric values in the DB operation names will be replaced with a question mark (?).
Logging Level
  •  You can select the different levels of log message from the drop-down menu. Based on the log level selected, the log messages printed in the agent log (at the user machine) will vary.
Java- INFO
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
Skip Transactions
  • Provide regex patterns or transaction names that can be skipped from tracking. Multiple entries should be comma separated values.
Group similar transactions
  • Provide a regex pattern of the transactions that can be grouped under a single transaction name.
Group transactions by Prefix 
  • Provide a list of prefixes that need to be grouped under a single prefix name.
  • Syntax: Transaction Prefix = New Prefix
  • For example, nestle, snickers, orion = chocolate
    In the above given example, nestle/quantity/order, snickers/quantity/order, orion/quantity/order will be replaced by chocolate/quantity/order.


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
  • 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.
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)
Capture CPU Time per Transaction?
  • Record CPU time for every HTTP request, if enabled.
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
List of HTTP Parameters to Obfuscate
  • 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
Capture HTTP Headers?
  •  Enabling this option captures the HTTP headers of the trace (which can be viewed on the Trace Details tab).
List of HTTP Headers to Ignore
  • To skip capturing specific HTTP headers, mention them.
  • Use comma(,) to separate multiple entries.
  • If no value is specified, all HTTP headers are captured.

Java- Accept, Cookie, Cache-Control, Connection, Host, Accept-Encoding, X-Site24x7-Id, X-SITE24X7-RUM-APPKEY, X-SITE24X7-RUM-TRACEID, Site24x7SyntheticKey

.NET, PHP, Node.js, Python- X-Site24x7-Id, X-SITE24X7-RUM-APPKEY, X-SITE24X7-RUM-TRACEID, Site24x7SyntheticKey

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.
Capture HTTP Bytes
  • Captures Bytes in and out in network requests, if this option is enabled.


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
 Capture Traces?
  • Enabling this option, the agent collects traces for slow background transactions, provided bgtransaction.tracking.enabled is set to 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 exceeds
  • 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.
Capture Memory Allocation per Transaction
  • Memory allocated for background transactions will be captured, if this option is enabled.
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


This is only applicable to agent versions below 4.0.

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

Configuration Description Default value
  • 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.
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.
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.

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

* - 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?

Would you like to help us improve our documents? Tell us what you think we could do better.

We're sorry to hear that you're not satisfied with the document. We'd love to learn what we could do to improve the experience.

Thanks for taking the time to share your feedback. We'll use your feedback to improve our online help resources.

Shortlink has been copied!