Ruby Client for Datadog API
The Ruby client is a library suitable for inclusion in existing Ruby projects or for development of standalone scripts. It provides an abstraction on top of Datadog's raw HTTP interface for reporting events and metrics.
See CHANGELOG.md for details
Available at: github.com/DataDog/dogapi-rb
$ cd dogapi-rb $ bundle $ rake install
Gem page: rubygems.org/gems/dogapi
$ gem install dogapi
If you get a permission error, you might need to run the install process with sudo:
$ sudo gem install dogapi
If you get a LoadError, missing mkmf, you need to install the development packages for ruby.
# on ubuntu e.g. $ sudo apt-get install ruby-dev
How to find your API and application keys
Go to your setup page.
A word about hosts and devices
Events and metric data points can be attached to hosts to take advantage of automatic tagging with the host's tags.
If you want to attach events and points to a specific device on a host, simply specify the device when calling emit functions.
Submit an event to Datadog
require 'rubygems' require 'dogapi' api_key = "abcdef123456" # submitting events doesn't require an application_key, so we don't bother setting it dog = ::.(api_key) dog.emit_event(::.('Testing done, FTW'), :host => "my_host")
Tag a host in Datadog
require 'rubygems' require 'dogapi' api_key = "abcdef123456" application_key = "fedcba654321" dog = ::.(api_key, application_key) dog.("my_host", ["tagA", "tagB"])
Submit a metric to Datadog
You want to track a new metric called
name and have just sampled it from
my_host. Its value is 50. Here is how you submit the value to Datadog.
require 'rubygems' require 'dogapi' api_key = "abcdef123456" # submitting metrics doesn't require an application_key, so we don't bother setting it dog = ::.(api_key) dog.emit_point('some.metric.name', 50.0, :host => "my_host", :device => "my_device")
Let us now assume that you have sampled the metric multiple times and you would like to submit the results. You can use the
emit_points method (instead of
emit_point). Since you are submitting more than one data point you will need to pass a list of
float pairs, instead of a simple
require 'rubygems' require 'dogapi' # Actual sampling takes place t1 = Time.now val1 = 50.0 # some time elapses t2 = Time.now val2 = 51.0 # some more time elapses t3 = Time.now val3 = -60.0 api_key = "abcdef123456" dog = ::.(api_key) dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device")