Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.45 KB

INSTALL.md

File metadata and controls

20 lines (13 loc) · 1.45 KB

To begin with, you need to install the XHProf extension. Refer to the PHP documentation if you need assistance.

You will need to manually create the database and populate it with the provided scheme. The database scheme is located at /setup/database.sql.

Rename the /xhprof/includes/config.inc.sample.php to /xhprof/includes/config.inc.php. There are only two supported parameters.

  • xhprof_url is the URL to the XHProf.io library.
  • pdo is the PDO instance. This library uses PDO to handle all of the database operations.

For XHProf.io to start collecting data, you need /inc/prepend.php and /inc/append.php files included to every file of interest. The recommended approach is to update your php.ini configuration to automatically prepend and append these files.

; Automatically add files before PHP document.
; http://www.php.net/manual/en/ini.core.php#ini.auto-prepend-file
auto_prepend_file = /[absolute path to xhprof.io]/inc/prepend.php

; Automatically add files after PHP document.
; http://www.php.net/manual/en/ini.core.php#ini.auto-append-file
auto_append_file = /[absolute path to xhprof.io]/inc/append.php

If you are using PHP-FPM, then XHProf.io will utilise fastcgi_finish_request to hide any overhead related to data collection. There is nothing to worry about if you are not using PHP-FPM either, as the overhead is less than a few milliseconds.