Atatus has numerous settings to configure the way you want to monitor your PHP application. These settings can be configured in atatus.ini. You can find the path of the "atatus.ini" as follows:
In a command line, run the following command
php -i | grep atatus.ini
In a browser, search through the output of the following script for "atatus.ini"
<?php phpinfo(); ?>
You can modify the following configurations in your atatus.ini file.
| Name | Description | Scope | Type |
|---|---|---|---|
| atatus.license_key | APM License Key of your account. It is mandatory. | System | string |
| atatus.app_name | Name of your PHP project/app. It is mandatory. | System | string |
| atatus.enabled | Enable/Disable the Atatus PHP agent. | System | boolean |
| atatus.framework | Atatus automatically finds the framework of the application. In case it fails to identify, then you can set them manually here. Possible Values: Laravel, Symfony, Magento1, Magento2, Drupal8, Drupal7, Yii2, Silex, Zend3, Slim3, Cake3, CodeIgniter | System | string |
| atatus.app_version | Version number of the PHP application. | System | string |
| atatus.release_stage | Release stage of the application. Example: production, development, staging. | System | string |
| atatus.tags | Tags can be added to provide extra information and to help filtering errors and performance metrics. You can provide multiple tags separated by comma(,). Example: us_east_1,php_queue_server. | System | string |
| atatus.hostname | Custom hostname for your application server instead of default hostname. | System | string |
| atatus.collector.path | Path of the collector executable. | System | string |
| atatus.collector.pidfile | Path of collector's process ID (PID) file. | System | string |
| atatus.collector.connection | Path of UNIX-domain socket through which Agent and Collect will communicate. | System | string |
| atatus.collector.notify_host | Atatus APM Endpoint. All data will be sent to this server. | System | string |
| atatus.collector.notify_ssl | When set, all communication with Atatus server will be in secure HTTP connection. | System | boolean |
| atatus.collector.notify_proxy | Proxy server URL if any. Format: scheme://proxy_host:proxy_port The scheme can be http, https, socks, socks4, or socks5. Example: http://localhost:3128, socks4://localhost:1080, socks5://localhost:1080. | System | string |
| atatus.collector.log_level | Log level tells what detail to include in the collector log file. It can be the following values: error, warning, info, debug, none. | System | string |
| atatus.collector.log_file | Name of the file to send collector log messages to. | System | string |
| atatus.agent.log_level | Log level tells what detail to include in the agent log file. It can be the following values: error, warning, info, debug, none | System | string |
| atatus.agent.log_file | Name of the file to send agent log messages to. | System | string |
| atatus.trace.enabled | When set, trace will be collected for critical transactions. | System | boolean |
| atatus.trace.response_time | Response Time Threshold for critical transactions. Trace will be collected for a transaction if the response time is greater than the given threshold. It should be in milliseconds. By default, it is 2000 ms. | System | number |
| atatus.sql.capture | This option tells whether to send the unclear SQL statement (hide all sensitive data) or the exact SQL statement. Default is "normalized" which capture and send unclear SQL statement. It can be the following values: normalized, raw,off. | System | string |
| atatus.laravel.enable_queues | Automatically capture Laravel Queues as background transactions. | per-directory | boolean |
| atatus.guzzle.enable_extension | Automatically capture Guzzle calls as external requests. | System | boolean |
| atatus.predis.enable_extension | Capture Predis calls, if they are not auto-instrumented. | System | boolean |
| atatus.sample_rate | Set the sample rate to determine the transactions that needs to be sampled. | System | number |
| atatus.wordpress.hooks.enable_extension | Capture WordPress specific metrics sent to Atatus including hooks, plugins and themes. | System | boolean |
| atatus.analytics.enabled | Enable API Analytics for PHP agent, where you can monitoring all the request metrics. | System | boolean |
Uninstall PHP Agent
You can uninstall the Atatus PHP agent by running below command. It will remove all agent files from your system.
sudo atatus-php-installer uninstall
After uninstalling the agent, you must restart your web servers (Apache, Nginx, PHP-FPM, etc).
Enable debug log level
In case if you are facing any issues with PHP APM (Example: no data is coming, crashing the server, etc), you can enable the debug log level in both agent and collector.
Open your atatus.ini file. You can find the path of the atatus.ini file by running php -i | grep atatus.ini command in the shell.
- Change agent log level to
verbose_all
atatus.agent.log_level = "verbose_all"
- Change collector log level to debug
atatus.collector.log_level = "debug"
Restart your server and access your server until you reproduce the issue. The debug log messages will be saved in /var/log/atatus/agent.log and /var/log/atatus/collector.log. Please send us an email with these files to success@atatus.com
Enable Guzzle
If guzzle request is not captured in traces, you have to enable the guzzle extension in the atatus.ini file.
Open your atatus.ini file and set the following setting to true.
You can find the path of the atatus.ini file by running php -i | grep atatus.ini command in the shell.
atatus.guzzle.enable_extension = true
Enable Predis
If you want to capture the Predis calls, you have to enable it with the option atatus.predis.enable_extension because Predis calls don't get auto instrumented.
Open your atatus.ini file and set the following setting to true.
You can find the path of the atatus.ini file by running php -i | grep atatus.ini command in the shell.
atatus.predis.enable_extension = true
Enable Wordpress Hooks & Plugins Instrumentation
By default, Wordpress instrumentation is disabled. You can enable this with atatus.wordpress.hooks.enable_extension option.
Open your atatus.ini file and set the following setting to true.
You can find the path of the atatus.ini file by running php -i | grep atatus.ini command in the shell.
atatus.wordpress.hooks.enable_extension = true
Enable Analytics
App analytics collect all API requests individually with request headers, response headers, request body and response body.
Open your atatus.ini file and set the following setting to true.
You can find the path of the atatus.ini file by running php -i | grep atatus.ini command in the shell.
atatus.analytics.enabled = true
+1-415-800-4104