sidekiq-cloudwatchmetrics 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3700f67618740e59e5d6b238c8ef38df7fff355b55720cbd8a3e3d8ddc4fe0
-  data.tar.gz: cc370653cf4e03aa2eef772b60063567409f10eeeedd90a4e24bfb67a445f951
+  metadata.gz: 9cc57f884a22e51c089dc46fb2d5717cab59b3e35aa5314d0275eac536013519
+  data.tar.gz: 8926d75fb32f92a4676398cc89b12c595988c08024306a0ad085c707f92e250d
 SHA512:
-  metadata.gz: f6481c3015ff0d156677856c0851f34a35fad57718b9d493d096d38017b902ef12429f18a5e557fd6b1f1b5a0e32df6a7b805dea042a6620528aea76b42c72ec
-  data.tar.gz: f9b6755f2c04741b1704825d6a3a0b9950ea609da9784a77a622a9b99562857c0c81d9cada121ce8c05b148e0096c47e26be7036a05c5c864592b6749e80078f
+  metadata.gz: 994bb3093eb6e27f135acf17e93c2563b604e72335aef127dbea441329a9afe99652b49b19481ce14f77eab12b7a50045b55f64dad5935940435be981eb899ca
+  data.tar.gz: a71077426c955c8c0cf64743c2c3be9668c4a76ef6de4517c9b5e6f99e8bf8d109367e1f59bd586137e21e9f108b46fbc2568cffc73ebaa64cfbe8b9b74f2e9a

data/README.md

@@ -1,7 +1,5 @@
 # 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.
 
@@ -43,9 +41,14 @@ Sidekiq::CloudWatchMetrics.enable!(client: Aws::CloudWatch::Client.new)
 The default namespace for metrics is "Sidekiq". You can configure this with the `namespace` option:
 
 ```ruby
-Sidekiq::CloudWatchMetrics.enable!(client: Aws::CloudWatch::Client.new, namespace: "Sidekiq-Staging")
+Sidekiq::CloudWatchMetrics.enable!(namespace: "Sidekiq-Staging")
 ```
 
+Metrics are published every 60 seconds by default. You can adjust this with the `interval` option:
+
+```ruby
+Sidekiq::CloudWatchMetrics.enable!(interval: 30)
+```
 
 ## Development
 

data/lib/sidekiq/cloudwatchmetrics.rb

@@ -8,7 +8,7 @@ require "aws-sdk-cloudwatch"
 module Sidekiq::CloudWatchMetrics
   def self.enable!(**kwargs)
     Sidekiq.configure_server do |config|
-      publisher = Publisher.new(**kwargs)
+      publisher = Publisher.new(config: config, **kwargs)
 
       # Sidekiq enterprise has a globally unique leader thread, making it
       # easier to publish the cluster-wide metrics from one place.
@@ -43,13 +43,24 @@ module Sidekiq::CloudWatchMetrics
       include Sidekiq::Component
     end
 
-    INTERVAL = 60 # seconds
+    DEFAULT_INTERVAL = 60 # seconds
 
-    def initialize(config: Sidekiq, client: Aws::CloudWatch::Client.new, namespace: "Sidekiq", process_metrics: true, additional_dimensions: {})
-      # Sidekiq 6.5+ requires @config, which defaults to the top-level
-      # `Sidekiq` module, but can be overridden when running multiple Sidekiqs.
+    private def default_config
+      # Sidekiq::Config was introduced in sidekiq 7 and has a default
+      if Sidekiq.respond_to?(:default_configuration)
+        Sidekiq.default_configuration
+      else
+        # in older versions, it's just the `Sidekiq` module
+        Sidekiq
+      end
+    end
+
+    def initialize(config: default_config, client: Aws::CloudWatch::Client.new, namespace: "Sidekiq", process_metrics: true, additional_dimensions: {}, interval: DEFAULT_INTERVAL)
+      # Required by Sidekiq::Component (in sidekiq 6.5+)
       @config = config
+
       @client = client
+      @interval = interval
       @namespace = namespace
       @process_metrics = process_metrics
       @additional_dimensions = additional_dimensions.map { |k, v| {name: k.to_s, value: v.to_s} }
@@ -69,15 +80,20 @@ module Sidekiq::CloudWatchMetrics
     def run
       logger.info { "Started Sidekiq CloudWatch Metrics Publisher" }
 
