sidekiq-datadog-monitor 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d84d08e0320ca9b9e399bb8eff1efd74af038a534fe9936c8cfcfb3e169dc40
-  data.tar.gz: f7cedc8a2816f04c886a2a0c8f841d7cd2819bbb916cd59737208ceff35043c1
+  metadata.gz: 3fbb4c43b56e16ca4c1114a9a708fd0f45900493acdb6efab3ce90af4a704ef7
+  data.tar.gz: 022d9d4b5aa3a1ca5ac86efc890a6f6a074d28a3e5f5eae2f2dead5da571c90b
 SHA512:
-  metadata.gz: 6f1384e84c750d8510cc1102c9f4286276c8a6fdefa050e2576ce0baebde5da806859c8d4e34e316921260814fd4a251d8f20bd652073bb5bdee9a0af6fdbbda
-  data.tar.gz: 489cf5542ec468a81eb8e0c218b5f34babb3a23699e444e1702cf65cd105e8326f4667d01ab5765a599564600dba8c9e4a6564dd0a4a838766f9ece447b9e707
+  metadata.gz: 4b032a07e6380d5bec063d42dbf8c7b016ec2b67516b2411738f4aba49073ff0b5d3cd79b9bb562169ae02c9dccdfd41194341ad345aec45c9944ae9dc0dd94d
+  data.tar.gz: 606c4c763f38b5972809292b94fabd89ea28587f0a043845e237b36a74ffce141c55b6a71d1032b128f8a5858c0760e28400111662b5f72bf7dff0a6c98f532c

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/monitor.rb

@@ -1,4 +1,7 @@
-require "sidekiq/datadog/monitor/version"
+require 'sidekiq/api'
+require 'sidekiq-scheduler'
+require "sidekiq/datadog/monitor/data"
+require 'sidekiq/datadog/monitor/metrics_worker'
 
 module Sidekiq
   module Datadog

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

@@ -1,5 +1,3 @@
-require 'datadog/statsd'
-require 'sidekiq/datadog/monitor/metrics_worker'
 module Sidekiq
   module Datadog
     module Monitor
@@ -8,16 +6,26 @@ 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 * * * *"
 
-            start
+          Sidekiq.configure_server do |config|
+            SidekiqScheduler::Scheduler.dynamic = true
+
+            config.on(:startup) do
+              start
+            end
+          end
+
+          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.1"
+      VERSION = "0.1.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-datadog-monitor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - aleksa_castle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: sidekiq-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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