dogapi-demo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e504a22398729fed74aeafe8f837c5801a3955f0
+  data.tar.gz: e44e854e1101e22c0efc636bab841348f630cfb6
+SHA512:
+  metadata.gz: a04b7ed0c0cbbbfcbf2e1f2405ab70f664e8c7107425428fa81d2320a55ffc036c21d5cf7a430af480ae3679d1a58b9db327b04f21cdf7e7ba2fcb4a7475d04a
+  data.tar.gz: f4ecdf66407c69d31a59ed29432f4edb65ebfa8946e2ae071f234b629b0a2f8c3a9d2b0c410f729cb28813b82df3857a0ab549a29cb6022ea83e2affda119cc2

data/.gitignore

@@ -0,0 +1,10 @@
+*.rb~
+.DS_store
+.rbenv
+.ruby-gemset
+.ruby-version
+.rvm
+Gemfile.lock
+doc/
+pkg/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.tailor

@@ -0,0 +1,106 @@
+#------------------------------------------------------------------------------
+# Horizontal Whitespace
+#------------------------------------------------------------------------------
+# allow_hard_tabs         True to let hard tabs be considered a single space.
+#                         Default:      false
+#
+# allow_trailing_line_spaces
+#                         True to skip detecting extra spaces at the ends of
+#                         lines.
+#                         Default:      false
+#
+# indentation_spaces      The number of spaces to consider a proper indent.
+#                         Default:      2
+#
+# max_line_length         The maximum number of characters in a line before
+#                         tailor complains.
+#                         Default:      80
+# spaces_after_comma      Number of spaces to expect after a comma.
+#                         Default:      1
+#
+# spaces_before_comma     Number of spaces to expect before a comma.
+#                         Default:      0
+#
+# spaces_after_lbrace     The number of spaces to expect after an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_lbrace    The number of spaces to expect before an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_rbrace    The number of spaces to expect before an rbrace ('}').
+#                         Default:      1
+#
+# spaces_in_empty_braces  The number of spaces to expect between braces when
+#                         there's nothing in the braces (i.e. {}).
+#                         Default:      0
+#
+# spaces_after_lbracket   The number of spaces to expect after an
+#                         lbracket ('[').
+#                         Default:      0
+#
+# spaces_before_rbracket  The number of spaces to expect before an
+#                         rbracket (']').
+#                         Default:      0
+#
+# spaces_after_lparen     The number of spaces to expect after an
+#                         lparen ('(').
+#                         Default:      0
+#
+# spaces_before_rparen    The number of spaces to expect before an
+#                         rbracket (')').
+#                         Default:      0
+#
+#------------------------------------------------------------------------------
+# Naming
+#------------------------------------------------------------------------------
+# allow_camel_case_methods
+#                         Setting to true skips detection of camel-case method
+#                         names (i.e. def myMethod).
+#                         Default:      false
+#
+# allow_screaming_snake_case_classes
+#                         Setting to true skips detection of screaming
+#                         snake-case class names (i.e. My_Class).
+#                         Default:      false
+#
+#------------------------------------------------------------------------------
+# Vertical Whitespace
+#------------------------------------------------------------------------------
+# max_code_lines_in_class The number of lines of code in a class to allow before
+#                         tailor will warn you.
+#                         Default:      300
+#
+# max_code_lines_in_method
+#                         The number of lines of code in a method to allow
+#                         before tailor will warn you.
+#                         Default:      30
+#
+# trailing_newlines       The number of newlines that should be at the end of
+#                         the file.
+#                         Default:      1
+#
+Tailor.config do |config|
+  config.formatters "text"
+  config.file_set 'lib/**/*.rb' do |style|
+    style.allow_camel_case_methods false, level: :error
+    style.allow_hard_tabs false, level: :error
+    style.allow_screaming_snake_case_classes false, level: :error
+    style.allow_trailing_line_spaces false, level: :error
+    style.allow_invalid_ruby false, level: :warn
+    style.indentation_spaces 2, level: :error
+    style.max_code_lines_in_class 300, level: :error
+    style.max_code_lines_in_method 33, level: :error
+    style.max_line_length 160, level: :warn
+    style.spaces_after_comma 1, level: :error
+    style.spaces_after_lbrace 1, level: :error
+    style.spaces_after_lbracket 0, level: :error
+    style.spaces_after_lparen 0, level: :error
+    style.spaces_before_comma 0, level: :error
+    style.spaces_before_lbrace 1, level: :error
+    style.spaces_before_rbrace 1, level: :error
+    style.spaces_before_rbracket 0, level: :error
+    style.spaces_before_rparen 0, level: :error
+    style.spaces_in_empty_braces 0, level: :error
+    style.trailing_newlines 1, level: :error
+  end
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+- 2.1
+- 2.2
+- 2.3.0
+env:
+  secure: hKn4OWJZ3gKvdGVZd5VTnpRb7GB5eEtF7qc0+zOwusL1bxxSXvuNTLecqvKZpDH5uCnRCx8Dz52hSA5KzNoBoH2dPhyeC8en4/gZWbxndHYg/2qFBeHO4FP/Li3B9DmZt247IkuzK1oI4k5GkFyVw7OVrjxSVb50hjbanddkkmg=

