logister-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc4c81cdfeef4f713ac40e5324e8d845da2190dacfcaf9e295e0da5d4d1a75a1
-  data.tar.gz: 3fdb07135981647437afae77a787645c89143847619edc46969f121b750a0c90
+  metadata.gz: c3ffbd6d90538c5e0cf39deab256aaf1b0c5c15f5899051e67cfedc6657ac4b5
+  data.tar.gz: af860be23dab9bd73c8d394e9b1b91b6076f62a6a5f67272991afafba75d83a6
 SHA512:
-  metadata.gz: 3d53d3e80a01927a2ae08fec30d30eeb9d7d7987c3e5c1d624433c0683fc25b232675208e62ff7e563a9cbefcd1ae33e0bae32c9a6deb0fb084e307be0755e40
-  data.tar.gz: c869dc8bb9c120b90d7f13b05ee291f1a82053ff3523a2bd8a4eafdd4159ee8553f975d0afc2eda97f9441a3b25df6f5c0bbf2c813b575f23b01386147e8eec9
+  metadata.gz: 59875a74fdee52e22b697b80e4840ba070db495eb905b47d6522576f2e745d4f64081bf0fbf5f8e7cfc48917466c1a8724a389fe36f728b29080ff71dcb79165
+  data.tar.gz: fb8e6d1898621e57f2fdb9c66a3e08b655151f3f06ed830e5e2a8c96313c4b1e181c1281846a2a62ada0d7332d8a9631630bb5b9abe9bf7a4fc4f14e04a781a3

data/README.md

@@ -56,6 +56,20 @@ end
 
 If Rails is present, the gem installs middleware that reports unhandled exceptions automatically.
 
+## Database load metrics (ActiveRecord)
+
+You can capture SQL timing metrics using ActiveSupport notifications:
+
+```ruby
+Logister.configure do |config|
+  config.capture_db_metrics = true
+  config.db_metric_min_duration_ms = 10.0
+  config.db_metric_sample_rate = 1.0
+end
+```
+
+This emits metric events with `message: "db.query"` and context fields such as `duration_ms`, `name`, `sql`, and `binds_count`.
+
 ## Manual reporting
 
 ```ruby

data/lib/generators/logister/templates/logister.rb

@@ -17,6 +17,11 @@ Logister.configure do |config|
   config.ignore_exceptions = []
   config.ignore_paths = []
 
+  # Optional ActiveRecord SQL instrumentation.
+  config.capture_db_metrics = false
+  config.db_metric_min_duration_ms = 10.0
+  config.db_metric_sample_rate = 1.0
+
   config.before_notify = lambda do |payload|
     payload
   end

data/lib/logister/configuration.rb

@@ -4,7 +4,8 @@ module Logister
   class Configuration
     attr_accessor :api_key, :endpoint, :environment, :service, :release, :enabled, :timeout_seconds, :logger,
                   :ignore_exceptions, :ignore_environments, :ignore_paths, :before_notify,
-                  :async, :queue_size, :max_retries, :retry_base_interval
+                  :async, :queue_size, :max_retries, :retry_base_interval,
+                  :capture_db_metrics, :db_metric_min_duration_ms, :db_metric_sample_rate
 
     def initialize
       @api_key = ENV['LOGISTER_API_KEY']
@@ -26,6 +27,10 @@ module Logister
       @queue_size = 1000
       @max_retries = 3
       @retry_base_interval = 0.5
+
+      @capture_db_metrics = false
+      @db_metric_min_duration_ms = 0.0
+      @db_metric_sample_rate = 1.0
     end
   end
 end

data/lib/logister/railtie.rb

@@ -21,6 +21,9 @@ module Logister
         copy_setting(app, config, :queue_size)
         copy_setting(app, config, :max_retries)
         copy_setting(app, config, :retry_base_interval)
+        copy_setting(app, config, :capture_db_metrics)
+        copy_setting(app, config, :db_metric_min_duration_ms)
+        copy_setting(app, config, :db_metric_sample_rate)
       end
     end
 
@@ -28,6 +31,10 @@ module Logister
       app.middleware.use Logister::Middleware
     end
 
+    initializer 'logister.sql_subscriber' do
+      Logister::SqlSubscriber.install!
+    end
+
     private
 
     def copy_setting(app, config, key)

data/lib/logister/sql_subscriber.rb

@@ -0,0 +1,57 @@
+module Logister
+  class SqlSubscriber
+    IGNORED_SQL_NAMES = %w[SCHEMA TRANSACTION].freeze
+
+    class << self
+      def install!
+        return if @installed
+
+        ActiveSupport::Notifications.subscribe('sql.active_record') do |name, started, finished, _id, payload|
+          handle_sql_event(name, started, finished, payload)
+        end
+
+        @installed = true
+      end
+
+      private
+
+      def handle_sql_event(_name, started, finished, payload)
+        config = Logister.configuration
+        return unless config.capture_db_metrics
+        return if payload[:cached]
+        return if IGNORED_SQL_NAMES.include?(payload[:name].to_s)
+
+        duration_ms = (finished - started) * 1000.0
+        return if duration_ms < config.db_metric_min_duration_ms.to_f
+        return if sampled_out?(config.db_metric_sample_rate)
+
+        level = duration_ms >= 500 ? 'warn' : 'info'
+
+        Logister.report_metric(
+          message: 'db.query',
+          level: level,
+          context: {
+            duration_ms: duration_ms.round(2),
+            name: payload[:name].to_s,
+            sql: payload[:sql].to_s,
+            cached: false,
+            binds_count: Array(payload[:binds]).size
+          },
+          tags: {
+            category: 'database'
+          }
+        )
+      rescue StandardError => e
+        config.logger.warn("logister sql subscriber failed: #{e.class} #{e.message}")
+      end
+
+      def sampled_out?(sample_rate)
+        rate = sample_rate.to_f
+        return true if rate <= 0.0
+        return false if rate >= 1.0
+
+        rand > rate
+      end
+    end
+  end
+end

data/lib/logister/version.rb

@@ -1,3 +1,3 @@
 module Logister
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/logister.rb

@@ -3,6 +3,7 @@ require_relative 'logister/configuration'
 require_relative 'logister/client'
 require_relative 'logister/reporter'
 require_relative 'logister/middleware'
+require_relative 'logister/sql_subscriber'
 
 module Logister
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logister-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Logister
@@ -55,6 +55,7 @@ files:
 - lib/logister/middleware.rb
 - lib/logister/railtie.rb
 - lib/logister/reporter.rb
+- lib/logister/sql_subscriber.rb
 - lib/logister/version.rb
 - logister-ruby.gemspec
 homepage: https://logister.org