APM (Alternative PHP Monitor)

APM (Alternative PHP Monitor) is a monitoring extension enabling native Application Performance Management (APM) for PHP. It doesn't require any modification to your application's code and let's you collect performance metrics as well as catching issues that may arise.

Installing

From PECL:

$ sudo pecl install apm

From source:

$ git clone https://github.com/patrickallaert/php-apm.git
$ cd php-apm
$ phpize
Configure the extension, by default, sqlite3, MariaDB/MySQL, StatsD and Socket support are enabled:
```
$ ./configure [--with-sqlite3[=DIR]] [--with-mysql[=DIR]] [--enable-statsd] [--enable-socket] [--with-debugfile[=FILE]]
```
To disable the support of a --with-* switch, use: --without-*, example: $ ./configure --without-sqlite3 To disable the support of a --enable-* switch, use: --disable-*, example: $ ./configure --disable-socket
Compile it:
```
$ make [-j]
```
Tip: use -j to activate parallel compilation.
Install it:
```
$ sudo make install
```

Upgrading

From 2.0 to 2.1

MariaDB / MySQL

   ALTER TABLE request ADD COLUMN method TEXT NOT NULL;

SQLite

   ALTER TABLE request ADD COLUMN method TEXT NOT NULL DEFAULT '';

Configuration

Common

Activate the extension in the php configuration by adding:
```
extension=apm.so
```
Note: APM depends on JSON, so the apm.so extension must be loaded after JSON!

MariaDB/MySQL driver

The MariaDB/MySQL driver lets you store errors and stats in a local, remote or shared database.

Create a user/database for storing APM events.

Set the following settings in the php configuration:

apm.mysql_enabled=1
; Error reporting level specific to the MariaDB/MySQL driver, same level as for PHP's *error_reporting*
apm.mysql_error_reporting=E_ALL|E_STRICT
apm.mysql_host=<host>
;apm.mysql_port=<port>
apm.mysql_user=<user>
apm.mysql_pass=<password>
apm.mysql_db=<dbname>

SQLite driver

The SQLite driver lets you store errors and stats in a local SQLite database.

Note that if performance matters, you should better use the MariaDB/MySQL driver.

Create the directory for the SQLite database as it will be referenced in the setting: apm.sqlite_db_path (see next step):
```
$ mkdir -p /var/php/apm/db/
$ chmod a+rwx /var/php/apm/db/
```

Set the following settings in the php configuration:

apm.sqlite_enabled=1
; The directory containing the "events" file
apm.sqlite_db_path="/path/to/directory/configured/in/previous/step."
; Error reporting level specific to the SQLite3 driver, same level as for PHP's *error_reporting*
apm.sqlite_error_reporting=E_ALL|E_STRICT

StatsD driver

The StatsD driver is handy to send performance metrics of your web sites/applications directly to StatsD, without interfering with your code. The most common backend for StatsD is Graphite, see [Etsy's blog post on StatsD/Graphite], but other backends exist as well.

Install StatsD.

Configure it in the php configuration:

; Whether to enable the statsd driver
apm.statsd_enabled=On
; Host of the statsd server
apm.statsd_host=localhost
; Port of the statsd server
apm.statsd_port=3306

Socket driver

The socket driver lets you send errors and stats directly by Unix and/or TCP sockets. This is handy if you want to write you own piece of code to handle those.