An example on using custom events, tags and aggregation

custom_event.rb

require 'rubygems'
require 'dogapi'

# Create a simple client
# The host is optional here, it's a shortcut to tie event and metrics to a given host
#
# You typically want to do:
#   Dogapi::Client.new(your_actual_api_key_as_a_string, ...)
# We are using ENV to let you experiment via an environment variable.
dog = Dogapi::Client.new(ENV['DATADOG_KEY'])

# Let's use tags and aggregation
# We will send 2 related events, one error and one success.

dog.emit_event(Dogapi::Event.new("Uh-oh, something bad happened",
                                 :msg_title       => "Alert! Alert!",
                                 :aggregation_key => "job-123",
                                 :alert_type      => "error",
                                 :tags            => ["ruby", "dogapi"]
                                 ))

dog.emit_event(Dogapi::Event.new("Now that's better",
                                 :msg_title       => "All systems green",
                                 :aggregation_key => "job-123",
                                 :alert_type      => "success",
                                 :tags            => ["ruby", "dogapi"]
                                 ))

# You should see something like this in your stream:
# screenshot: https://img.skitch.com/20120705-3s4icgxfc689x1jtrx1yr1m5k.png

# And if you graph a metric and want to overlay these events on the graphs
# You can use the following query: "tags:dogapi tags:ruby" in the graph editor
# screenshot: https://img.skitch.com/20120705-m4h6f4377cbm2d3rctnd6biej9.png

# Then you can see the events neatly overlaid on your graph
# screenshot: https://img.skitch.com/20120705-xybhimti31u4s4m42ac854568h.png