Ratchet.io server-side agent
Project description
A daemon to monitor log files and push messages to Ratchet.io.
Requirements
ratchet-agent requires:
A unix-like system (tested on Fedora Linux and Mac OS X)
Python 2.6+
requests 0.13.1+
a Ratchet.io account
Installation
Install with pip:
pip install ratchet-agent
See Configuration for configuration options to make it actually useful.
Ratchetd comes with an example init.d script, chkconfig compatible and tested on Fedora Linux. To install it, symlink ratchet-agent-init.sh to /etc/init.d/ratchet-agent and add to chkconfig:
ln -s /path/to/ratchet-agent/ratchet-agent-init.sh /etc/init.d/ratchet-agent chkconfig --add ratchet-agent chkconfig on ratchet-agent service ratchet-agent start
Configuration
Configuration options for ratchet-agent itself are in ratchet-agent.conf. If you’re using the init script, it has a few of its own configuration variables inside which control how it runs.
``ratchet-agent.conf`` At the bare minimum, you will want to change the following variables:
params.access_token – your Ratchet.io access token
targets – white-space-separated list of files or directories (non-recursive) to process.
Setting the following variables will enable github integration:
params.root – path to your code root
params.branch – the current branch
params.github.account – your github account name
params.github.repo – your github repo name
Other options are documented in the sample config file.
``ratchet-agent-init.sh`` Configuration variables should be self-explanatory. If you’re not using a virtualenv, set VIRTUALENV="".
Contributing
Contributions are welcome. The project is hosted on github at http://github.com/brianr/ratchet-agent
Additional Help
If you have any questions, feedback, etc., drop me a line at brian@ratchet.io
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.