upfluence-utils 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e1429c611b80c503096df4c7e19d60866a40aa3042cd1a73d8ec39d76b3a164
-  data.tar.gz: fcb360825de59c3f0251400597977dacf27ae7c36f76533e750e83cbfd3ae6bb
+  metadata.gz: 568c4033f087730c94a75c756587432873ee149b4d2462ea04b1b03169d9b551
+  data.tar.gz: e824e37e1cd2c901342f0089e859af8d62a908aa1c755d2527dc1a20309449f2
 SHA512:
-  metadata.gz: 45cbf134ed8f525e6b9ca2ac6e5dac7b063d0a69337e83bcff3f424bdcbf08f296aa3006d93f21dd0f4f5a88ada3e586aa01fa568daef4322fa122ff2b9df8c7
-  data.tar.gz: 6e681f3f08cdd2437c9968305702c325018d7760dcb590f2552247a99150dd56fcb74de5b5aabc74626c904af9a165d0b8567cdf0f711ab0c6c055457626856d
+  metadata.gz: 60d4fd0ba8383217d60a73eadf48920d15259c77be69922f7a65f313b9a297dc62274c598655e739f3403a51e0d0f2cdd8f116e714528cc261dfb1a59ea47536
+  data.tar.gz: c6cbf56699eb8e3d540dea322fda7920a35c5bb06162d1483aaeb337dae7ea16f1f30137d052aab41497b8596f73efdac21f10a87961060194fdcd00809e1106

data/lib/upfluence/http/server.rb

@@ -26,6 +26,7 @@ module Upfluence
   module HTTP
     class Server
       REQUEST_CONTEXT_KEY = :uhttp_request_context
+      SHUTDOWN_SIGNALS = %w[INT TERM].freeze
       DEFAULT_MIDDLEWARES = []
       DEFAULT_OPTIONS = {
         server:                          :puma,
@@ -51,7 +52,7 @@ module Upfluence
         ],
         admin_port:                      ENV.fetch('ADMIN_PORT', nil),
         debug:                           ENV.fetch('DEBUG', nil)
-      }.freeze
+      }
 
       def initialize(options = {}, &block)
         @options = DEFAULT_OPTIONS.dup.merge(options)
@@ -62,19 +63,26 @@ module Upfluence
         @admin_builder = admin_builder(opts) if opts[:admin_port]
         @production_builder = production_builder(opts, &block)
         @handler = Rack::Handler.get(opts[:server])
+        @stoppables = []
       end
 
       def serve
         ENV['RACK_ENV'] = Upfluence.env.to_s
+        @stopping = false
+        signal_handlers = install_signal_handlers
+        admin_thread = nil
 
-        Thread.new { run_prometheus_exporter } if @options[:push_gateway_url]
+        register_stoppable(prometheus_exporter_thread) if @options[:push_gateway_url]
 
-        @options[:instrumentations].each(&:start)
+        @options[:instrumentations].each do |instrumentation|
+          instrumentation.start
+          register_stoppable(instrumentation) if instrumentation.respond_to?(:stop)
+        end
 
         if @admin_builder
           admin_port = @options[:admin_port].to_i
 
-          Thread.new do
+          admin_thread = Thread.new do
             run_builder(@admin_builder, Port: admin_port)
           end
 
@@ -84,6 +92,10 @@ module Upfluence
         end
 
         run_builder(@production_builder)
+      ensure
+        stop
+        admin_thread&.join
+        restore_signal_handlers(signal_handlers) if signal_handlers
       end
 
       class << self
@@ -102,6 +114,9 @@ module Upfluence
         opts = @options.merge(overrides)
 
         @handler.run(builder, **opts) do |server|
+          register_stoppable(server)
+          register_booted_handler(server)
+          configure_puma_instrumenter(server) if builder.equal?(@production_builder)
           server.threaded = opts[:threaded] if server.respond_to? :threaded=
 
           # Thin does not recognize the max_thread argument, howerver it has a
@@ -110,18 +125,62 @@ module Upfluence
         end
       end
 
+      def register_booted_handler(server)
+        return unless server.respond_to?(:events)
+
+        server.events.after_booted { install_signal_handlers }
+      end
+
+      def configure_puma_instrumenter(server)
+        @options[:instrumentations].select { |instrumentation| instrumentation.respond_to?(:server=) }.each do |instrumentation|
+          instrumentation.server = server
+        end
+      end
+
+      def install_signal_handlers
+        SHUTDOWN_SIGNALS.to_h do |signal|
+          previous_handler = Signal.trap(signal) do
+            Thread.new { stop }
+          end
+
+          [signal, previous_handler]
+        end
+      end
+
+      def restore_signal_handlers(handlers)
+        handlers.each { |signal, handler| Signal.trap(signal, handler) }
+      end
+
+      def register_stoppable(stoppable)
+        return stoppable.stop if @stopping
+
+        @stoppables << stoppable
+      end
+
+      def stop
+        @stopping = true
+        stoppables = @stoppables
+        @stoppables = []
+
+        stoppables.each(&:stop)
+      end
+
+      def prometheus_exporter_thread
+        Thread.new { run_prometheus_exporter }.tap do |thread|
+          thread.define_singleton_method(:stop) do
+            kill
+            join
+          end
+        end
+      end
+
       def production_builder(opts, &block)
-        base_handler = @base_handler
         has_admin = !opts[:admin_port].nil?
-        mount = method(:mount_admin_endpoints)
+        builder = Builder.new
 
