sidekiq-datadog-monitor 0.0.0 → 0.0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f45794395b62656e91167f2a556b145732800b08bc3a0b244145000a9dad33ea
-  data.tar.gz: a974754085c6e22572e8a8121996487fb5480e3beb550797a64c4e19a2f29486
+  metadata.gz: 7465b128d6d438118a8d64e3ce288f35c128e7442f1e0fc7e58f20960c6dc6a1
+  data.tar.gz: 79b460c74b8e795eb66dceefeb43ab1f7a902599ba089bd09438f2e1cba780bd
 SHA512:
-  metadata.gz: 83f1261fc742416237eca7175e268b7fb8ccdd30b1a7838ae7d7b0701446a8fad4c780e19366b7755ed6d38249dbde064c6303180ae7e7913fa1073b0ec57ad2
-  data.tar.gz: 23ebf0bf41c49d6ce143e340f6376a75b016d35b64ba36aebe53095986dad969dea0c7ce9790c70bcb39151cfc5bdba87c6554aac681f9e56d13fe9d121a2e89
+  metadata.gz: 1ab63b86d1abba345dd6ebc265d833e439ab3b8920982a8309c5a6f358088d21c57ccdffceda70f1443b61f03d9783b8412064f548e9d4df56ee11fbd62d46a0
+  data.tar.gz: 3fde4c5e786a6732691ab65a192098b4db5327fd803be0716e5e9aa8c1afa7915a8bdd7695827d5d1b3708eb83c8eef106eb90747cabbe26d727b0f8c91027e8

data/README.md

@@ -1,15 +1,14 @@
 # Sidekiq::Datadog::Monitor
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq/datadog/monitor`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Library that gather sidekiq jobs metrics (currently, only size and latency)
+and send it to datadog
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sidekiq-datadog-monitor'
+gem 'sidekiq-datadog-monitor', '0.0.1'
 ```
 
 And then execute:
@@ -22,7 +21,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To start sending metrics
+
+```ruby
+# Import the library
+require 'sidekiq/datadog/monitor/data'
+
+# Initiate a Sidekiq::Datadog::Monitor client instance.
+Sidekiq::Datadog::Monitor::Data.initialize!(
+    {agent_host: 'localhost', 
+     agent_port: 8125,
+     env: 'production',    # optional
+     tag: 'tag',           # optional  
+     queue: 'queue name',  # optional
+     cron: "*/30 * * * *" # default: "*/1 * * * *"
+     } 
+    )
+
+```
+`agent_host` and `agent_port` instantiate DogStatsD client 
+
+`env`, `tag`, `queue` settings for background job that will gather and send Sidekiq metrics
+
+`cron` - schedule settings for background job that will gather and send Sidekiq metrics
+
+
 
 ## Development
 

data/lib/sidekiq/datadog/config.rb

@@ -0,0 +1,13 @@
+module Sidekiq
+  module Datadog
+    class Config
+      class << self
+        def reload_schedule
+          Sidekiq.configure_server do |config|
+            Sidekiq::Scheduler.dynamic = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/datadog/monitor.rb

@@ -2,7 +2,7 @@ require "sidekiq/datadog/monitor/version"
 
 module Sidekiq
   module Datadog
-    module Monitor
+    module Monitor 
       class Error < StandardError; end
     end
   end

data/lib/sidekiq/datadog/monitor/data.rb

@@ -1,5 +1,9 @@
-require 'datadog/statsd'
+require "sidekiq/datadog/monitor"
+require "sidekiq/datadog/config"
 require 'sidekiq/datadog/monitor/metrics_worker'
+require 'sidekiq-scheduler'
+require 'sidekiq/api'
+
 module Sidekiq
   module Datadog
     module Monitor
@@ -8,16 +12,22 @@ module Sidekiq
           attr_reader :agent_port, :agent_host, :tag, :env, :queue, :cron
 
           def initialize!(options)
-            @agent_port = options[:agent_port]
-            @agent_host = options[:agent_host]
+            @agent_port, @agent_host = options.fetch_values(:agent_port, :agent_host)
             @tag = options[:tag] || ''
             @env = options[:env] || ''
             @queue = options[:queue] || ''
             @cron = options[:cron] || "*/1 * * * *"
 
+            Sidekiq::Datadog::Config.reload_schedule
+
             start
+
+          rescue StandardError => e
+            raise Sidekiq::Datadog::Monitor::Error.new(e.message)
           end
 
+          private
+
           def start
             Sidekiq.set_schedule('send_metrics', 
               { "cron"=> cron, 'class' => 'Sidekiq::Datadog::Monitor::MetricsWorker', 'queue' => queue })

data/lib/sidekiq/datadog/monitor/metrics_worker.rb

@@ -1,5 +1,5 @@
+require "sidekiq/datadog/monitor/data"
 require 'datadog/statsd'
-require 'sidekiq'
 
 module Sidekiq
   module Datadog
@@ -23,13 +23,13 @@ module Sidekiq
 
         def post_queue_size(queue_name, size)
           statsd.gauge('sidekiq.queue.size', size,
-                      tags: ["queue_name:#{queue_name}", "environment:#{Data.env}", Data.tag])
+                      tags: ["queue_name:#{queue_name}", "env:#{Data.env}", Data.tag])
         end
 
         def post_queue_latency(queue_name)
           latency = Sidekiq::Queue.new(queue_name).latency
           statsd.gauge('sidekiq.queue.latency', latency,
-                      tags: ["queue_name:#{queue_name}", "environment:#{Data.env}", Data.tag])
+                      tags: ["queue_name:#{queue_name}", "env:#{Data.env}", Data.tag])
         end
       end
     end

data/lib/sidekiq/datadog/monitor/version.rb

@@ -1,7 +1,7 @@
 module Sidekiq
   module Datadog
     module Monitor
-      VERSION = "0.0.0"
+      VERSION = "0.0.0.5"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-datadog-monitor
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.0.5
 platform: ruby
 authors:
 - aleksa_castle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,9 +56,6 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.1
@@ -66,19 +63,27 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.1
 - !ruby/object:Gem::Dependency
-  name: dogstatsd-ruby
+  name: sidekiq-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.8.1
@@ -86,9 +91,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.8.1
@@ -103,6 +105,7 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- lib/sidekiq/datadog/config.rb
 - lib/sidekiq/datadog/monitor.rb
 - lib/sidekiq/datadog/monitor/data.rb
 - lib/sidekiq/datadog/monitor/metrics_worker.rb