autoscale-agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc5fb7bd79bb436a7f36d9c95b3f27f8a1437cc269da86c275cc00b434784ed2
+  data.tar.gz: 69057429ec9c74443d3b23a8fbe5ef2fd7b716fe414393d4e59eef5944b533d2
+SHA512:
+  metadata.gz: 5379183c0664bb43b528c11d229f607328a1ce99a88865f4da0d4e955751c083bed3b57884bc85b915ed902c877199c853cd112214661dcd58e6a6e86596f2a7
+  data.tar.gz: 493b64a3a84714e14b840a24ccb0a3197c6f6d8adf17ca4802a49cd3692ec3448216a49047df321eba5b2e9b7e9148b3702378d1290817f53be55d2ae1ccd15f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.1.0] - 2023-03-03
+
+- Initial release

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Michael R. van Rooijen, Autoscale.app
+
+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,50 @@
+# Ruby Agent (Autoscale.app)
+
+Provides [Autoscale.app] with the necessary metrics for autoscaling web and worker processes.
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+    bundle add autoscale-agent --version "~> 0"
+
+## Usage
+
+This gem may be used as a stand-alone agent, or as [Rack] middleware that integrates with any Rack-based web frameworks, including [Rails], [Sinatra] and [Hanami]).
+
+Installation instructions are provided during the autoscaler setup process on [Autoscale.app].
+
+## Related Packages
+
+The following gems are currently available.
+
+#### Queues (Worker Metric Functions)
+
+| Worker Library | Repository                                              |
+|----------------|---------------------------------------------------------|
+| Sidekiq        | https://github.com/autoscale-app/ruby-queue-sidekiq     |
+| Delayed Job    | https://github.com/autoscale-app/ruby-queue-delayed-job |
+| Good Job       | https://github.com/autoscale-app/ruby-queue-good_job    |
+
+Let us know if your preferred worker library isn't available and we'll see if we can add support.
+
+## Development
+
+Prepare environment:
+
+    bin/setup
+
+See Rake for relevant tasks:
+
+    bin/rake -T
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/autoscale-app/ruby-agent
+
+[Autoscale.app]: https://autoscale.app
+[Agent]: https://github.com/autoscale-app/ruby-agent
+[Rack]: https://github.com/rack/rack
+[Rails]: https://rubyonrails.org
+[Sinatra]: https://sinatrarb.com
+[Hanami]: https://hanamirb.org

data/lib/autoscale/agent/configuration.rb

@@ -0,0 +1,80 @@
+module Autoscale
+  module Agent
+    class Configuration
+      class BlockMissingError < StandardError; end
+
+      class PlatformMissingError < StandardError; end
+
+      class InvalidPlatformError < StandardError; end
+
+      class << self
+        attr_writer :run
+
+        def run?
+          !defined?(@run) || @run == true
+        end
+      end
+
+      def initialize(&block)
+        instance_eval(&block)
+
+        if Configuration.run?
+          web_dispatchers.run
+          worker_dispatchers.run
+        end
+      end
+
+      def platform(value = nil)
+        if value
+          @platform = validate_platform(value)
+        else
+          @platform || raise(PlatformMissingError)
+        end
+      end
+
+      def web_dispatchers
+        @web_dispatchers ||= WebDispatchers.new
+      end
+
+      def worker_dispatchers
+        @worker_dispatchers ||= WorkerDispatchers.new
+      end
+
+      def worker_servers
+        @worker_servers ||= WorkerServers.new
+      end
+
+      def dispatch(token, &block)
+        if block
+          dispatch_worker(token, &block)
+        else
+          dispatch_web(token)
+        end
+      end
+
+      def serve(token, &block)
+        raise BlockMissingError, "missing block" unless block
+        worker_servers << WorkerServer.new(token, &block)
+      end
+
+      private
+
+      def dispatch_web(token)
+        web_dispatchers.queue_time = WebDispatcher.new(token)
+      end
+
+      def dispatch_worker(token, &block)
+        worker_dispatchers << WorkerDispatcher.new(token, &block)
+      end
+
+      def validate_platform(value)
+        case value
+        when :render
+          value
+        else
+          raise InvalidPlatformError, "currently the only valid option is :render"
+        end
+      end
+    end
+  end
+end

