On this page:
This topic describes how to install the PHP Agent using the included install.sh script.
Installing the PHP Agent
The following steps describe how to install the PHP Agent with the installation script, install.sh.
The installer overwrites any existing settings in the AppDynamics PHP Agent ini fragment, found in appdynamics-php-agent/php/conf/appdynamics_agent.ini. If you have configured properties in that file, you need to update them when you run the installer. The installer does not overwrite the php.ini file.
Verify support and system requirements for your environment as described in Install the PHP Agent.
Create the agent installation directory. The directory should be owned by the same user that runs Apache or php-fpm. AppDynamics recommends /opt/appdynamics/php-agent. This documentation refers to this directory as the php_agent_install directory or $<php_agent_install>.
From the command line, change directories to the PHP agent installation directory and untar the agent distribution tarball, as in the following example:
- Set the following permissions on your php_agent_install directory.
php – Make every directory that leads to the PHP agent logs directory readable and executable by all and writable by the directory owner.
logs – If possible, make the logs subdirectory readable/writable/executable by all.
Directory access permissions of 777 may be too permissive for some organizations. In this case, simply make sure that the directory is owned by the apache/php/proxy user.
Run the installation script using the following syntax.
The command arguments are described as follows:
- -s option: You can optionally specify the -s option if you want the agent to use SSL (HTTPS) to connect to the controller. In this case, set the Controller port to the HTTPS port of the controller.
- -a account_name@account_access_key: The required controller account name and account key. To find your account name and access key, click the settings (gear) icon in the upper right corner of the AppDynamics UI, then click License.
- http-proxy-host and http-proxy-port: Set the http-proxy-host and http-proxy-port to route data to the controller through a proxy server. The http-proxy-host is the host name or IP address of the proxy server. The http-proxy-port is the proxy server's HTTP or HTTPS port, whichever you are using. If you set the http-proxy-host you must set the http-proxy-port as well.
- http-proxy-user, http-proxy-password-file: The username and password file if using a proxy and the proxy server requires credentials.
- -e option: extensions directory for the appdynamics_agent.so file. Needed on Ubuntu as well as when the default PHP CLI binary cannot be determined.
- -i option: ini directory for the appdynamics_agent.ini file. Needed on Ubuntu as well as when the default PHP CLI binary cannot be determined.
- -v option: version of PHP that you are instrumenting. Valid formats are version numbers to one or two decimal positions; e.g. "5.4" and "5.4.21" are both valid. Needed only when the default PHP CLI binary cannot be determined or there is no PHP CLI binary.
- -p option: path to the PHP binary
- enable-cli-long-running: Set to true to defend PHP in long-running CLI applications. Defaults to false. See
- --log-dir=<dir>: The directory to which the agent and proxy logs should be written. Defaults to the <php_agent_install>/logs directory.
- --proxy-ctrl-dir=<dir>: The proxy control directory. If not specified, installer creates a temporary directory
If all options are used, the -e, -i and -v options have precedence over the -p option.
On Ubuntu the installation needs to be performed as the root user. Also, you need to use the -e option to indicate the correct extensions directory for the appdynamics_agent.so file and the -i option for the correct ini directory for the appdynamics_agent.ini file.
Restart the web server, unless you are installing an agent to monitor PHP-CLI only.
If there is more than one Apache instance on a machine, run install.sh once for each Apache, each time with the appropriate node, php_ini dir and php_ext dir options. In this case see also Run the PHP Proxy Daemon Manually. See Files Added to Your Installation for information about the default installation directories.
If your installation failed, see Resolve PHP Agent Installation Issues.
Installation Command Samples
The following illustrates a sample command to install the agent:
To install the agent using SSL, use the -s switch, as follows:
The following sample command illustrates installation with a proxy server present: