Gearman UI is small a PHP application providing a minimal monitoring dashboard for a cluster of Gearman Job Servers.

It pings the registered Gearman servers for information on a fixed timeout, using the admin Gearman API and a slightly modified version of the PEAR Net_Gearman extension.

It is built on Silex and AngularJS to provide a solid, extensible and fast way to visually follow the activity of your job queues.

Running Gearman UI

Getting it to run on your server should be easy but it does involve a little bit more that just downloading a php file.

Installation

• Download and install Composer. Detailed installation instructions on Unix based or Windows systems is available here.

• Download and install Bower. Detailed installation instructions on Unix based or Windows systems is available here.

• Clone the Gearman UI repository:

  git clone git://github.com/gaspaio/gearmanui.git gearman-ui

• Install the application PHP dependencies throught Composer :

  cd gearman-ui
  composer install --no-dev
  

• Install client-side dependencies throught Bower:

  bower install
  

• Set up the YAML configuration file :

   cp config.yml.dist config.yml

  Modify the configuration parameters to fit your needs. The defaulf config file should be self explanatory :

  
  # The list of servers to monitor.
  gearmanui.servers:
  - name: "Localhost"
    addr: "127.0.0.1:4730"
  
  gearmanui.settings:
  # The javascript will ajax the server every
  # 'refresh_interval' seconds for new information.
    refresh_interval: 5
  
  # Log file.
  # The default location is "APP_DIR/logs/gearmanui.log".
  # Uncomment to set a custom location for the log file.
  # monolog.logfile: "/var/log/gearmanui.log"
  
  # Logger level.
  # Valid values: error, warning, notice, info, debug.
  monolog.level: "error"
  

• Configure the web server to serve the application directory, with URL rewriting. Detailed instructions for different webservers are available on the Silex website.

• Make sure your web server has write permissions on the log directory. By default, the file is located in the logs directory, at the root of the application.

That's it, you should be able to access Gearman UI on your web browser.

Contributing to the projet

If you find bugs or comme up with some useful feature requests, let me know through the project issue queue.

Pull requests with corrections or new features are obviously very very welcome.

Gearman links

Quite a lot of documentation on Gearman exists. If you know you need Gearman UI, then you surelly have read most of the available documentation.

Gearman UI was inspired by an older UI projet: Gearman Monitor.