datadog-sync 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76d02c9e4e60bab67d69c9433d13f8c54a13ee66
-  data.tar.gz: 3689e39795d3a0af528add8829bb721df44636aa
+  metadata.gz: 362ba91faa77c572762565e3c667b04f7fbd0b84
+  data.tar.gz: 7f4a527f215f75d84469562ccd0c1e1ca0d678c9
 SHA512:
-  metadata.gz: 869e8877bc21dd2e56d6a9bb6c6ff8e06fe4675b59fe1e8cf3fbf09abcb1f07cbb7dd52626522a9ba4f655ab2462ab8df34df55ae05ece84f56b6b3ba2752afd
-  data.tar.gz: 367443a485eb1c51f76da3778a9ed90f7307826883f45cd1b99b92af167d28851d47ebe12225e4ad4467623b0384863731d27e59ba8bc3fafdeb2702b1d2f597
+  metadata.gz: 8045b667b2c03d28d358a3711e8b14418da5f20547c1fd80075169272ddd39c07ea86e01b8b1446edd160521e79b6e170aa48b6b9e2c5528ea7da9794035d3ef
+  data.tar.gz: 49e0885662df6d105f3b7de59c058a606c837baa38a26dfa84f9dc7f231ad6530354d7ca11a30e9a605a0fe36f89f1ba1d9613d56feeb80c711a31ff70e3e77d

data/Rakefile

@@ -1,12 +1,15 @@
 require 'rubygems'
 require 'rubygems/package_task'
 
+$:.push File.expand_path("../lib", __FILE__)
+require "datadog_sync/version"
+
 gemspec = eval(File.read("datadog-sync.gemspec"))
 Gem::PackageTask.new(gemspec).define
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+  version = DatadogSync::VERSION
 
   rdoc.rdoc_dir = "rdoc"
   rdoc.title = "datadog-sync #{version}"

data/lib/datadog_sync/base.rb

@@ -1,6 +1,19 @@
+# Tool to import/export Datadog dashboards.
+# * Backup in case if someone accidentally deletes dashboard and ability to recreate it with single command
+# * Ability to keep dashboards in git repo, make modifications using text editor, suggest Pull Requests
+# * YAML format providing simpler way to describe dashboards without repeating a lot of things in chatty JSON. Example: https://github.com/xeron/datadog-sync/blob/master/examples/dashboard_example.yml
+# * Automation purposes (for example creating new dashboard or adding graphs when you deploy new version of application)
 class DatadogSync
-  attr_reader :dd_client, :logger
+  attr_reader :dd_client, :logger # :nodoc:
 
+  # Create DatadogSync instance.
+  #
+  # ==== Attributes
+  # * +api_key+ - Datadog API key (String)
+  # * +app_key+ - Datadog APP key (String)
+  # * +options+ - Options (Hash)
+  #   * +log_level+ - :debug < :info < :warn < :error < :fatal < :unknown
+  #   * +log_target+ - log file path, +STDOUT+ by default
   def initialize(api_key, app_key, options={})
     default_options = {
       log_level: :info,

data/lib/datadog_sync/errors.rb

@@ -1,4 +1,7 @@
 class DatadogSync
+  # Raised when something doesn't exist
   DoesNotExist = Class.new(RuntimeError)
+
+  # Raised when something already exists
   AlreadyExists = Class.new(RuntimeError)
 end

data/lib/datadog_sync/save_dashboards.rb

@@ -1,4 +1,11 @@
 class DatadogSync
+  # Save dashboards from Datadog to the filesystem (export from DD).
+  #
+  # ==== Attributes
+  # * +dashboards_path+ - local path where to save json files with dashboard data (String)
+  # * +title_pattern+ - pattern to filter dashboards by name using regex, empty by default (String)
+  # ==== Returns
+  # * IDs of saved dashboards (Array)
   def save_dashboards(dashboards_path, title_pattern="")
     regex = Regexp.new(title_pattern)
     base_path = File.expand_path(dashboards_path)
@@ -16,7 +23,7 @@ class DatadogSync
     logger.info "Found #{all_dashes.count} dashboards"
 
     filtered_dashes = all_dashes.select { |dash| dash["title"] =~ regex }
-    filtered_dashes_ids = filtered_dashes.collect { |dash| dash["id"] }
+    filtered_dashes_ids = filtered_dashes.collect { |dash| dash["id"].to_i }
 
     logger.info "Saving #{filtered_dashes.count} dashboards with pattern /#{title_pattern}/ into '#{base_path}'"
 
@@ -28,5 +35,7 @@ class DatadogSync
         f.puts JSON.pretty_generate(dash_data)
       end
     end
+
+    return filtered_dashes_ids
   end
 end

data/lib/datadog_sync/update_dashboards.rb

@@ -1,4 +1,11 @@
 class DatadogSync
+  # Update dashboards in Datadog from the local filesystem (import to DD).
+  #
+  # ==== Attributes
+  # * +dashboards_path+ - local path where to load json files from (String)
+  # * +title_pattern+ - pattern to filter dashboards by name using regex, empty by default (String)
+  # ==== Returns
+  # * IDs of updated dashboards (Array)
   def update_dashboards(dashboards_path, title_pattern="")
     regex = Regexp.new(title_pattern)
     base_path = File.expand_path(dashboards_path)
@@ -13,16 +20,21 @@ class DatadogSync
     logger.info "Found #{all_dash_files.count} local dashboards"
 
     filtered_dashes = []
+    filtered_dashes_ids = []
     all_dash_files.each do |file|
       data = JSON.parse(File.read(file))
-      filtered_dashes << data if data["title"] =~ regex
+      if data["title"] =~ regex
+        filtered_dashes << data
+        filtered_dashes_ids << data["id"]
+      end
     end
-    # filtered_dashes_ids = filtered_dashes.collect { |dash| dash["id"] }
 
     logger.info "Updating #{filtered_dashes.count} dashboards with pattern /#{title_pattern}/ from '#{base_path}'"
 
     filtered_dashes.each do |dash|
       dd_client.update_dashboard(dash["id"], dash["title"], dash["description"], dash["graphs"], dash["template_variables"])
     end
+
+    return filtered_dashes_ids
   end
 end

data/lib/datadog_sync/version.rb

@@ -1,3 +1,4 @@
 class DatadogSync
-  VERSION = '0.0.2'
+  # Version of library
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog-sync
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ivan Larionov