/xhgui-data-collector

A Minimal Data Collector for XHGUI.

Primary LanguagePHP

Build Status Scrutinizer Code Quality

XHGUI Data Collector

This is a small standalone module which you can use to collect and store XHProf performance data for later usage in XHGUI.

Goals

  • Compatibility with PHP >= 5.3.0
  • No dependencies aside from the relevant extensions
  • Customizable and configurable so you can build your own logic on top of it

XHGUI Compatibility

This project was originally forked from perftools/xhgui@133051f, which was after the tag 0.7.1.

This should ensure compatibility for most tags up to 0.7.1 (included).

The only thing to break compatibility would be a schema change on XHGUI side.

This table represents current known information about compatibility between this project and XHGUI data schema.

XHGUI Data Collector version XHGUI Version Compatibility
1.0.0 0.2.0 - 0.7.1 presumed compatible - schema is the same

Usage

You can use this to build your own saving library or just configure as described in XHGUI manual and include external/header.php as an auto_prepend_file (also described in XHGUI manual)

System Requirements

For using the data collection classes you will need the following:

  • PHP version 5.3 or later.
  • XHProf, Uprofiler or Tideways to actually profile the data.
  • Some way to access a MongoDB server. Choose either:
    • MongoDB Extension>=1.3.0 (MongoDB PHP driver from pecl)
    • alcaeus/mongo-php-adapter composer dependency.
  • a MongoDB server. XHGUI requires version 2.2.0 or later.

When in doubt, refer to XHGUI repository's composer.json or this repository's composer.json suggests section.