sidekiq-ecs-scaler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e788a43a1d4013b88babd60929d35dc465dca7dbe73daa633566929be57f501
-  data.tar.gz: 9a6c856115de94d05edb69662d2de03ea0ae536d40d3b36a1f74f1f2f2c9239b
+  metadata.gz: e4d70a0b678343e315f0d8b64c0d8bd5c957277cd0cd6e201d54a2cf2b828240
+  data.tar.gz: d61d4ed70aad984f619846dfed858ec745db318dab39417749ec0a0c821489dc
 SHA512:
-  metadata.gz: 137a41c9d0c6fbc53bb16652b7d9c711347618e2c3ce37130ce1087ec774c09956c0746e345d6bbd7bca5395aaa36b02c1f1a6a08e9a4c65a3eb51dd347a0280
-  data.tar.gz: bdab45f712315863eb32d08e3aba9edb35db1d9d50f2966206baf6948ea1ce97cc9a6672402ffd09cd66ab27d5a222a02fa3fb8d902d9d7e9287bfb4045824e1
+  metadata.gz: 115d9a719b314f47901711eeefb3ab3015525a5d163a698f868ef9e358ad06a91e9e19b9686102193c8bd9c69d377210929581f90de601aa4d30ff795700a78d
+  data.tar.gz: 99242f8721633c865b5e6defc1750f6346a5a411c958b97094a3dd19a91b3a0e950856818c571a8231e03843e1383969aaab81e8084a2ca79175cac4937f79b0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.2.0] - 2021-12-01
+
+- Add configuration items
+  - `enabled` is possible to enable / disable the scale.
+  - `logger` is possible to changing the logger that outputs the required number of changes.
+- UPDATE README.md
+
 ## [0.1.0] - 2021-11-29
 
 - initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq-ecs-scaler (0.1.0)
+    sidekiq-ecs-scaler (0.2.0)
       aws-sdk-ecs (> 1, < 2)
       sidekiq (> 5, < 7)
 
@@ -16,7 +16,7 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.535.0)
+    aws-partitions (1.536.0)
     aws-sdk-core (3.123.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)

data/README.md

@@ -22,6 +22,12 @@ And then execute:
 
 ```ruby
 SidekiqEcsScaler.configure do |config|
+  # enable / disable of scaler, default is true
+  config.enabled = true
+
+  # logger, default is Sidekiq.logger
+  config.logger = Sidekiq.logger
+
   # queue to monitor latency, default is "default"
   config.queue_name = "default"
 
@@ -34,7 +40,7 @@ SidekiqEcsScaler.configure do |config|
   # maximum latency(seconds), default is 3600
   config.max_latency = 3600
 
-  # custom ECS Client
+  # custom ECS Client, default is Aws::ECS::Client.new
   config.ecs_client = Aws::ECS::Client.new
 
   # Set worker options for scaling
@@ -57,6 +63,14 @@ When using [sidekiq-scheduler](https://github.com/moove-it/sidekiq-scheduler), s
     queue: scheduler
 ```
 
+### About AWS IAM Policy
+
+The task role of ECS task that runs Sidekiq workers requires the following permissions:
+
+- `ecs:DescribeTasks`
+- `ecs:DescribeServices`
+- `ecs:UpdateService`
+
 ## 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.

data/Steepfile

@@ -6,4 +6,6 @@ target :lib do
   check "lib"
 
   library "json"
+  library "logger"
+  library "monitor"
 end

data/lib/sidekiq-ecs-scaler/client.rb

@@ -11,15 +11,19 @@ module SidekiqEcsScaler
 
     # @return [Integer, nil]
     def update_desired_count
-      return unless config.task_meta
+      return if !config.enabled || config.task_meta.nil?
 
-      desired_count_by_latency.then do |desired_count|
-        describe_service.then do |service|
-          update_service(service: service, desired_count: desired_count) if service.desired_count != desired_count
+      desired_count = desired_count_by_latency
+      service = describe_service
 
-          desired_count
-        end
+      if service.desired_count == desired_count
+        not_change_log(desired_count)
+      else
+        update_service(service: service, desired_count: desired_count)
+        change_log(service.desired_count, desired_count)
       end
+
+      desired_count
     end
 
     private
@@ -70,5 +74,20 @@ module SidekiqEcsScaler
         }
       )
     end
