activerecord-instrumentation 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4946d5d97ab8aab8e8bbc51756e729aeb83ef93e7631d177071d109a60cd1a3
-  data.tar.gz: 46e7086f48e49b5ffec1c6c7a84d6a4502eb805599b268748f7a12b2ace248b8
+  metadata.gz: 8603038dd7ae6f69abee6711888a7d19ff52c1367978b870de7af88f95ca25da
+  data.tar.gz: be0315e02ee883a8d0f92c876a13c444fa33b26b160857dae518f2536de2e449
 SHA512:
-  metadata.gz: cc6b52f3e074b8b357c9f542d8980c09eb40346c1f61ccebb9f7d6b474f22a573fa295a7d4ea4d6e448763bb8c17272d70420da4cdf938a78eef183a6d050b11
-  data.tar.gz: f20c110b0971e300b1b34f8cbc9987ffa55b75defece93eeb1c0efd125f238250e0eb2153176a6fa9ce1f3bd657e2d8e24da7181d2f87ace075b30b5e48cf333
+  metadata.gz: 863be5ed15faafa248f2e6a78dbce8c51afc06bcf1f1be26cc217bfe552b1c9e074ccfd39963713706d6d91d6e61e8460e85c7937a890f1f40320420606d1c1d
+  data.tar.gz: 78fb8df31957e3b538584c5e8ae84613f43f047896d37fe899607544ac3464fb1aa3ca35aa387088aed4859e91c1285224084f571a1b2bf6f53d07be6e3dbdd7

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 Changelog
 =========
 
+## 0.6.2 11/21/2023
+  * Add db.role tag
+
 ## 0.6.1 09/07/2022
   * Update for ruby 3.x compatibility
   * Splat hash when passing method expecting keyword args

data/Gemfile.lock

@@ -1,30 +1,42 @@
 PATH
   remote: .
   specs:
-    activerecord-instrumentation (0.6.1)
+    activerecord-instrumentation (0.6.2)
       activerecord
       opentracing (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.0)
-    concurrent-ruby (1.1.10)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.3)
-    i18n (1.12.0)
+    drb (2.2.0)
+      ruby2_keywords
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.16.3)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
     opentracing (0.5.0)
     opentracing_test_tracer (0.1.1)
       opentracing
@@ -59,10 +71,12 @@ GEM
     rubocop-rspec (1.37.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.5)
     sdoc (1.1.0)
       rdoc (>= 5.0)
     sqlite3 (1.4.2)
-    tzinfo (2.0.5)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.6.1)
 

data/lib/active_record/open_tracing/processor.rb

@@ -74,6 +74,7 @@ module ActiveRecord
 
       def tags_for_payload(payload)
         db_config = connection_config(payload[:connection])
+        db_instance = db_config.fetch(:database)
 
         {
           "component" => COMPONENT_NAME,
@@ -81,7 +82,8 @@ module ActiveRecord
           "db.instance" => db_instance,
           "db.cached" => payload.fetch(:cached, false),
           "db.type" => DB_TYPE,
-          "peer.address" => peer_address_tag(db_config)
+          "db.role" => db_role_for(payload[:connection]),
+          "peer.address" => peer_address_tag(db_config, db_instance)
         }.merge(db_statement(payload))
       end
 
@@ -106,8 +108,8 @@ module ActiveRecord
         sanitizer ? sanitizer.sanitize(sql) : sql
       end
 
-      def peer_address_tag(config)
-        @peer_address_tag ||= [
+      def peer_address_tag(config, db_instance)
+        [
           "#{config.fetch(:adapter)}://",
           config[:username],
           config[:host] && "@#{config[:host]}",
@@ -115,27 +117,42 @@ module ActiveRecord
         ].join
       end
 
-      def db_instance
-        @db_instance ||= connection_config.fetch(:database)
-      end
-
       # If a connection is passed in, pull the db config options hash from it.  This connection
       # is likely to be attached to the query/query client.  Fall back to the application level
       # config.  This change will show writer vs reader/replica dbs in spans when it is determined
       # at the query level.
       def connection_config(connection = nil)
-        unless defined? @connection_config
-          if connection.raw_connection && connection.raw_connection.respond_to?(:query_options)
-            # you have a mysql client
-            @connection_config = connection.raw_connection.query_options
-          else
-            # Rails 6.2 will deprecate ActiveRecord::Base.connection_config
-            @connection_config = ActiveRecord::Base.try(:connection_db_config)&.configuration_hash ||
-                                  ActiveRecord::Base.connection_config
-          end
+        if connection && connection.raw_connection && connection.raw_connection.respond_to?(:query_options)
+          # you have a mysql client
+          connection.raw_connection.query_options
+        else
+          # Rails 6.2 will deprecate ActiveRecord::Base.connection_config
+          ActiveRecord::Base.try(:connection_db_config)&.configuration_hash ||
+                                ActiveRecord::Base.connection_config
         end
+      end
 
-        @connection_config
+      DB_NAME_TO_ROLE = {
+        "primary" => "writing",
+        "primary_replica" => "reading"
+      }
+
+      # Returns the database role for the current connection. Usually, this will
+      # be either writing or reading (when using reader replicas).
+      #
+      # * connection.role was introduced in Rails 7 so we fallback to reading the db_config name
+      # and translate based on common values.
+      # * connection.role calls connection.pool.role and a NoMethodError is raised when
+      # the connection's pool is a ActiveRecord::ConnectionAdapters::NullPool.
+      def db_role_for(connection)
+        if connection.respond_to?(:role)
+          connection.role.to_s
+        else
+          db_name = connection.pool.pool_config.db_config.name
+          DB_NAME_TO_ROLE.fetch(db_name, "unknown")
+        end
+      rescue NoMethodError
+        "unknown"
       end
     end
   end

data/lib/active_record/open_tracing/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module OpenTracing
-    VERSION = "0.6.1"
+    VERSION = "0.6.2"
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - SaleMove TechMovers
 - Doximity
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,7 @@ homepage: https://github.com/doximity/ruby-activerecord-opentracing
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,8 +213,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: ActiveRecord OpenTracing intrumenter
 test_files: []