Scout APM PHP Extension

The Scout APM PHP extension allows instrumentation of internal PHP functions that can't be done in regular PHP. The scout-apm-php package detects if the scoutapm extension is loaded and will automatically send this data if available.

Functions currently instrumented are:

• file_get_contents
• file_put_contents
• curl_exec
• fread
• fwrite
• PDO->exec
• PDO->query
• PDOStatement->execute

If you would like another function instrumented, please let us know on our issues.

Installing from PECL

The Scout APM extension is available to install using PECL.

$ sudo pecl install scoutapm

You may need to add zend_extension=scoutapm.so into your php.ini to enable the extension.

Building

$ phpize
$ ./configure --enable-scoutapm
$ make test

Note: whilst a CMakeLists.txt exists, this project does NOT use CMake. The CMakeLists.txt exists so this project can be worked on in CLion. See https://dev.to/jasny/developing-a-php-extension-in-clion-3oo1.

Building with specific PHP build

$ /path/to/bin/phpize
$ ./configure --with-php-config=/path/to/bin/php-config --enable-scoutapm
$ make test

Building with Docker

@todo: make docker build configurable...

docker build .
docker run -v $PWD/modules:/v <hash_from_build>

Debugging

Use gdb (e.g. in CLion) to debug. Once running, php-src has a GDB helper:

source /path/to/php-src/.gdbinit
printzv <thing>
print_ht <thing>
zbacktrace
print_cvs

Release Procedure

• Open package.xml
• Copy the current release into a new changelog.release element
• Update the current release section (date/time/version/stability/notes)
• pecl package-validate to check everything looks good
• Increase/verify PHP_SCOUTAPM_VERSION version listed in zend_scoutapm.h
• Commit update to package.xml
• Rebuild from scratch (full-clean.sh, then build as above)
• make test to ensure everything passes locally
• Push the branch (optionally, make a PR to GitHub) to trigger CI to build
• Once passed, pecl package to generate the tgz
• Upload to pecl.php.net
• Make a GPG-signed tag with git tag -s <tagversion> and enter changelog notes in tag body
• git push origin <tagversion> to push the tag up
• Create a release from the tag (use same changelog notes)
• Shift the milestones along on GitHub