data/CHANGELOG.md

@@ -0,0 +1,157 @@
+Changes
+=======
+
+# 1.22.0 / 2016-04-14
+* [FEATURE] Metric query API. See [#88][], [#90][] (thanks [@blakehilscher][])
+
+# 1.21.0 / 2015-10-30
+* [FEATURE] User CRUD API. See [#82][]
+* [IMPROVEMENT] Support capistrano SimpleTextFormatter (thanks [@rmoriz][] [#81][])
+
+# 1.20.0 / 2015-07-29
+* [FEATURE] Embeddable graphs API. See [#73][]
+
+# 1.19.0 / 2015-06-22
+* [FEATURE] Revoke a shared a Screenboard. See [#69][]
+
+# 1.18.0 / 2015-06-01
+* [FEATURE] Add support for host muting.
+
+# 1.17.0 / 2015-03-26
+* [IMPROVEMENT] Use MultiJSON for JSON handling. (thanks [@winebarrel][] [#64][])
+
+# 1.16.0 / 2015-03-06
+* [IMPROVEMENT] Return response from API when metrics are sent as a batch. (thanks [@yyuu][] [#62](https://github.com/DataDog/dogapi-rb/pull/62))
+
+# 1.15.0 / 2015-02-03
+* [BUGFIX] Add open_timeout to avoid stuck HTTP calls (thanks [@Kaixiang][] [#55](https://github.com/DataDog/dogapi-rb/pull/55))
+* [BUGFIX] Encode capistrano output messages to UTF-8 before manipulating them. (thanks [@byroot][] [#52](https://github.com/DataDog/dogapi-rb/pull/52))
+
+# 1.14.0 / 2015-01-09
+* [FEATURE] Add get_all_screenboards [#61](https://github.com/DataDog/dogapi-rb/pull/61)
+* [IMPROVEMENT] Remove required start argument from schedule_downtime [#60](https://github.com/DataDog/dogapi-rb/pull/60)
+
+# 1.13.0 / 2014-12-10
+* [FEATURE] Add tag filter to get_all_monitors [#58](https://github.com/DataDog/dogapi-rb/pull/58)
+* [FEATURE] Add update downtime method [#59](https://github.com/DataDog/dogapi-rb/pull/59)
+
+# 1.12.0 / 2014-11-17
+* [FEATURE] Add support for the Monitor API [#51](https://github.com/DataDog/dogapi-rb/pull/51)
+* [IMPROVEMENT] Truncate event title and text before submission [#53](https://github.com/DataDog/dogapi-rb/pull/53)
+
+# 1.11.0 / 2014-07-03
+* [IMPROVEMENT] Add support for HTTP proxy defined by the environment variables
+* [IMPROVEMENT] Allow to send several metrics in the same HTTP request
+
+# 1.10.0 / 2014-05-13
+* [IMPROVEMENT] Make HTTP timeout configurable ([#29](https://github.com/DataDog/dogapi-rb/issues/29))
+* [IMPROVEMENT] Re-enable SSL verification ([#37](https://github.com/DataDog/dogapi-rb/issues/37))
+* [IMPROVEMENT] Report application name when deploy with Capistrano (thanks [@ArjenSchwarz][] [#46](https://github.com/DataDog/dogapi-rb/pull/46))
+
+# 1.9.2 / 2014-02-13
+* [IMPROVEMENT] Fully support for capistrano v3 ([#43](https://github.com/DataDog/dogapi-rb/pull/43))
+* [IMPROVEMENT] Strip control characters from capistrano messages ([#36](https://github.com/DataDog/dogapi-rb/issues/36))
+* [IMPROVEMENT] Tag capistrano events by stage (thanks [@arielo][] [#25](https://github.com/DataDog/dogapi-rb/pull/25))
+
+# 1.9.1 / 2014-01-06
+* [IMPROVEMENT] Log a warning instead of crashing when trying to integration with capistrano v3
+
+# 1.9.0 / 2013-09-06
+* [IMPROVEMENT] When emitting a metric without an explicit host, default to local hostname.
+
+# 1.8.1 / 2013-08-22
+* [FEATURE] Update Dash API to support template variables.
+
+# 1.8.0 / 2013-07-16
+* [FEATURE] Add an API for interacting with Screenboards
+
+# 1.7.1 / 2013-06-23
+* [BUGFIX] Fix bug in capistrano integration with logging of nil (thanks [@arielo][])
+* [FEATURE] Add an API for inviting users
+* [FEATURE] Add an API for taking graph snapshots
+
+# 1.7.0
+* Not released.
+
+# 1.6.0 / 2013-02-19
+* [FEATURE] Support for setting `source` type when submitting host tags
+
+# 1.5.2 / 2013-02-13
+* [BUGFIX] Fix a bug in hashing the Event object when the instance variables are symbols.
+
+# 1.5.0 / 2012-11-06
+* [FEATURE] Alerting API
+
+# 1.4.3
+* [BUGFIX] Fix bug with capistrano integration for capistrano 2.13.5 (thanks [@ansel1][])
+
+# 1.4.2
+* [BUGFIX] Added missing dashboards endpoint.
+
+# 1.4.1
+* [BUGFIX] Fixed searching for events with tags.
+
+# 1.4.0
+* [FEATURE] Added support for the dashboard, search and comment API endpoints.
+
+# 1.3.6
+* [BUGFIX] Small fix for capistrano integration
+
+# 1.3.4
+* [BUGFIX] Various bug fixes (event.to_hash, md5 import, capistrano lambda roles)
+
+# 1.3.3
+* [BUGFIX] Bug fix for submitting counters
+
+# 1.3.2
+* [IMPROVEMENT] Support an aggregation key to aggregate events together
+
+# 1.3.1
+* [FEATURE] Metrics can be counters, rather than just gauges (thanks to [@treeder][])
+* [FEATURE] Metrics can be tagged.
+
+# 1.3.0
+* [FEATURE] Capistrano integration. See https://github.com/DataDog/dogapi-rb/tree/master/lib/capistrano
+
+# 1.2.x
+* [FEATURE] You can now manage host tags
+* [IMPROVEMENT] Functionality relating to events with a duration has been deprecated
+* [IMPROVEMENT] The underlying clients have been updated to use Datadog's new public HTTP API[https://github.com/DataDog/dogapi/wiki]
+* [IMPROVEMENT] You can now get event details and query the stream in addition to posting events
+
+# 1.1.x
+* [IMPROVEMENT] You do not need to use environment variables anymore to use the client.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#25]: https://github.com/DataDog/dogapi-rb/issues/25
+[#29]: https://github.com/DataDog/dogapi-rb/issues/29
+[#36]: https://github.com/DataDog/dogapi-rb/issues/36
+[#37]: https://github.com/DataDog/dogapi-rb/issues/37
+[#43]: https://github.com/DataDog/dogapi-rb/issues/43
+[#46]: https://github.com/DataDog/dogapi-rb/issues/46
+[#51]: https://github.com/DataDog/dogapi-rb/issues/51
+[#52]: https://github.com/DataDog/dogapi-rb/issues/52
+[#53]: https://github.com/DataDog/dogapi-rb/issues/53
+[#55]: https://github.com/DataDog/dogapi-rb/issues/55
+[#58]: https://github.com/DataDog/dogapi-rb/issues/58
+[#59]: https://github.com/DataDog/dogapi-rb/issues/59
+[#60]: https://github.com/DataDog/dogapi-rb/issues/60
+[#61]: https://github.com/DataDog/dogapi-rb/issues/61
+[#62]: https://github.com/DataDog/dogapi-rb/issues/62
+[#64]: https://github.com/DataDog/dogapi-rb/issues/64
+[#69]: https://github.com/DataDog/dogapi-rb/issues/69
+[#73]: https://github.com/DataDog/dogapi-rb/issues/73
+[#81]: https://github.com/DataDog/dogapi-rb/issues/81
+[#82]: https://github.com/DataDog/dogapi-rb/issues/82
+[#88]: https://github.com/DataDog/dogapi-rb/issues/88
+[#90]: https://github.com/DataDog/dogapi-rb/issues/90
+[@ArjenSchwarz]: https://github.com/ArjenSchwarz
+[@Kaixiang]: https://github.com/Kaixiang
+[@ansel1]: https://github.com/ansel1
+[@arielo]: https://github.com/arielo
+[@blakehilscher]: https://github.com/blakehilscher
+[@byroot]: https://github.com/byroot
+[@rmoriz]: https://github.com/rmoriz
+[@treeder]: https://github.com/treeder
+[@winebarrel]: https://github.com/winebarrel
+[@yyuu]: https://github.com/yyuu

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'rake', '>= 2.4.2'
+  gem 'rdoc'
+  gem 'rspec'
+  gem 'vcr'
+  gem 'webmock'
+end
+
+group :quality do
+  gem 'tailor'
+end

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2011, Datadog <info@datadoghq.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Datadog nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL DATADOG BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.rdoc

@@ -0,0 +1,143 @@
+= Ruby Client for Datadog API
+
+{<img src="https://badge.fury.io/rb/dogapi.png" alt="Gem Version" />}[http://badge.fury.io/rb/dogapi]
+
+{<img src="https://travis-ci.org/DataDog/dogapi-rb.png?branch=master" alt="Build Status" />}[https://travis-ci.org/DataDog/dogapi-rb]
+
+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.
+
+= What's new?
+
+See CHANGELOG.md for details
+
+= Installation
+
+== From Source
+
+Available at: https://github.com/DataDog/dogapi-rb
+
+    $ cd dogapi-rb
+    $ bundle
+    $ rake install
+
+== Using RubyGems
+
+Gem page: https://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
+
+= Usage
+
+== How to find your API and application keys
+
+Go to your setup page[https://app.datadoghq.com/account/settings].
+
+== 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 = Dogapi::Client.new(api_key)
+
+    dog.emit_event(Dogapi::Event.new('Testing done, FTW'), :host => "my_host")
+
+
+== Tag a host in Datadog
+
+
+    require 'rubygems'
+    require 'dogapi'
+
+    api_key = "abcdef123456"
+    application_key = "fedcba654321"
+
+    dog = Dogapi::Client.new(api_key, application_key)
+
+    dog.add_tags("my_host", ["tagA", "tagB"])
+
+
+== Submit a metric to Datadog
+
+You want to track a new metric called +some+.+metric+.+name+ and have just sampled it from +my_device+ on +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 = Dogapi::Client.new(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 +Time+, +float+ pairs, instead of a simple +float+ value.
+
+
+    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 = Dogapi::Client.new(api_key)
+
+    dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device")
+
+
+== Get points from a Datadog metric
+
+    require 'rubygems'
+    require 'dogapi'
+
+    api_key = "abcd123"
+    application_key = "brec1252"
+
+    dog = Dogapi::Client.new(api_key, application_key)
+
+    # get points from the last hour
+    from = Time.now - 3600
+    to = Time.now
+
+    query = 'sum:metric.count{*}.as_count()'
+
+    dog.get_points(query, from, to)
+
+
+