RubyGems Navigation menu

dogwatch 1.0.0

# DogWatch _A DSL to create DataDog monitors_ This gem is designed to provide a simple method for creating DataDog monitors in Ruby. ## Installation Add this line to your application's Gemfile: ```ruby gem 'dogwatch' ``` And then execute: ```shell $ bundle exec dogwatch create [--dogfile=DOGFILE] [--api_key=API KEY] [--app_key=APP KEY] ``` Or install it yourself as: ```shell $ gem install dogwatch ``` ## Credentials [DataDog API credentials](https://app.datadoghq.com/account/settings#api) are required. Generate both an api key and an app key and either place them in a file named `~/.dogwatch/credentials` or pass them via the command line. A sample credentials file is provided in the `example` directory. ## Usage DogWatch is a thin DSL over the [DataDog ruby client](https://github.com/DataDog/dogapi-rb) that handles generating DataDog monitors. The following is an example of a `Dogfile`: ```ruby require 'dogwatch' DogWatch.monitor do ## Create a new monitor - monitor name is REQUIRED monitor 'MONITOR NAME' do type :metric_alert # REQUIRED: One of [:metric_alert | :service_check | :event_alert] query 'QUERY' # REQUIRED message 'MESSAGE' tags %w(A list of tags to associate with your monitor) options do silenced '*': nil notify_no_data false no_data_timeframe 3 timeout_h 99 renotify_interval 60 escalation_message 'oh snap' include_tags true end end end ``` Monitors that already exist are matched by name and updated accordingly. If the name isn't matched exactly, DogWatch assumes you want a new monitor. A sample `Dogfile` is provided in the `example` directory. For a full list of options and a description of each parameter, see [DataDog's API documentation](http://docs.datadoghq.com/api/#monitors). ## TO DO * More descriptive errors * Better error handling if a monitor fails local validation

Gemfile:
=

install:
=

Versions:

  1. 1.2.0 November 20, 2017 (14.5 KB)
  2. 1.1.1 July 13, 2017 (14.5 KB)
  3. 1.1.0 May 25, 2017 (14 KB)
  4. 1.0.5 April 13, 2017 (13.5 KB)
  5. 1.0.4 June 07, 2016 (13.5 KB)
  6. 1.0.0 December 10, 2015 (14 KB)
Show all versions (9 total)

Runtime Dependencies (2):

dogapi ~> 1.21
thor ~> 0.19

Owners:

Authors:

  • David Greene

SHA 256 checksum:

=

Total downloads 20,291

For this version 2,228

Version Released:

License:

MIT

Required Ruby Version: >= 0

Links: