upfluence-utils 0.12.11 → 0.12.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 422d6056047e387e14e46823773b9ba7f1d3463657b1ac5797a4c492ee772db8
-  data.tar.gz: 113685a071e08a026bc2518567b9539698b4f9be99a1b24b344e41b73c81b346
+  metadata.gz: 5ddcbd6854f88cf5645e0295a48ac21f9aec1da81d71cf20d49214c61d57f8d9
+  data.tar.gz: 43907a8dc7d24c0609d914f46c8954dd67b6af664f474f26038ae5551eac6f65
 SHA512:
-  metadata.gz: 0e243d46b108b49effee29ebc105ffeb498d69554158267308d9665d6f4be6c7d0dd6e581e1479186fdb0f9e87857aafeb8fbf4cad29d3a1a2d2c1daed54ed8a
-  data.tar.gz: 68d33676ad949085e6ee8a8f456fb9d792b94f8438bd16b93f41e679a82bfe70b1291bdedf677e35f1ed1f727a57fc4ab84a9e77de1f83cd241acee66bbf5e10
+  metadata.gz: 4a54773f0b7123115b0139bb417972df0b47347e10b03bfa9299adfe6e9921166510328776863ea5850ad6f36a9102c84a58c55a3e23fe6ad758c169ce9066f8
+  data.tar.gz: 85b2ac6104fb0e8eeda611b6e7cc2027f24214e49e726e083b0ba111a237e8daade7ef18f40f256a03300cd21b80445989d674f5c8ca3ae9dfa5789b152b2447

data/lib/upfluence/http/server.rb

@@ -18,6 +18,7 @@ require 'upfluence/http/middleware/handle_exception'
 require 'upfluence/http/middleware/prometheus'
 require 'upfluence/http/middleware/cors'
 require 'upfluence/http/middleware/request_stapler'
+require 'upfluence/instrumentation'
 
 Rack::Timeout::Logger.disable
 
@@ -42,6 +43,11 @@ module Upfluence
         max_threads:           ENV.fetch('HTTP_SERVER_MAX_THREADS', 5).to_i,
         request_timeout:       ENV['HTTP_SERVER_REQUEST_TIMEOUT']&.to_i,
         middlewares:           [],
+        instrumentations:      [
+          Instrumentation::PumaInstrumenter.new,
+          Instrumentation::GCInstrumenter.new,
+          Instrumentation::ActiveRecordPoolInstrumenter.new
+        ],
         debug:                 ENV.fetch('DEBUG', nil)
       }
 
@@ -103,6 +109,8 @@ module Upfluence
 
         Thread.new { run_prometheus_exporter } if @options[:push_gateway_url]
 
+        @options[:instrumentations].each(&:start)
+
         @handler.run(@builder, **@options) do |server|
           server.threaded = @options[:threaded] if server.respond_to? :threaded=
 

data/lib/upfluence/instrumentation/active_record_pool_instrumenter.rb

@@ -0,0 +1,30 @@
+require 'upfluence/instrumentation/periodic_instrumenter'
+require 'active_record'
+
+module Upfluence
+  module Instrumentation
+    class ActiveRecordPoolInstrumenter < PeriodicInstrumenter
+      KEYS = %i[
+        size connections busy dead idle waiting
+      ].freeze
+
+      def prefix
+        'active_record_pool'
+      end
+
+      def metrics
+        KEYS.reduce({}) do |acc, k|
+          acc.merge(k => { docstring: "Gauge for #{k}" })
+        end
+      end
+
+      def values
+        return {} unless ActiveRecord::Base.connected?
+
+        ActiveRecord::Base.connection_pool.stat.slice(*KEYS).reduce({}) do |acc, (k, v)|
+          acc.merge(k => [{ value: v }])
+        end
+      end
+    end
+  end
+end

data/lib/upfluence/instrumentation/gc_instrumenter.rb

@@ -0,0 +1,28 @@
+require 'upfluence/instrumentation/periodic_instrumenter'
+
+module Upfluence
+  module Instrumentation
+    class GCInstrumenter < PeriodicInstrumenter
+      KEYS = %i[
+        heap_live_slots heap_free_slots major_gc_count minor_gc_count
+        total_allocated_objects
+      ].freeze
+
+      def prefix
+        'ruby_gc'
+      end
+
+      def metrics
+        KEYS.reduce({}) do |acc, k|
+          acc.merge(k => { docstring: "Gauge for #{k}" })
+        end
+      end
+
+      def values
+        GC.stat.slice(*KEYS).reduce({}) do |acc, (k, v)|
+          acc.merge(k => [{ value: v }])
+        end
+      end
+    end
+  end
+end

data/lib/upfluence/instrumentation/periodic_instrumenter.rb

@@ -0,0 +1,61 @@
+module Upfluence
+  module Instrumentation
+    class PeriodicInstrumenter
+      def initialize(interval: 30, registry: ::Prometheus::Client.registry)
+        @interval = interval
+        @gauges = metrics.reduce({}) do |acc, (metric, values)|
+          metric_name = [prefix, metric].compact.join("_").to_sym
+
+          acc.merge(
+            metric => registry.get(metric_name) || registry.gauge(
+              metric_name,
+              docstring: values[:docstring] || '',
+              labels:    values[:labels] || []
+            )
+          )
+        end
+
+        @stop_thread = false
+      end
+
+      def start
+        @thread ||= Thread.new do
+          until @stop_thread
+            begin
+              values.each do |(metric, vs)|
+                vs.each do |v|
+                  @gauges[metric].set(v[:value], labels: v[:labels] || {})
+                end
+              end
+            rescue => e
+              Upfluence.error_logger.notify(e)
+            ensure
+              sleep @interval
+            end
+          end
+        end
+      end
+
+      def stop
+        return unless @thread&.alive?
+
+        @stop_thread = true
+        @thread.wakeup
+        @thread.join
+        @thread = nil
+      end
+
+      def prefix
+        nil
+      end
+
+      def values
+        raise "Please implement a subcalss"
+      end
+
+      def metrics
+        raise "Please implement a subcalss"
+      end
+    end
+  end
+end

data/lib/upfluence/instrumentation/puma_instrumenter.rb

@@ -0,0 +1,33 @@
+require 'upfluence/instrumentation/periodic_instrumenter'
+require 'puma'
+
+module Upfluence
+  module Instrumentation
+    class PumaInstrumenter < PeriodicInstrumenter
+      KEYS = %i[backlog_thread running_thread pool_capacity requests_count].freeze
+
+      def prefix
+        'puma'
+      end
+
+      def metrics
+        KEYS.reduce({}) do |acc, k|
+          acc.merge(k => { docstring: "Gauge for #{k}" })
+        end
+      end
+
+      def values
+        stats = Puma.stats_hash
+
+        {
+          requests_count: [{ value: stats[:requests_count] }],
+          backlog_thread: [{ value: stats[:backlog] }],
+          running_thread: [{ value: stats[:running] }],
+          pool_capacity:  [{ value: stats[:pool_capacity] }]
+        }
+      rescue NoMethodError
+        {}
+      end
+    end
+  end
+end

data/lib/upfluence/instrumentation.rb

@@ -0,0 +1,3 @@
+require 'upfluence/instrumentation/puma_instrumenter'
+require 'upfluence/instrumentation/gc_instrumenter'
+require 'upfluence/instrumentation/active_record_pool_instrumenter'

data/lib/upfluence/utils/version.rb

@@ -1,5 +1,5 @@
 module Upfluence
   module Utils
-    VERSION = '0.12.11'.freeze
+    VERSION = '0.12.12'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upfluence-utils
 version: !ruby/object:Gem::Version
-  version: 0.12.11
+  version: 0.12.12
 platform: ruby
 authors:
 - Upfluence
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -283,6 +283,11 @@ files:
 - lib/upfluence/http/middleware/prometheus.rb
 - lib/upfluence/http/middleware/request_stapler.rb
 - lib/upfluence/http/server.rb
+- lib/upfluence/instrumentation.rb
+- lib/upfluence/instrumentation/active_record_pool_instrumenter.rb
+- lib/upfluence/instrumentation/gc_instrumenter.rb
+- lib/upfluence/instrumentation/periodic_instrumenter.rb
+- lib/upfluence/instrumentation/puma_instrumenter.rb
 - lib/upfluence/logger.rb
 - lib/upfluence/mixin/html_scrubbing.rb
 - lib/upfluence/mixin/pagination.rb