Sha256: 729363a087ffe69f1358f43d79e371d602a3cb7a2ea3cb6e895ef9580ccb01b6

Contents?: true

Size: 1.46 KB

Versions: 1

Compression:

Stored size: 1.46 KB

Contents

RubyXymon [![Build Status](https://travis-ci.org/rubyisbeautiful/ruby_xymon.png)](https://travis-ci.org/rubyisbeautiful/ruby_xymon)
========

A simple gem for Xymon

Thanks to Greg Faust

## Installation

Add this line to your application's Gemfile:

    gem 'xymon'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install xymon

## Usage

In its current state, the gem is simple to use.  You can set two configuration variables, host and port, like this:
>> RubyXymon.config[:host] = 'localhost'
>> RubyXymon.config[:port] = '1984'
The values in the example are the defaults.
You can also set the configuration at once, using either a Hash or a String, which points to a file:
>> RubyXymon.config = { :host => 'localhost' }
>> RubyXymon.config = "/some/dir/xymon.yml"

You can send a raw Xymon message using the send method:
>> RubyXymon.send("status www.http green `date` Web OK")

For more information on Xymon, see the [![Xymon man page](http://www.xymon.com/xymon/help/manpages/man1/xymon.1.html#lbAF)]


##

Future improvements:
* methods based on Xymon messages.  Each message has its own syntax, e.g. RubyXymon.status(lifetime, group, hostname, testname, color, txt)
* methods to read from Xymon, e.g. "query" message


## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
ruby_xymon-0.0.2 README.md