data/lib/autoscale/agent/middleware.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Autoscale
+  module Agent
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        return serve(env) if env["PATH_INFO"] == "/autoscale"
+        record_queue_time(env)
+        @app.call(env)
+      end
+
+      private
+
+      def serve(env)
+        tokens = (env["HTTP_AUTOSCALE_METRIC_TOKENS"] || "").split(",")
+        server = Autoscale::Agent.configuration.worker_servers.find(tokens)
+        return [404, {}, ["Not Found"]] unless server
+        headers = {
+          "content-type" => "application/json",
+          "cache-control" => "must-revalidate, private, max-age=0"
+        }
+        [200, headers, [MultiJson.dump(server.serve)]]
+      end
+
+      def record_queue_time(env)
+        return unless request_start_header(env)
+        return unless (dispatcher = Autoscale::Agent.configuration.web_dispatchers.queue_time)
+        current_time = (Time.now.to_f * 1000).to_i
+        request_start_time = to_ms(request_start_header(env))
+        elapsed_ms = current_time - request_start_time
+        elapsed = (elapsed_ms < 0) ? 0 : elapsed_ms
+        dispatcher.add(elapsed)
+      end
+
+      def request_start_header(env)
+        (env["HTTP_X_REQUEST_START"] || env["HTTP_X_QUEUE_START"]).to_i
+      end
+
+      def to_ms(start)
+        case Autoscale::Agent.configuration.platform
+        when :render
+          (start / 1000).to_i
+        end
+      end
+    end
+  end
+end

data/lib/autoscale/agent/railtie.rb

@@ -0,0 +1,9 @@
+module Autoscale
+  module Agent
+    class Railtie < ::Rails::Railtie
+      initializer "autoscale.add_middleware" do |app|
+        app.config.middleware.insert 0, Autoscale::Agent::Middleware
+      end
+    end
+  end
+end

data/lib/autoscale/agent/request.rb

@@ -0,0 +1,31 @@
+module Autoscale
+  module Agent
+    module Request
+      module_function
+
+      def dispatch(body, token:)
+        url = ENV["AUTOSCALE_METRICS_URL"] || "https://metrics.autoscale.app"
+
+        headers = {
+          "User-Agent" => "Autoscale Agent (Ruby)",
+          "Content-Type" => "application/json",
+          "Autoscale-Metric-Token" => token
+        }
+
+        post(url, body, headers)
+      end
+
+      def post(url, body, headers = {})
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.port == 443
+        http.open_timeout = 5
+        http.read_timeout = 5
+        request = Net::HTTP::Post.new(uri.request_uri)
+        headers.each { |key, value| request[key] = value }
+        request.body = body
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/autoscale/agent/version.rb

@@ -0,0 +1,5 @@
+module Autoscale
+  module Agent
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/autoscale/agent/web_dispatcher.rb

@@ -0,0 +1,64 @@
+module Autoscale
+  module Agent
+    class WebDispatcher
+      TTL = 30
+
+      attr_reader :token
+
+      def initialize(token)
+        @id = token.each_char.take(7).join
+        @token = token
+        @buffer = {}
+        @mutex = Mutex.new
+      end
+
+      def add(value, timestamp: Time.now.to_i)
+        @mutex.synchronize do
+          @buffer[timestamp] ||= 0
+          @buffer[timestamp] = value if value > @buffer[timestamp]
+        end
+      end
+
+      def prune
+        @mutex.synchronize do
+          max_age = Time.now.to_i - TTL
+          @buffer.delete_if { |timestamp, _| timestamp < max_age }
+        end
+      end
+
+      def dispatch
+        return unless (payload = build_payload)
+
+        body = MultiJson.dump(payload)
+        response = Request.dispatch(body, token: token)
+
+        unless response.is_a?(Net::HTTPOK)
+          revert_payload(payload)
+          error "Failed to dispatch (#{response.code}) #{response.body}"
+        end
+      end
+
+      private
+
+      def build_payload
+        @mutex.synchronize do
+          now = Time.now.to_i
+          keys = @buffer.each_key.select { |key| key < now }
+          payload = @buffer.slice(*keys)
+          keys.each { |key| @buffer.delete(key) }
+          payload if payload.any?
+        end
+      end
+
+      def revert_payload(payload)
+        payload.each do |timestamp, value|
+          add(value, timestamp: timestamp)
+        end
+      end
+
+      def error(msg)
+        puts "Autoscale::Agent/WebDispatcher[#{@id}][ERROR]: #{msg}"
+      end
+    end
+  end
+end

data/lib/autoscale/agent/web_dispatchers.rb

@@ -0,0 +1,47 @@
+module Autoscale
+  module Agent
+    class WebDispatchers
+      class AlreadySetError < StandardError
+      end
+
+      include Enumerable
+
+      DISPATCH_INTERVAL = 15
+
+      attr_reader :queue_time
+
+      def initialize
+        @dispatchers = []
+      end
+
+      def queue_time=(dispatcher)
+        raise AlreadySetError if defined?(@queue_time)
+        @dispatchers << (@queue_time = dispatcher)
+      end
+
+      def each(&block)
+        @dispatchers.each(&block)
+      end
+
+      def prune
+        each(&:prune)
+      end
+
+      def dispatch
+        each(&:dispatch)
+      rescue => err
+        puts "Autoscale::Agent/WebDispatcher: #{err}\n#{err.backtrace.join("\n")}"
+      end
+
+      def run
+        Thread.new do
+          loop do
+            prune
+            dispatch
+            sleep DISPATCH_INTERVAL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/autoscale/agent/worker_dispatcher.rb