+
+    # @param count [Integer]
+    # @return [void]
+    def not_change_log(count)
+      config.logger.info("SidekiqEcsScaler doesn't have updated the desired count of tasks from #{count}.")
+    end
+
+    # @param before_count [Integer]
+    # @param after_count [Integer]
+    # @return [void]
+    def change_log(before_count, after_count)
+      config.logger.info(
+        "SidekiqEcsScaler has updated the desired count of tasks from #{before_count} to #{after_count}."
+      )
+    end
   end
 end

data/lib/sidekiq-ecs-scaler/configuration.rb

@@ -3,6 +3,9 @@
 module SidekiqEcsScaler
   # SidekiqEcsScaler::Configuration
   class Configuration
+    # @!attribute [r] enabled
+    # @return [Boolean]
+    attr_reader :enabled
     # @!attribute [r] queue_name
     # @return [String]
     attr_reader :queue_name
@@ -18,9 +21,6 @@ module SidekiqEcsScaler
     # @!attribute [r] task_meta
     # @return [SidekiqEcsScaler::TaskMetaV4, nil]
     attr_reader :task_meta
-    # @!attribute [r] ecs_client
-    # @return [Aws::ECS::Client]
-    attr_reader :ecs_client
 
     # @return [void]
     def initialize
@@ -28,8 +28,30 @@ module SidekiqEcsScaler
       @min_count = 1
       @max_count = 1
       @max_latency = 3600
-      @ecs_client = Aws::ECS::Client.new
       @task_meta = TaskMetaV4.build_or_null
+      @enabled = true
+    end
+
+    # @param enabled [Boolean]
+    # @return [void]
+    # @raise [ArgumentError]
+    def enabled=(enabled)
+      raise ArgumentError if !enabled.is_a?(TrueClass) && !enabled.is_a?(FalseClass)
+
+      @enabled = enabled
+    end
+
+    # @return [Logger]
+    def logger
+      @logger ||= Sidekiq.logger
+    end
+
+    # @param logger [Logger]
+    # @return [void]
+    def logger=(logger)
+      raise ArgumentError unless logger.is_a?(Logger)
+
+      @logger = logger
     end
 
     # @param queue_name [String]
@@ -69,6 +91,11 @@ module SidekiqEcsScaler
       @max_latency = max_latency
     end
 
+    # @return [Aws::ECS::Client]
+    def ecs_client
+      @ecs_client ||= Aws::ECS::Client.new
+    end
+
     # @param ecs_client [Aws::ECS::Client]
     # @return [void]
     # @raise [ArgumentError]

data/lib/sidekiq-ecs-scaler/version.rb

@@ -2,5 +2,5 @@
 
 module SidekiqEcsScaler
   # @return [String]
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/sidekiq-ecs-scaler.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "logger"
 require "uri"
 require "net/http"
 require "json"

data/sig/sidekiq-ecs-scaler.rbs

@@ -28,9 +28,15 @@ module SidekiqEcsScaler
     def describe_service: () -> ::Aws::ECS::Types::Service
 
     def update_service: (service: ::Aws::ECS::Types::Service, desired_count: ::Integer) -> ::Aws::ECS::Types::UpdateServiceResponse
+
+    def not_change_log: (::Integer) -> void
+
+    def change_log: (::Integer, ::Integer) -> void
   end
 
   class Configuration
+    attr_reader enabled: bool
+
     attr_accessor queue_name: ::String
 
     attr_reader min_count: ::Integer
@@ -41,16 +47,22 @@ module SidekiqEcsScaler
 
     attr_reader task_meta: ::SidekiqEcsScaler::TaskMetaV4?
 
-    attr_reader ecs_client: ::Aws::ECS::Client
-
     def initialize: () -> void
 
+    def enabled=: (bool) -> void
+
+    def logger: () -> ::Logger
+
+    def logger=: (::Logger) -> void
+
     def min_count=: (::Integer) -> void
 
     def max_count=: (::Integer) -> void
 
     def max_latency=: (::Integer) -> void
 
+    def ecs_client: () -> ::Aws::ECS::Client
+
     def ecs_client=: (::Aws::ECS::Client) -> void
 
     def latency_per_count: () -> ::Integer

data/sig-private/sidekiq.rbs

@@ -1,4 +1,6 @@
 module Sidekiq
+  def self.logger: () -> ::Logger
+
   module Worker
     def self.sidekiq_options: (?::Hash[untyped, untyped]) -> ::Hash[untyped, untyped]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-ecs-scaler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - shoma07
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ecs