Skip to content

Commit

Permalink
update readme with group example
Browse files Browse the repository at this point in the history
  • Loading branch information
igrigorik committed Sep 8, 2011
1 parent 9017eb6 commit 11a5d59
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 61 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# GMetric

A pure Ruby client for generating Ganglia 3.1.x+ gmetric meta and metric packets and talking to your gmond / gmetad nodes over UDP protocol. Supports host spoofing, and all the same parameters as the gmetric command line executable.

[http://www.igvita.com/2010/01/28/cluster-monitoring-with-ganglia-ruby/](http://www.igvita.com/2010/01/28/cluster-monitoring-with-ganglia-ruby/)

## Example: Sending a gmetric to a gmond over UDP

```ruby
Ganglia::GMetric.send("127.0.0.1", 8670, {
:name => 'pageviews',
:units => 'req/min',
:type => 'uint8',
:value => 7000,
:tmax => 60,
:dmax => 300,
:group => 'test'
})
```

## Example: Generating the Meta and Metric packets

```ruby
g = Ganglia::GMetric.pack(
:slope => 'positive',
:name => 'ruby',
:value => rand(100),
:tmax => 60,
:units => '',
:dmax => 60,
:type => 'uint8'
)

# g[0] = meta packet
# g[1] = gmetric packet

s = UDPSocket.new
s.connect("127.0.0.1", 8670)
s.send g[0], 0
s.send g[1], 0
```

### License

The MIT License, Copyright (c) 2009 Ilya Grigorik
61 changes: 0 additions & 61 deletions README.rdoc

This file was deleted.

0 comments on commit 11a5d59

Please sign in to comment.