activerecord-instrumentation 0.4.0.jlauer1 → 0.4.0.jlauer2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48fc834ad963b8c31ea09c9974ca1d024a692a71592a20e75f0079c9a2c93203
-  data.tar.gz: 6be927a6854e55963f0fa1ab1ca0f5aa05c44e2e75d4eb8bebe7b3a459a00c9a
+  metadata.gz: 64b6684423e203bf4a46392f6c912f934fe568ff7f92ac4341e353dd3374f001
+  data.tar.gz: 2becfd40110f3da47d1ab03bcb80036bd1d1751fda300639ca5614779c575c91
 SHA512:
-  metadata.gz: f4980f5d2f6d3c2081c42b1c5a2761fa10470b820ac75db0d1eda27e2b85fc4d973ddf901b69acc0aa43d0ab09e688934f7b847c6ed2c354431fa73c4e76d2ab
-  data.tar.gz: 2be68549771581ee9e470bcc2664036206fbaa973d6adecdfef4b7f03993c3b2b9b8b45e170ed11da4293453925c3bdebd38192c00937edaa2ac555b15c4de63
+  metadata.gz: f4d38250a120a52b6f68190448b5c3e9961a5cafed4620cea367b98f2ec6e4588c4c35fcd6f369e15b9933d8eed13fe8b018808fe1ce0234aec415966e29a9cb
+  data.tar.gz: 236bf2931c3b2c743698efeb4a1c9cb69b32a0609d12663e5213254680fdf8b68789eb0f42d3f4faabb92467f64641cd94807d29b71db4cf737ecd1d41869163

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 Changelog
 =========
 
-## 0.4.0.jlauer1 04/24/2020
+## 0.4.0.jlauer2 04/27/2020
   * Add SQL sanitizers
 
 ## 0.3.0 04/22/2020

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-instrumentation (0.4.0.jlauer1)
+    activerecord-instrumentation (0.4.0.jlauer2)
       activerecord (~> 6.0)
       opentracing (~> 0.5)
 

data/README.md

@@ -7,7 +7,7 @@ Adds OpenTracing instrumentation to ActiveRecord
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activerecord-opentracing'
+gem 'activerecord-instrumentation'
 ```
 
 ## Usage
@@ -16,8 +16,10 @@ gem 'activerecord-opentracing'
 require 'opentracing'
 OpenTracing.global_tracer = TracerImplementation.new
 
-require 'active_record/opentracing'
-ActiveRecord::OpenTracing.instrument
+require 'active_record/open_tracing'
+# If a sanitizer is specified, it will be used to scrub the sql statements. This is optional.
+sanitizer = ActiveRecord::OpenTracing::SqlSanitizer.build_sanitizer(:mysql)
+ActiveRecord::OpenTracing.instrument(sanitizer: sanitizer)
 ```
 
 # Development

data/lib/active_record/open_tracing.rb

@@ -9,15 +9,20 @@ require "active_record/open_tracing/sql_sanitizer"
 
 module ActiveRecord
   module OpenTracing
-    def self.instrument(tracer: ::OpenTracing.global_tracer, sanitizer: nil)
+    # Instruments activerecord for use with OpenTracing
+    #
+    # @param tracer [OpenTracing::Tracer] The tracer to which to send traces
+    # @param sanitizer [Symbol, String, nil] The sanitizer to use. Options are :mysql,
+    #   :postgres, :sql_server, :sqlite. If no sanitizer is specified, or a falsy value
+    #   is passed, sql will not be sanitized.
+    # @param sql_logging [Boolean] Whether to log sql statements to the tracer
+    def self.instrument(tracer: ::OpenTracing.global_tracer, sanitizer: nil, sql_logging_enabled: true)
       sql_sanitizer = sanitizer && SqlSanitizer.build_sanitizer(sanitizer)
-      processor = Processor.new(tracer, sanitizer: sql_sanitizer)
+      processor = Processor.new(tracer, sanitizer: sql_sanitizer, sql_logging_enabled: sql_logging_enabled)
 
       ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
         processor.call(*args)
       end
-
-      self
     end
   end
 end

data/lib/active_record/open_tracing/processor.rb

@@ -8,11 +8,12 @@ module ActiveRecord
       SPAN_KIND = "client"
       DB_TYPE = "sql"
 
-      attr_reader :tracer, :sanitizer
+      attr_reader :tracer, :sanitizer, :sql_logging_enabled
 
-      def initialize(tracer, sanitizer: nil)
+      def initialize(tracer, sanitizer: nil, sql_logging_enabled: true)
         @tracer = tracer
         @sanitizer = sanitizer
+        @sql_logging_enabled = sql_logging_enabled
       end
 
       def call(_event_name, start, finish, _id, payload)
@@ -48,51 +49,34 @@ module ActiveRecord
           "span.kind" => SPAN_KIND,
           "db.instance" => db_instance,
           "db.cached" => payload.fetch(:cached, false),
-          "db.statement" => sanitize_sql(payload.fetch(:sql).squish),
           "db.type" => DB_TYPE,
-          "peer.address" => db_address
-        }
+          "peer.address" => peer_address_tag
+        }.merge(db_statement(payload))
       end
 
-      def sanitize_sql(sql)
-        sanitizer ? sanitizer.sanitize(sql) : sql
+      def db_statement(payload)
+        sql_logging_enabled ? { "db.statement" => sanitize_sql(payload.fetch(:sql).squish) } : {}
       end
 
-      def db_instance
-        @db_instance ||= db_config.fetch(:database)
+      def sanitize_sql(sql)
+        sanitizer ? sanitizer.sanitize(sql) : sql
       end
 
-      def db_address
-        @db_address ||= [
-          adapter_str,
-          username_str,
-          host_str,
-          database_str
+      def peer_address_tag
+        @peer_address_tag ||= [
+          "#{connection_config.fetch(:adapter)}://",
+          connection_config[:username],
+          connection_config[:host] && "@#{connection_config[:host]}",
+          "/#{db_instance}"
         ].join
       end
 
-      def adapter_str
-        "#{connection_config.fetch(:adapter)}://"
-      end
-
-      def username_str
-        connection_config[:username]
-      end
-
-      def host_str
-        "@#{connection_config[:host]}" if connection_config[:host]
-      end
-
-      def database_str
-        "/#{connection_config.fetch(:database)}"
+      def db_instance
+        @db_instance ||= connection_config.fetch(:database)
       end
 
       def connection_config
-        ActiveRecord::Base.connection_config
-      end
-
-      def db_config
-        @db_config ||= ActiveRecord::Base.connection_config
+        @connection_config ||= ActiveRecord::Base.connection_config
       end
     end
   end

data/lib/active_record/open_tracing/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module OpenTracing
-    VERSION = "0.4.0.jlauer1"
+    VERSION = "0.4.0.jlauer2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.4.0.jlauer1
+  version: 0.4.0.jlauer2
 platform: ruby
 authors:
 - SaleMove TechMovers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler