sidekiq-datadog-monitor 0.0.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d84d08e0320ca9b9e399bb8eff1efd74af038a534fe9936c8cfcfb3e169dc40
-  data.tar.gz: f7cedc8a2816f04c886a2a0c8f841d7cd2819bbb916cd59737208ceff35043c1
+  metadata.gz: 1e6838bb59d76c94b8ca2e3ea015f7ab7af6081516f01e83e6a2d0a341d88b01
+  data.tar.gz: 5f209f188034fd94da47f3505eb758f264b5eb9149bdb9ffcb4ee172ad38f20c
 SHA512:
-  metadata.gz: 6f1384e84c750d8510cc1102c9f4286276c8a6fdefa050e2576ce0baebde5da806859c8d4e34e316921260814fd4a251d8f20bd652073bb5bdee9a0af6fdbbda
-  data.tar.gz: 489cf5542ec468a81eb8e0c218b5f34babb3a23699e444e1702cf65cd105e8326f4667d01ab5765a599564600dba8c9e4a6564dd0a4a838766f9ece447b9e707
+  metadata.gz: c89749c8150eecc3cde7a9c6d121c902a7dd4b67f542ca664e5b7f4f95a70b90da1ad802c3e46c461fff8010376aac6565dc24f0be45afaf622fb9845e5f54be
+  data.tar.gz: eef31d5da46a77f797be7ca049d4bf8656b5f888ab648ec6608c8f526a84e9282cf8f938d750dc0c6336e2b40e92cdad2ef0e9c908b2c12a2f936fa0d705bc5a

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,32 @@ 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,
+  queue: 'queue name',
+  tags: ['env:production', 'product:product_name'], # optional
+  cron: "*/30 * * * *" # default: "*/1 * * * *",
+  batch: false # optional, default: false
+)
+```
+`agent_host` and `agent_port` instantiate DogStatsD client
+
+`queue` setting for background job that will gather and send Sidekiq metrics
+
+`tags` tags for datadog metrics
+
+`cron` - schedule settings for background job that will gather and send Sidekiq metrics
+
+`batch` turns on sending DD metrics in batches. Make sure you don't have too many queues before enabling this option. The message with all tags must fit into [8KB of default DataDog buffer](https://docs.datadoghq.com/developers/dogstatsd/high_throughput/#enable-buffering-on-your-client) size.
+
 
 ## 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,28 +1,34 @@
-require 'datadog/statsd'
-require 'sidekiq/datadog/monitor/metrics_worker'
 module Sidekiq
   module Datadog
     module Monitor
       class Data
         class << self
-          attr_reader :agent_port, :agent_host, :tag, :env, :queue, :cron
+          attr_reader :agent_port, :agent_host, :tags, :env, :queue, :cron, :batch
 
           def initialize!(options)
-            @agent_port = options[:agent_port]
-            @agent_host = options[:agent_host]
-            @tag = options[:tag] || ''
-            @env = options[:env] || ''
-            @queue = options[:queue] || ''
-            @cron = options[:cron] || "*/1 * * * *"
+            @agent_port, @agent_host, @queue = options.fetch_values(:agent_port, :agent_host, :queue)
+            @tags = options[:tags] || []
+            @cron = options[:cron] || '*/1 * * * *'
+            @batch = options[:batch] || false
 
-            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, e.message
           end
 
+          private
+
           def start
-            Sidekiq.set_schedule('send_metrics', 
-              { "cron"=> cron, 'class' => 'Sidekiq::Datadog::Monitor::MetricsWorker', 'queue' => queue })
+            Sidekiq.set_schedule('send_metrics',
+                                 { 'cron' => cron, 'class' => 'Sidekiq::Datadog::Monitor::MetricsWorker', 'queue' => queue })
           end
-        end 
+        end
       end
     end
   end

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

@@ -1,35 +1,41 @@
+require 'sidekiq/datadog/monitor/data'
 require 'datadog/statsd'
-require 'sidekiq'
 
 module Sidekiq
   module Datadog
     module Monitor
       class MetricsWorker
         include Sidekiq::Worker
-        
+
+        sidekiq_options retry: false
+
         def perform
-          Sidekiq::Stats.new.queues.each_pair do |queue_name, size|
-            post_queue_size(queue_name, size)
+          statsd = ::Datadog::Statsd.new(Data.agent_host, Data.agent_port)
 
-            post_queue_latency(queue_name)
-          end
+          return send_metrics(statsd) unless Data.batch
+
+          statsd.batch { |batch_statsd| send_metrics(batch_statsd) }
         end
 
         private
 
-        def statsd
-          @statsd = ::Datadog::Statsd.new(Data.agent_host, Data.agent_port)
+        def send_metrics(statsd)
+          Sidekiq::Stats.new.queues.each_pair do |queue_name, size|
+            post_queue_size(statsd, queue_name, size)
+
+            post_queue_latency(statsd, queue_name)
+          end
         end
 
-        def post_queue_size(queue_name, size)
+        def post_queue_size(statsd, queue_name, size)
           statsd.gauge('sidekiq.queue.size', size,
-                      tags: ["queue_name:#{queue_name}", "environment:#{Data.env}", Data.tag])
+                       tags: ["queue_name:#{queue_name}"].concat(Data.tags))
         end
 
-        def post_queue_latency(queue_name)
+        def post_queue_latency(statsd, 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}"].concat(Data.tags))
         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.2.1'.freeze
     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.2.1
 platform: ruby
 authors:
 - aleksa_castle
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,48 @@ 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: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.1
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +108,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
@@ -80,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.8.1
-description: 
+description:
 email:
 - oleksandra.k@matic.com
 executables: []
@@ -100,7 +156,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A gem to gather and send sidekiq jobs metrics to datadog
 test_files: []