[Summary view] [Print] [Text view]

   1  @title Installing XHProf
   2  @group developer
   3  
   4  Describes how to install XHProf, a PHP profiling tool.
   5  
   6  Overview
   7  ========
   8  
   9  You can install XHProf to activate the XHProf tab in DarkConsole and the
  10  `--xprofile` flag from the CLI. This will allow you to generate performance
  11  profiles of pages and scripts, which can be tremendously valuable in identifying
  12  and fixing slow code.
  13  
  14  Installing XHProf
  15  =================
  16  
  17  XHProf is a PHP profiling tool. You don't need to install it unless you are
  18  developing Phabricator and making performance changes.
  19  
  20  You can install xhprof with:
  21  
  22    $ pecl install xhprof
  23  
  24  If you have a PEAR version prior to 1.9.3, you may run into a `phpize` failure.
  25  If so, you can download the source and build it with:
  26  
  27    $ cd extension/
  28    $ phpize
  29    $ ./configure
  30    $ make
  31    $ sudo make install
  32  
  33  You may also need to add `extension=xhprof.so` to your php.ini.
  34  
  35  See <https://bugs.php.net/bug.php?id=59747> for more information.
  36  
  37  Using XHProf: Web
  38  =================
  39  
  40  To profile a web page, activate DarkConsole and navigate to the XHProf tab.
  41  Use the **Profile Page** button to generate a profile.
  42  
  43  Using XHProf: CLI
  44  =================
  45  
  46  From the command line, use the `--xprofile <filename>` flag to generate a
  47  profile of any script.
  48  
  49  Next Steps
  50  ==========
  51  
  52  Continue by:
  53  
  54    - enabling DarkConsole with @{article:Using DarkConsole}.