sidekiq-cloudwatchmetrics 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d12e8127fc1e085dfafd8812c3fca0ca8f60d84a18d0c1075df44f3d73dfa7e
+  data.tar.gz: d122fa6c24b657283c383e00a64be1d6d61ec1f22f6eabb1eb42d14b590992b9
+SHA512:
+  metadata.gz: 86028f3e083b24983f2bf59a850e996c76bd6a0f09c200bcecb386ab914dd5fc48c70ba1fb2ac44edee0db2c22b190eeac79f46f6b609195a067ee7665841218
+  data.tar.gz: 9a0119a1004c93d68837980ed58103fe293026e89e37ef1d3d39312bdccf038152c73812f0189c1fbb82a713514804ab7e711374086bc2082c7ac6fa96d5bc0f

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+SSf�`Q�ҹ4����Uz<)��M�B쭴��mˬf�*�S�$/
+��@���4�[�:k����>�,T�n�L�NJ)%ф�t�������a�������C��ҙ\`�x�*�G���uV+�)XdH�ν��+�G�*ܖ����v5A���3׼+�a¤>,���N���]��,O�R��r��c�^�kVz	���:ri�꟰Y9H�?�8"z�%�]S �-f%�tJ����\c�e�E[�G��R

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,52 @@
+# Sidekiq CloudWatch Metrics
+
+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!
+
+## 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/cloudwatchmetrics"
+
+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
+
+## 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/sj26/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/cloudwatchmetrics.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require "sidekiq/api"
+require "sidekiq/util"
+
+require "aws-sdk-cloudwatch"
+
+module Sidekiq::CloudWatchMetrics
+  def self.enable!(**kwargs)
+    Sidekiq.configure_server do |config|
+      publisher = Publisher.new(**kwargs)
+
+      if Sidekiq.options[:lifecycle_events].has_key?(:leader)
+        # Only publish metrics on the leader if we have a leader (sidekiq-ent)
+        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
+    include Sidekiq::Util
+
+    INTERVAL = 60 # seconds
+
+    def initialize(client: Aws::CloudWatch::Client.new)
+      @client = client
+    end
+
+    def start
+      logger.info { "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.info { "Publishing Sidekiq CloudWatch Metrics" }
+        publish
+
+        now = Time.now.to_f
+        tick = [tick + INTERVAL, now].max
+        sleep(tick - now) if tick > now
+      end
+
+      logger.info { "Stopped Sidekiq CloudWatch Metrics Publisher" }
+    end
+
+    def publish
+      now = Time.now
+      stats = Sidekiq::Stats.new
+      processes = Sidekiq::ProcessSet.new.to_enum(:each).to_a
+      utilization = calculate_utilization(processes)
+      capacity = calculate_capacity(processes)
+      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: "Capacity",
+          timestamp: now,
+          value: capacity,
+          unit: "Count",
+        },
+        {
+          metric_name: "Utilization",
+          timestamp: now,
+          value: utilization * 100.0,
+          unit: "Percent",
+        },
+        {
+          metric_name: "DefaultQueueLatency",
+          timestamp: now,
+          value: stats.default_queue_latency,
+          unit: "Seconds",
+        },
+      ]
+
+      queues.map 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
+
+      # We can only put 20 metrics at a time
+      metrics.each_slice(20) do |some_metrics|
+        @client.put_metric_data(
+          namespace: "Sidekiq",
+          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)
+    private def calculate_utilization(processes)
+      processes.map do |process|
+        process["busy"] / process["concurrency"].to_f
+      end.sum / processes.size.to_f
+    end
+
+    def quiet
+      logger.info { "Quieting Sidekiq CloudWatch Metrics Publisher" }
+      @stop = true
+    end
+
+    def stop
+      logger.info { "Stopping Sidekiq CloudWatch Metrics Publisher" }
+      @stop = true
+      @thread.wakeup
+      @thread.join
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-cloudwatchmetrics
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Samuel Cochran
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDKDCCAhCgAwIBAgIBBjANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
+  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
+  ODA4MTYwNTE4NDBaFw0xOTA4MTYwNTE4NDBaMDoxDTALBgNVBAMMBHNqMjYxFDAS
+  BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
+  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
+  xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
+  1xzcNRvFsn0aQoQ00k+sj+G83j3T5OOV5OZIlu8xAChMkQmiPd1NXc6uFv+Iacz7
+  kj+CMsI9YUFdNoU09QY0b+u+Rb6wDYdpyvN60YC30h0h1MeYbvYZJx/iZK4XY5zu
+  4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
+  KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
+  NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
+  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAEwUQFizoyvm/1/iX8i/+oK6hr5m
+  wd7ZEzIV32JRyaqkPFeWjBylRXZyoXsE2u1H9ofIw8b/5/M+uMIfR8jlJSuulGB7
+  rs3ixWpkwRW8Knz2A5zufM3uPypwDYbEUbTdhzqY9hCzCz4moHu2E5f5bz7zrp+g
+  kpFjMoo851LRGr5vEQMZ/U+Paq8ROLzAiOa72mNxIFzvnGcSDyBVixdewi7HoZWD
+  ccrr0sGoLnfK6DappOwH1I5uPvQohOATNmmU0MSSWOeiggLlEWmUYE7CvzoMc8R6
+  DlumKi5y9wE+XnxtyLbe6GlT3AkVGnhwPdwq2QBFLEWkTVogdCYomBCKfjY=
+  -----END CERTIFICATE-----
+date: 2018-08-16 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+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: sj26@sj26.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sidekiq/cloudwatchmetrics.rb
+homepage: https://github.com/sj26/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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Publish Sidekiq metrics to AWS CloudWatch
+test_files: []

metadata.gz.sig

@@ -0,0 +1,2 @@
+
+ɴXBLX(D�B%ș��œٯ<0�v���xj[�@ʯo�J�W�醾~xn3"����=x��,�蔼�LF�>�b`�X��C�hH&