strongmind-sidekiq-cloudwatchmetrics 2.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2534e200d85aa68afbeefe1bad73d763957238a4e4054836d5a87e8c2f6a785f
+  data.tar.gz: 18fc7cb9633a664c2b6fb461cfb98009ad84e5509516b46487b621d003d411c6
+SHA512:
+  metadata.gz: b3554341292c7f699cf5d29a388a4d855da613ddff1adad7d1fe540f97c3fa023e6730ff79ffd9ca335abb0f2b9c538c353da1692b61843fb7849963be243194
+  data.tar.gz: d57f5f73e990f75a05094865e11b5dc8cbda856262991e40d7c918535981a3500c25caea42ce346b71aa8822ae3c3e95971ea25986742ff89fee0ab68b42ccd2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Samuel Cochran
+
+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,62 @@
+# Sidekiq CloudWatch Metrics
+
+[![Build Status](https://travis-ci.org/sj26/sidekiq-cloudwatchmetrics.svg)](https://travis-ci.org/sj26/sidekiq-cloudwatchmetrics)
+
+Runs a thread inside your Sidekiq processes to report metrics to CloudWatch
+useful for autoscaling and keeping an eye on your queues.
+
+Optimised for Sidekiq Enterprise with leader election, but works everywhere!
+
+<img width="1055" alt="Screenshot of Sidekiq metrics in a CloudWatch dashboard" src="https://user-images.githubusercontent.com/14028/44190767-9fd66280-a16b-11e8-8b12-3d5e0641c15f.png">
+
+## Installation
+
+Add this gem to your application’s Gemfile near sidekiq and then run `bundle install`:
+
+```ruby
+gem "sidekiq"
+gem "sidekiq-cloudwatchmetrics"
+```
+
+## Usage
+
+Add near your Sidekiq configuration, like in `config/initializers/sidekiq.rb` in Rails:
+
+```ruby
+require "sidekiq"
+require "sidekiq/cloud_watch_metrics"
+
+Sidekiq::CloudWatchMetrics.enable!
+```
+
+By default this assumes you're running on an EC2 instance with an instance role
+that can publish CloudWatch metrics, or that you've supplied AWS credentials
+through environment variables that aws-sdk expects. You can also explicitly
+supply an [aws-sdk CloudWatch Client instance][cwclient]:
+
+```ruby
+Sidekiq::CloudWatchMetrics.enable!(client: Aws::CloudWatch::Client.new)
+```
+
+  [cwclient]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudWatch/Client.html
+
+Add 'NAMESPACE' to your environment variables (this var is already available in StrongMind Rails deployments) or explicitly supply a namespace:
+```ruby
+Sidekiq::CloudWatchMetrics.enable!(client: Aws::CloudWatch::Client.new, namespace: ENV.fetch('NAMESPACE'), metrics_to_publish: %w[enqueued_jobs busy_workers], interval: 60)
+```
+
+
+## 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/StrongMind/strongmind-sidekiq-cloudwatchmetrics.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/sidekiq/cloud_watch_metrics.rb

@@ -0,0 +1,274 @@
+
+
+require "sidekiq"
+require "sidekiq/api"
+require "aws-sdk-cloudwatch"
+
+module Sidekiq::CloudWatchMetrics
+  def self.enable!(**kwargs)
+    Sidekiq.configure_server do |config|
+      publisher = Publisher.new(**kwargs)
+
+      # Sidekiq enterprise has a globally unique leader thread, making it
+      # easier to publish the cluster-wide metrics from one place.
+      if defined?(Sidekiq::Enterprise)
+        config.on(:leader) do
+          publisher.start
+        end
+      else
+        # Otherwise pubishing from every node doesn't hurt, it's just wasteful
+        config.on(:startup) do
+          publisher.start
+        end
+      end
+
+      config.on(:quiet) do
+        publisher.quiet if publisher.running?
+      end
+
+      config.on(:shutdown) do
+        publisher.stop if publisher.running?
+      end
+    end
+  end
+
+  class Publisher
+    begin
+      require "sidekiq/util"
+      include Sidekiq::Util
+    rescue LoadError
+      # Sidekiq 6.5 refactored to use Sidekiq::Component
+      require "sidekiq/component"
+      include Sidekiq::Component
+    end
+
+    def initialize(config: Sidekiq, client: Aws::CloudWatch::Client.new, namespace: "Sidekiq", process_metrics: true, additional_dimensions: {}, metrics_to_publish: [], interval: 60)
+      # Sidekiq 6.5+ requires @config, which defaults to the top-level
+      # `Sidekiq` module, but can be overridden when running multiple Sidekiqs.
+      @config = config
+      @client = client
+      @namespace = namespace
+      @process_metrics = process_metrics
+      @additional_dimensions = additional_dimensions.map { |k, v| {name: k.to_s, value: v.to_s} }
+      @metrics_to_publish = metrics_to_publish
+      @interval = interval
+    end
+
+    def start
+      logger.debug { "Starting Sidekiq CloudWatch Metrics Publisher" }
+
+      @done = false
+      @thread = safe_thread("cloudwatch metrics publisher", &method(:run))
+    end
+
+    def running?
+      !@thread.nil? && @thread.alive?
+    end
+
+    def run
+      logger.info { "Started Sidekiq CloudWatch Metrics Publisher" }
+
+      # Publish stats every INTERVAL seconds, sleeping as required between runs
+      now = Time.now.to_f
+      tick = now
+      until @stop
+        logger.debug { "Publishing Sidekiq CloudWatch Metrics" }
+        publish
+
+        now = Time.now.to_f
+        tick = [tick + @interval, now].max
+        sleep(tick - now) if tick > now
+      end
+
+      logger.debug { "Stopped Sidekiq CloudWatch Metrics Publisher" }
+    end
+
+    def publish
+      now = Time.now
+      stats = Sidekiq::Stats.new
+      processes = Sidekiq::ProcessSet.new.to_enum(:each).to_a
+      queues = stats.queues
+
+      metrics = [
+        {
+          metric_name: "ProcessedJobs",
+          timestamp: now,
+          value: stats.processed,
+          unit: "Count",
+        },
+        {
+          metric_name: "FailedJobs",
+          timestamp: now,
+          value: stats.failed,
+          unit: "Count",
+        },
+        {
+          metric_name: "EnqueuedJobs",
+          timestamp: now,
+          value: stats.enqueued,
+          unit: "Count",
+        },
+        {
+          metric_name: "ScheduledJobs",
+          timestamp: now,
+          value: stats.scheduled_size,
+          unit: "Count",
+        },
+        {
+          metric_name: "RetryJobs",
+          timestamp: now,
+          value: stats.retry_size,
+          unit: "Count",
+        },
+        {
+          metric_name: "DeadJobs",
+          timestamp: now,
+          value: stats.dead_size,
+          unit: "Count",
+        },
+        {
+          metric_name: "Workers",
+          timestamp: now,
+          value: stats.workers_size,
+          unit: "Count",
+        },
+        {
+          metric_name: "Processes",
+          timestamp: now,
+          value: stats.processes_size,
+          unit: "Count",
+        },
+        {
+          metric_name: "DefaultQueueLatency",
+          timestamp: now,
+          value: stats.default_queue_latency,
+          unit: "Seconds",
+        },
+        {
+          metric_name: "Capacity",
+          timestamp: now,
+          value: calculate_capacity(processes),
+          unit: "Count",
+        },
+      ]
+
+      utilization = calculate_utilization(processes) * 100.0
+
+      unless utilization.nan?
+        metrics << {
+          metric_name: "Utilization",
+          timestamp: now,
+          value: utilization,
+          unit: "Percent",
+        }
+      end
+
+      processes.group_by do |process|
+        process["tag"]
+      end.each do |(tag, tag_processes)|
+        next if tag.nil?
+
+        tag_utilization = calculate_utilization(tag_processes) * 100.0
+
+        unless tag_utilization.nan?
+          metrics << {
+            metric_name: "Utilization",
+            dimensions: [{name: "Tag", value: tag}],
+            timestamp: now,
+            value: tag_utilization,
+            unit: "Percent",
+          }
+        end
+      end
+
+      if @process_metrics
+        processes.each do |process|
+          process_utilization = process["busy"] / process["concurrency"].to_f * 100.0
+
+          unless process_utilization.nan?
+            process_dimensions = [{name: "Hostname", value: process["hostname"]}]
+
+            if process["tag"]
+              process_dimensions << {name: "Tag", value: process["tag"]}
+            end
+
+            metrics << {
+              metric_name: "Utilization",
+              dimensions: process_dimensions,
+              timestamp: now,
+              value: process_utilization,
+              unit: "Percent",
+            }
+          end
+        end
+      end
+
+      queues.each do |(queue_name, queue_size)|
+        metrics << {
+          metric_name: "QueueSize",
+          dimensions: [{name: "QueueName", value: queue_name}],
+          timestamp: now,
+          value: queue_size,
+          unit: "Count",
+        }
+
+        queue_latency = Sidekiq::Queue.new(queue_name).latency
+
+        metrics << {
+          metric_name: "QueueLatency",
+          dimensions: [{name: "QueueName", value: queue_name}],
+          timestamp: now,
+          value: queue_latency,
+          unit: "Seconds",
+        }
+      end
+
+      unless @additional_dimensions.empty?
+        metrics = metrics.each do |metric|
+          metric[:dimensions] = (metric[:dimensions] || []) + @additional_dimensions
+        end
+      end
+
+      # We can only put 20 metrics at a time
+      metrics.select { |metric| @metrics_to_publish.include?(metric[:metric_name]) }.each_slice(20) do |some_metrics|
+        @client.put_metric_data(
+          namespace: @namespace,
+          metric_data: some_metrics,
+          )
+      end
+    end
+
+    # Returns the total number of workers across all processes
+    private def calculate_capacity(processes)
+      processes.map do |process|
+        process["concurrency"]
+      end.sum
+    end
+
+    # Returns busy / concurrency averaged across processes (for scaling)
+    # Avoid considering processes not yet running any threads
+    private def calculate_utilization(processes)
+      process_utilizations = processes.map do |process|
+        process["busy"] / process["concurrency"].to_f
+      end.reject(&:nan?)
+
+      process_utilizations.sum / process_utilizations.size.to_f
+    end
+
+    def quiet
+      logger.debug { "Quieting Sidekiq CloudWatch Metrics Publisher" }
+      @stop = true
+    end
+
+    def stop
+      logger.debug { "Stopping Sidekiq CloudWatch Metrics Publisher" }
+      @stop = true
+      @thread.wakeup
+      @thread.join
+    rescue ThreadError
+      # Don't raise if thread is already dead.
+      nil
+    end
+  end
+end
+

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: strongmind-sidekiq-cloudwatchmetrics
+version: !ruby/object:Gem::Version
+  version: 2.6.1
+platform: ruby
+authors:
+- StrongMind Devops
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudwatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |
+  Runs a thread inside your Sidekiq processes to report metrics to CloudWatch
+  useful for autoscaling and keeping an eye on your queues.
+
+  Optimised for Sidekiq Enterprise with leader election, but works everywhere!
+email: devops@strongmind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sidekiq/cloud_watch_metrics.rb
+homepage: https://github.com/StrongMind/strongmind-sidekiq-cloudwatchmetrics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Publish Sidekiq metrics to AWS CloudWatch
+test_files: []