-      # Publish stats every INTERVAL seconds, sleeping as required between runs
+      # 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
+        begin
+          publish
+        rescue => e
+          logger.error("Error publishing Sidekiq CloudWatch Metrics: #{e}")
+          handle_exception(e)
+        end
 
         now = Time.now.to_f
-        tick = [tick + INTERVAL, now].max
+        tick = [tick + @interval, now].max
         sleep(tick - now) if tick > now
       end
 
@@ -169,12 +185,22 @@ module Sidekiq::CloudWatchMetrics
       end.each do |(tag, tag_processes)|
         next if tag.nil?
 
+        tag_dimensions = [{name: "Tag", value: tag}]
+
+        metrics << {
+          metric_name: "Capacity",
+          dimensions: tag_dimensions,
+          timestamp: now,
+          value: calculate_capacity(tag_processes),
+          unit: "Count",
+        }
+
         tag_utilization = calculate_utilization(tag_processes) * 100.0
 
         unless tag_utilization.nan?
           metrics << {
             metric_name: "Utilization",
-            dimensions: [{name: "Tag", value: tag}],
+            dimensions: tag_dimensions,
             timestamp: now,
             value: tag_utilization,
             unit: "Percent",
@@ -189,7 +215,7 @@ module Sidekiq::CloudWatchMetrics
           unless process_utilization.nan?
             process_dimensions = [{name: "Hostname", value: process["hostname"]}]
 
-            if process["tag"]
+            if process["tag"] && !process["tag"].to_s.empty?
               process_dimensions << {name: "Tag", value: process["tag"]}
             end
 
@@ -264,8 +290,10 @@ module Sidekiq::CloudWatchMetrics
     def stop
       logger.debug { "Stopping Sidekiq CloudWatch Metrics Publisher" }
       @stop = true
-      @thread.wakeup
-      @thread.join
+      if @thread
+        @thread.wakeup
+        @thread.join
+      end
     rescue ThreadError
       # Don't raise if thread is already dead.
       nil

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cloudwatchmetrics
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Samuel Cochran
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDKDCCAhCgAwIBAgIBAjANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
+  MIIDKDCCAhCgAwIBAgIBAzANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
   MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0y
-  MzA3MTIwODU1NTFaFw0yNDA3MTEwODU1NTFaMDoxDTALBgNVBAMMBHNqMjYxFDAS
+  NDA3MjIwNjA3MjdaFw0yNTA3MjIwNjA3MjdaMDoxDTALBgNVBAMMBHNqMjYxFDAS
   BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
   hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
   xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
@@ -21,14 +21,14 @@ cert_chain:
   4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
   KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
   NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAHplXTmXnsLZKl6th6Twlbpl3iBl
-  7aRpOrLc7g8WIEirjiWlYZXjhdG6XoiIQAQtV3XniQ6npRPw7Np8AhSR1LOlvbOs
-  hEdArvs/OZy9cN7fQNduZFK1dkbYCF4waBTycsQFvrzcJzRmjhS9BJd0rroetldo
-  nmPzAzlAl9rIOQC/c763FVfdbPQu+mxcj4JCfVElUzxK+4igyB6SFMckMPSZIJbi
-  cxvXzM34LVue8vISlf/2VKpawD3kQinfo1I53MP3Hv3EihDc4p14E4hdAILtHd5r
-  k6d9rkvRe0/YFTLB1hzK6scdAUcD91NOylY8s4cypQv/mk+OTbQ9+Xy7tyU=
+  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAKcQ+MfpXXDmqboG36O8mXhJZJ8+
+  zlUqM1QnoEG8XpH/29py4GzSgs6Sb+v/Z1SEArRDq0r1bKZuWiWxqEDnmSE94+pe
+  A0Ct6Pv/paEhQCoPkGQNa74cH4tzkVHIA7WSwRL8wOz5vo++YBKH5H36nNqtLV7s
+  kNJYsbeOL/w2icQ4b0w4KYgcs4bd6yrYdgcgsRd2sCYb2XFHjczYqw4iEwuUenNM
+  G8WXc9zUMVewWkEjS9s++xFNb/7f4dFNXCoE3pgHjzctt7gYcJVacprsg925LYHO
+  WsbnbEow7BPlYOZm3rDIsEYpWqxN0lR8BakO2ToJ5RAHXahFu4K4eJtAsLk=
   -----END CERTIFICATE-----
-date: 2023-07-29 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -39,7 +39,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatch
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +151,7 @@ homepage: https://github.com/sj26/sidekiq-cloudwatchmetrics
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +159,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Publish Sidekiq metrics to AWS CloudWatch
 test_files: []