@@ -0,0 +1,32 @@
+module Autoscale
+  module Agent
+    class WorkerDispatcher
+      attr_reader :token
+
+      def initialize(token, &block)
+        @id = token.each_char.take(7).join
+        @token = token
+        @block = block
+      end
+
+      def dispatch
+        if (value = @block.call)
+          body = MultiJson.dump(Time.now.to_i => value)
+          response = Request.dispatch(body, token: @token)
+
+          unless response.is_a?(Net::HTTPOK)
+            error "Failed to dispatch (#{response.code}) #{response.body}"
+          end
+        else
+          error "Failed to calculate worker information (nil)"
+        end
+      end
+
+      private
+
+      def error(msg)
+        puts "Autoscale::Agent/WorkerDispatcher[#{@id}][ERROR]: #{msg}"
+      end
+    end
+  end
+end

data/lib/autoscale/agent/worker_dispatchers.rb

@@ -0,0 +1,38 @@
+module Autoscale
+  module Agent
+    class WorkerDispatchers
+      include Enumerable
+
+      DISPATCH_INTERVAL = 15
+
+      def initialize
+        @dispatchers = []
+      end
+
+      def each(&block)
+        @dispatchers.each(&block)
+      end
+
+      def <<(dispatcher)
+        @dispatchers << dispatcher
+      end
+
+      def dispatch
+        each do |dispatcher|
+          dispatcher.dispatch
+        rescue => err
+          puts "Autoscale::Agent/WorkerDispatcher: #{err}\n#{err.backtrace.join("\n")}"
+        end
+      end
+
+      def run
+        Thread.new do
+          loop do
+            dispatch
+            sleep DISPATCH_INTERVAL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/autoscale/agent/worker_server.rb

@@ -0,0 +1,16 @@
+module Autoscale
+  module Agent
+    class WorkerServer
+      attr_reader :token
+
+      def initialize(token, &block)
+        @token = token
+        @block = block
+      end
+
+      def serve
+        @block.call
+      end
+    end
+  end
+end

data/lib/autoscale/agent/worker_servers.rb

@@ -0,0 +1,23 @@
+module Autoscale
+  module Agent
+    class WorkerServers
+      include Enumerable
+
+      def initialize
+        @servers = []
+      end
+
+      def each(&block)
+        @servers.each(&block)
+      end
+
+      def <<(server)
+        @servers << server
+      end
+
+      def find(tokens)
+        @servers.find { |server| tokens.include?(server.token) }
+      end
+    end
+  end
+end

data/lib/autoscale/agent.rb

@@ -0,0 +1,30 @@
+require "uri"
+require "net/https"
+require "multi_json"
+
+require_relative "agent/configuration"
+require_relative "agent/middleware"
+require_relative "agent/request"
+require_relative "agent/version"
+require_relative "agent/web_dispatcher"
+require_relative "agent/web_dispatchers"
+require_relative "agent/worker_dispatcher"
+require_relative "agent/worker_dispatchers"
+require_relative "agent/worker_server"
+require_relative "agent/worker_servers"
+
+module Autoscale
+  module Agent
+    module_function
+
+    def configure(&block)
+      @configuration = Configuration.new(&block)
+    end
+
+    def configuration
+      @configuration
+    end
+  end
+end
+
+require_relative "agent/railtie" if defined?(Rails::Railtie)

data/lib/autoscale-agent.rb

@@ -0,0 +1 @@
+require_relative "autoscale/agent"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: autoscale-agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael R. van Rooijen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+- support@autoscale.app
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/autoscale-agent.rb
+- lib/autoscale/agent.rb
+- lib/autoscale/agent/configuration.rb
+- lib/autoscale/agent/middleware.rb
+- lib/autoscale/agent/railtie.rb
+- lib/autoscale/agent/request.rb
+- lib/autoscale/agent/version.rb
+- lib/autoscale/agent/web_dispatcher.rb
+- lib/autoscale/agent/web_dispatchers.rb
+- lib/autoscale/agent/worker_dispatcher.rb
+- lib/autoscale/agent/worker_dispatchers.rb
+- lib/autoscale/agent/worker_server.rb
+- lib/autoscale/agent/worker_servers.rb
+homepage: https://autoscale.app
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://autoscale.app
+  documentation_uri: https://rubydoc.info/gems/autoscale-agent
+  source_code_uri: https://github.com/autoscale-app/ruby-agent
+  changelog_uri: https://github.com/autoscale-app/ruby-agent/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/autoscale-app/ruby-agent/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Provides Autoscale.app with the necessary metrics for autoscaling web and
+  worker processes
+test_files: []