-        Builder.new do
-          use Middleware::RequestStapler, timeout: opts[:request_timeout]
-          use Middleware::Logger
-          use Middleware::Prometheus
-          use Middleware::ApplicationHeaders, base_handler
-          use Middleware::HandleException
+        mount_middlewares(builder, opts)
 
+        builder.instance_eval do
           if opts[:enable_active_record_middleware] &&
              defined?(ActiveRecord::Base) &&
              ActiveRecord::Base.configurations.any?
@@ -130,44 +189,25 @@ module Upfluence
             use Middleware::ActiveRecord
           end
 
-          use Rack::Timeout, service_timeout: opts[:request_timeout] if opts[:request_timeout]
-
-          use Upfluence.error_logger.middleware
-
-          use Rack::ContentLength
-          use Rack::Chunked
-          use Rack::Lint if Upfluence.env.development?
-          use Rack::TempfileReaper
-          use Rack::ETag
-          use Middleware::CORS if Upfluence.env.development?
-
           (DEFAULT_MIDDLEWARES + opts[:middlewares]).each do |m|
             m = [m] unless m.is_a?(Array)
             use(*m)
           end
+        end
 
-          mount.call(self, opts) unless has_admin
-
-          map '/healthcheck' do
-            run(opts[:healthcheck_endpoint] || Endpoint::Healthcheck.new)
-          end
+        mount_admin_endpoints(builder, opts) unless has_admin
+        builder.instance_eval(&block)
 
-          instance_eval(&block)
-        end
+        builder
       end
 
       def admin_builder(opts)
-        mount = method(:mount_admin_endpoints)
+        builder = Builder.new
 
-        Builder.new do
-          use Rack::ContentLength
+        mount_middlewares(builder, opts)
+        mount_admin_endpoints(builder, opts)
 
-          map '/healthcheck' do
-            run(opts[:healthcheck_endpoint] || Endpoint::Healthcheck.new)
-          end
-
-          mount.call(self, opts)
-        end
+        builder
       end
 
       def mount_admin_endpoints(builder, opts)
@@ -186,6 +226,35 @@ module Upfluence
         end
       end
 
+      def mount_middlewares(builder, opts)
+        base_handler = @base_handler
+
+        builder.instance_eval do
+          use Middleware::RequestStapler, timeout: opts[:request_timeout]
+          use Middleware::Logger
+          use Middleware::Prometheus
+          use Middleware::ApplicationHeaders, base_handler
+          use Middleware::HandleException
+
+          use Rack::Timeout, service_timeout: opts[:request_timeout] if opts[:request_timeout]
+
+          use Upfluence.error_logger.middleware
+
+          use Rack::ContentLength
+          use Rack::Chunked
+          use Rack::Lint if Upfluence.env.development?
+          use Rack::TempfileReaper
+          use Rack::ETag
+          use Middleware::CORS if Upfluence.env.development?
+        end
+
+        builder.instance_eval do
+          map '/healthcheck' do
+            run(opts[:healthcheck_endpoint] || Endpoint::Healthcheck.new)
+          end
+        end
+      end
+
       def run_prometheus_exporter
         push = Prometheus::Client::Push.new(
           @options[:app_name],

data/lib/upfluence/instrumentation/periodic_instrumenter.rb

@@ -30,7 +30,7 @@ module Upfluence
             rescue => e
               Upfluence.error_logger.notify(e)
             ensure
-              sleep @interval
+              sleep @interval unless @stop_thread
             end
           end
         end

data/lib/upfluence/instrumentation/puma_instrumenter.rb

@@ -6,6 +6,8 @@ module Upfluence
     class PumaInstrumenter < PeriodicInstrumenter
       KEYS = %i[backlog_thread running_thread busy_thread pool_capacity requests_count].freeze
 
+      attr_writer :server
+
       def prefix
         'puma'
       end
@@ -17,15 +19,17 @@ module Upfluence
       end
 
       def values
-        stats = Puma.stats_hash
+        return {} unless @server
+
+        stats = @server.stats
 
         {
-          requests_count: [{ value: stats[:requests_count] }],
-          backlog_thread: [{ value: stats[:backlog] }],
-          running_thread: [{ value: stats[:running] }],
-          busy_thread:    [{ value: stats[:busy_threads] }],
-          pool_capacity:  [{ value: stats[:max_threads] }]
-        }
+          requests_count: stats[:requests_count],
+          backlog_thread: stats[:backlog],
+          running_thread: stats[:running],
+          busy_thread:    stats[:busy_threads],
+          pool_capacity:  stats[:max_threads]
+        }.compact.transform_values { |value| [{ value: value }] }
       rescue NoMethodError
         {}
       end

data/lib/upfluence/utils/version.rb

@@ -1,5 +1,5 @@
 module Upfluence
   module Utils
-    VERSION = '0.14.0'.freeze
+    VERSION = '0.14.1'.freeze
   end
 end

data/upfluence_utils.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'sentry-ruby', '< 6.0'
   spec.add_runtime_dependency 'sinatra-contrib'
   spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency 'puma'
+  spec.add_runtime_dependency 'puma', '>= 7.0'
   spec.add_runtime_dependency 'rack', '< 3.0'
   spec.add_runtime_dependency 'stackprof'
   spec.add_runtime_dependency 'prometheus-client', '~> 2.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: upfluence-utils
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Upfluence
@@ -141,14 +141,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement