bookingsync-sidekiq-pro-extended-metrics-collector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9ec1665a5ac90f26de396a497dda1e89c7165216018d6b3116cc3db7fb48f84
+  data.tar.gz: 0cdb38bf27500a342a1c601211326c03f687e209fdd073c39ded4e3e6384776c
+SHA512:
+  metadata.gz: b22df3ca9c0ccc46e73e3e7c680d77fb820bca84c81a081ba5941f9b946902a84583b28ec968afa6957bd27ccb7364bb67070f84f264ac28fca6674910d86024
+  data.tar.gz: 1c29bbd755ae8a678f74057c1d2dcc40c36deb32174611164cc2248c55950bb4d239477918c4e3128b2d7cce8cde5194a4f0a0b60b62e7ddfc108078477833c7

data/.circleci/config.yml

@@ -0,0 +1,39 @@
+
+version: 2
+jobs:
+  build:
+    working_directory: ~/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector
+    parallelism: 1
+    docker:
+      - image: circleci/ruby:2.6.5-node
+      - image: redis
+    steps:
+      - checkout
+      - run: mkdir /tmp/circleci-test-results
+      - restore_cache:
+          keys:
+            - v1-gemfile-lock-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: Install bundler
+          command: gem install bundler
+      - run:
+          name: Installing dependencies
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs 4 --retry 3
+      - save_cache:
+          key: v1-gemfile-lock-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+            - ~/.bundle
+      - run:
+          name: Installing dockerize
+          command: wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz && sudo tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+          environment:
+            DOCKERIZE_VERSION: v0.6.1
+      - run:
+          name: Running specs
+          command: |
+            bundle exec rake
+          environment:
+            REDIS_URL: redis://localhost:6379/1
+      - store_test_results:
+          path: /tmp/circleci-test-results

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0]
+
+- Release publicly

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bookingsync-sidekiq-pro-extended-metrics-collector.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    bookingsync-sidekiq-pro-extended-metrics-collector (0.1.0)
+      dogstatsd-ruby (~> 4)
+      sidekiq (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.5)
+    diff-lcs (1.3)
+    dogstatsd-ruby (4.6.0)
+    rack (3.0.4.1)
+    rack-protection (3.0.5)
+      rack
+    rake (13.0.1)
+    redis (4.6.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sidekiq (6.0.4)
+      connection_pool (>= 2.2.2)
+      rack (>= 2.0.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bookingsync-sidekiq-pro-extended-metrics-collector!
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Karol Galanciak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# BookingsyncSidekiqProExtendedMetricsCollector
+
+A gem for collecting extra Sidekiq metrics and aggregating them in Datadog.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bookingsync-sidekiq-pro-extended-metrics-collector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bookingsync-sidekiq-pro-extended-metrics-collector
+
+## Usage
+
+### Configuration
+
+Add this to the initializer:
+
+``` rb
+Rails.application.config.to_prepare do
+  BookingsyncSidekiqProExtendedMetricsCollector.configure do |config|
+    config.datadog_host = ENV.fetch("DATADOG_HOST")
+    config.datadog_port = ENV.fetch("DATADOG_PORT")
+    config.datadog_namespace = ENV.fetch("DATADOG_NAMESPACE")
+  end
+end
+```
+
+### Queues' latencies
+
+Add these Sidekiq middlewares in the Sidekiq config:
+
+``` rb
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    if Rails.env.production?
+      chain.add BookingsyncSidekiqProExtendedMetricsCollector::SidekiqQueueLatencyMiddleware
+      chain.add BookingsyncSidekiqProExtendedMetricsCollector::SidekiqScheduledMiddleware
+      chain.add BookingsyncSidekiqProExtendedMetricsCollector::SidekiqRetryMiddleware
+    end
+  end
+end
+```
+
+That will be enough to start collecting metrics for queues' latencies, retry count and scheduled count.
+
+You can perform a search based on a given namespace like `bookingsync.production`, `queue_latency`, `retry_count`, `scheduled_count` and `sidekiq` keywords.
+
+For latency, the metrics are aggregated "globally" (where queue name is used a tag) and separately by each queue.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bookingsync/sidekiq/pro/extended/metrics/collector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bookingsync-sidekiq-pro-extended-metrics-collector.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bookingsync_sidekiq_pro_extended_metrics_collector/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bookingsync-sidekiq-pro-extended-metrics-collector"
+  spec.version       = BookingsyncSidekiqProExtendedMetricsCollector::VERSION
+  spec.authors       = ["Karol Galanciak"]
+  spec.email         = ["karol@bookingsync.com"]
+
+  spec.summary       = %q{Gem for collecting extended metrics for Sidekiq Pro.}
+  spec.description   = %q{Gem for collecting extended metrics for Sidekiq Pro.}
+  spec.homepage      = "https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector"
+  spec.metadata["changelog_uri"] = "https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "dogstatsd-ruby", "~> 4"
+  spec.add_dependency "sidekiq", ">= 5"
+end

data/lib/bookingsync/sidekiq/pro/extended/metrics/collector.rb

@@ -0,0 +1 @@
+require_relative "../../../../../../lib/bookingsync_sidekiq_pro_extended_metrics_collector"

data/lib/bookingsync_sidekiq_pro_extended_metrics_collector/collector.rb

@@ -0,0 +1,73 @@
+require "sidekiq/api"
+
+class BookingsyncSidekiqProExtendedMetricsCollector
+  class Collector
+    METRIC_NAME_PREFIX = "sidekiq".freeze
+    METRIC_NAME_SEPARATOR = ".".freeze
+    LATENCY_METRIC_NAME_SUFFIX = "queue_latency".freeze
+    RETRY_IDENTIFIER = "retry_count".freeze
+    SCHEDULED_IDENTIFIER = "scheduled_count".freeze
+    private_constant :METRIC_NAME_PREFIX,  :METRIC_NAME_SEPARATOR, :LATENCY_METRIC_NAME_SUFFIX,
+      :RETRY_IDENTIFIER, :SCHEDULED_IDENTIFIER
+
+    attr_reader :datadog_client, :configuration
+    private     :datadog_client, :configuration
+
+    def initialize(datadog_client, configuration)
+      @datadog_client = datadog_client
+      @configuration = configuration
+    end
+
+    def collect_queue_latency(queue)
+      queue = queue.to_s
+      latency = Sidekiq::Queue.new(queue).latency
+      metric_name = build_metric_name_for_queue_latency(queue)
+
+      datadog_client.gauge(global_metric_name_for_latency, latency, tags: ["queue:#{queue}"])
+      datadog_client.gauge(metric_name, latency)
+    end
+
+    def collect_retry_count
+      size = Sidekiq::RetrySet.new.size
+      datadog_client.gauge(build_metric_name_for_retry, size)
+    end
+
+    def collect_scheduled_count
+      size = Sidekiq::ScheduledSet.new.size
+      datadog_client.gauge(build_metric_name_for_scheduled, size)
+    end
+
+    private
+
+    def global_metric_name_for_latency
+      [
+        METRIC_NAME_PREFIX,
+        configuration.datadog_namespace,
+        LATENCY_METRIC_NAME_SUFFIX
+      ].join(METRIC_NAME_SEPARATOR)
+    end
+
+    def build_metric_name_for_queue_latency(queue)
+      [
+        global_metric_name_for_latency,
+        queue
+      ].join(METRIC_NAME_SEPARATOR)
+    end
+
+    def build_metric_name_for_retry
+      [
+        METRIC_NAME_PREFIX,
+        configuration.datadog_namespace,
+        RETRY_IDENTIFIER
+      ].join(METRIC_NAME_SEPARATOR)
+    end
+
+    def build_metric_name_for_scheduled
+      [
+        METRIC_NAME_PREFIX,
+        configuration.datadog_namespace,
+        SCHEDULED_IDENTIFIER
+      ].join(METRIC_NAME_SEPARATOR)
+    end
+  end
+end

data/lib/bookingsync_sidekiq_pro_extended_metrics_collector/configuration.rb

@@ -0,0 +1,5 @@
+class BookingsyncSidekiqProExtendedMetricsCollector
+  class Configuration
+    attr_accessor :datadog_host, :datadog_port, :datadog_namespace
+  end
+end

data/lib/bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_queue_latency_middleware.rb

@@ -0,0 +1,8 @@
+class BookingsyncSidekiqProExtendedMetricsCollector
+  class SidekiqQueueLatencyMiddleware
+    def call(_worker, _job, queue)
+      yield
+      BookingsyncSidekiqProExtendedMetricsCollector.collect_queue_latency(queue)
+    end
+  end
+end

data/lib/bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_retry_middleware.rb

@@ -0,0 +1,8 @@
+class BookingsyncSidekiqProExtendedMetricsCollector
+  class SidekiqRetryMiddleware
+    def call(_worker, _job, _queue)
+      yield
+      BookingsyncSidekiqProExtendedMetricsCollector.collect_retry_count
+    end
+  end
+end

data/lib/bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_scheduled_middleware.rb

@@ -0,0 +1,8 @@
+class BookingsyncSidekiqProExtendedMetricsCollector
+  class SidekiqScheduledMiddleware
+    def call(_worker, _job, _queue)
+      yield
+      BookingsyncSidekiqProExtendedMetricsCollector.collect_scheduled_count
+    end
+  end
+end

data/lib/bookingsync_sidekiq_pro_extended_metrics_collector/version.rb

@@ -0,0 +1,3 @@
+class BookingsyncSidekiqProExtendedMetricsCollector
+  VERSION = "0.1.0".freeze
+end

data/lib/bookingsync_sidekiq_pro_extended_metrics_collector.rb

@@ -0,0 +1,38 @@
+require "bookingsync_sidekiq_pro_extended_metrics_collector/configuration"
+require "bookingsync_sidekiq_pro_extended_metrics_collector/collector"
+require "bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_queue_latency_middleware"
+require "bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_retry_middleware"
+require "bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_scheduled_middleware"
+require "bookingsync_sidekiq_pro_extended_metrics_collector/version"
+require "datadog/statsd"
+
+class BookingsyncSidekiqProExtendedMetricsCollector
+  def self.configuration
+    @configuration ||= BookingsyncSidekiqProExtendedMetricsCollector::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.datadog_stats_client
+    Datadog::Statsd.new(configuration.datadog_host, configuration.datadog_port, tags: ["host:disabled"])
+  end
+
+  def self.collect_queue_latency(queue)
+    collector.collect_queue_latency(queue)
+  end
+
+  def self.collect_retry_count
+    collector.collect_retry_count
+  end
+
+  def self.collect_scheduled_count
+    collector.collect_scheduled_count
+  end
+
+  def self.collector
+    BookingsyncSidekiqProExtendedMetricsCollector::Collector.new(datadog_stats_client, configuration)
+  end
+  private_class_method :collector
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: bookingsync-sidekiq-pro-extended-metrics-collector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Galanciak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Gem for collecting extended metrics for Sidekiq Pro.
+email:
+- karol@bookingsync.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bookingsync-sidekiq-pro-extended-metrics-collector.gemspec
+- lib/bookingsync/sidekiq/pro/extended/metrics/collector.rb
+- lib/bookingsync_sidekiq_pro_extended_metrics_collector.rb
+- lib/bookingsync_sidekiq_pro_extended_metrics_collector/collector.rb
+- lib/bookingsync_sidekiq_pro_extended_metrics_collector/configuration.rb
+- lib/bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_queue_latency_middleware.rb
+- lib/bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_retry_middleware.rb
+- lib/bookingsync_sidekiq_pro_extended_metrics_collector/sidekiq_scheduled_middleware.rb
+- lib/bookingsync_sidekiq_pro_extended_metrics_collector/version.rb
+homepage: https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector
+  source_code_uri: https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector
+  changelog_uri: https://github.com/BookingSync/bookingsync-sidekiq-pro-extended-metrics-collector/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Gem for collecting extended metrics for Sidekiq Pro.
+test_files: []