activerecord-instrumentation 0.4.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b4ed66e59062642924f0db366fa6c49d311779284d78cfbee7c3012cd891c66
-  data.tar.gz: c086ac255b0bde806d7955a1e643b18cdb152b3e2e7cb4e6fce295826398bb96
+  metadata.gz: 635ba6dbb0a024eb2bae250b6d30493690f4b537fa169da2793738770b5d3a2e
+  data.tar.gz: f6b6e9d38b4b5f4521dec162ee36bc605bb31747f8a7898e7667fb7009ecac6d
 SHA512:
-  metadata.gz: 447d9d5f4d827c31d6a464f41d13bbcc95327e4a6288ba161f140892f8f4692a506c1800c66c98f80ae8157acf81e294bbd4addfdd6a9ea48f26151d7109f89b
-  data.tar.gz: 6f9feb55c56a14637dc97d5283c95c6fc4d731ed261a80daba7096d314ae3d64cb9b77fa2f91984c03357b8bfcae1fada23b931ee6d6a746519daba90e0f8648
+  metadata.gz: 0cbfa60d7a540c72a4a7505504e933c7d2e6e9f0431f1829e0ec2c9fad6528807ec67a32d0e2a9108b52dc424ab791051fe846057bfec637746acd2791fcfda2
+  data.tar.gz: 8ca19599f279459af06f90fffa5bc0f9d8f23447352a7a3fb47fe0919c18c729bf5ce41c0cf1eae188632a43e35cac581da603126a7818848189b4c2815eddb5

data/.circleci/config.yml

@@ -7,7 +7,7 @@ executors:
   ruby-latest:
     resource_class: small
     docker:
-      - image: circleci/ruby:latest
+      - image: circleci/ruby:2.7
         environment:
           BUNDLE_VERSION: "~> 1.17"
 
@@ -45,7 +45,7 @@ jobs:
             - v1-bundle-{{ checksum "Gemfile.lock" }}-
       - run:
           name: Install Ruby Dependencies
-          command: bundle check --path=vendor/bundle || bundle install --local --frozen --path=vendor/bundle --jobs=4 --retry=3 && bundle clean
+          command: bundle install --path=vendor/bundle # install every time so we don't have to package vendor/bundle with the gem
       - save_cache:
           key: v1-bundle-{{ checksum "Gemfile.lock" }}-
           paths:
@@ -123,4 +123,3 @@ workflows:
           requires:
             - gem-build
           context: artifact_publishing
-          

data/CHANGELOG.md

@@ -1,10 +1,20 @@
 Changelog
 =========
 
+## 0.5.2 01/24/2022
+  * Fixed query tagging for empty queries
+
+## 0.5.1 01/20/2022
+  * Fixed the publishing process
+
+## 0.5.0 01/18/2022
+  * Added db.query_type and db.query_category tags
+  * Added forwards compatibility code for the connection_config for rails 6.2
+
 ## 0.4.0 04/28/2020
   * Add SQL sanitizers
 
 ## 0.3.0 04/22/2020
   * Set up build pipeline with circleci and gem-publisher
   * Fixed linting issues
-  * Renamed gem to `activerecord-instrumentation`
+  * Renamed gem to `activerecord-instrumentation`

data/Gemfile

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# BEFORE changing this file, read https://wiki.doximity.com/articles/gemfile-maintenance
-source "https://artifacts.dox.support/repository/gems"
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,43 +1,37 @@
 PATH
   remote: .
   specs:
-    activerecord-instrumentation (0.4.0)
+    activerecord-instrumentation (0.5.2)
       activerecord
       opentracing (~> 0.5)
 
 GEM
-  remote: https://artifacts.dox.support/repository/gems/
+  remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activesupport (6.0.2.2)
+    activemodel (6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activerecord (6.1.4.4)
+      activemodel (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activesupport (6.1.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.0)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
-    dox-style (1.3.0)
-      rubocop (~> 0.77)
-      rubocop-performance (~> 1.5.1)
-      rubocop-rails (~> 2.2.0)
-      rubocop-rspec (~> 1.37.0)
-    i18n (1.8.2)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.14.0)
+    minitest (5.15.0)
     opentracing (0.5.0)
     opentracing_test_tracer (0.1.1)
       opentracing
     parallel (1.19.1)
     parser (2.7.1.1)
       ast (~> 2.4.0)
-    rack (2.2.2)
     rainbow (3.0.0)
     rake (13.0.1)
     rdoc (6.2.1)
@@ -63,22 +57,16 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.2.1)
-      rack (>= 1.1)
-      rubocop (>= 0.72.0)
     rubocop-rspec (1.37.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     sdoc (1.1.0)
       rdoc (>= 5.0)
     sqlite3 (1.4.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.6.1)
-    zeitwerk (2.3.0)
+    zeitwerk (2.5.3)
 
 PLATFORMS
   ruby
@@ -86,7 +74,6 @@ PLATFORMS
 DEPENDENCIES
   activerecord-instrumentation!
   bundler (~> 1.17)
-  dox-style
   opentracing_test_tracer (~> 0.1)
   rake (~> 13.0)
   rspec (~> 3.9.0)

data/activerecord-instrumentation.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "dox-style"
   spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9.0"

data/lib/active_record/open_tracing/processor.rb

@@ -8,6 +8,35 @@ module ActiveRecord
       SPAN_KIND = "client"
       DB_TYPE = "sql"
 
+      # Used to guess what type of query is running based on the first word of the query
+      #
+      # Categories are
+      # table: Run an action against a table changes the table metadata or configuration
+      # read: Read from the database
+      # write: Write or delete records to the database
+      # unknown: Can't tell the query action from the first word of the query
+      # not_found: First word of the query is not in this list
+      QUERY_CATEGORIES = {
+        alter: "table",
+        call: "unknown", # run a subquery
+        create: "table",
+        delete: "write",
+        drop: "table",
+        do: "read",
+        handler: "table", # table metadata
+        import: "write",
+        insert: "write",
+        load: "write", # covers LOAD XML and LOAD DATA queries
+        rename: "table",
+        replace: "write", # insert, on duplicate overwrite
+        select: "read",
+        table: "read", # similar to select
+        truncate: "table",
+        update: "write",
+        values: "unknown", # generates rows to use as a table but doesn't hit the database
+        with: "unknown" # sets up subqueries in preparation for other queries
+      }
+
       attr_reader :tracer, :sanitizer, :sql_logging_enabled
 
       def initialize(tracer, sanitizer: nil, sql_logging_enabled: true)
@@ -54,9 +83,22 @@ module ActiveRecord
         }.merge(db_statement(payload))
       end
 
+      # rubocop:disable Metrics/MethodLength
       def db_statement(payload)
-        sql_logging_enabled ? { "db.statement" => sanitize_sql(payload.fetch(:sql).squish) } : {}
+        if sql_logging_enabled
+          query_sql = sanitize_sql(payload.fetch(:sql).squish)
+          first_word = query_sql.split.first&.downcase || ""
+
+          {
+            "db.statement" => query_sql,
+            "db.query_type" => first_word,
+            "db.query_category" => QUERY_CATEGORIES[first_word.to_sym] || "not_found"
+          }
+        else
+          {}
+        end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def sanitize_sql(sql)
         sanitizer ? sanitizer.sanitize(sql) : sql
@@ -76,7 +118,9 @@ module ActiveRecord
       end
 
       def connection_config
-        @connection_config ||= ActiveRecord::Base.connection_config
+        # Rails 6.2 will deprecate ActiveRecord::Base.connection_config
+        @connection_config ||=
+          ActiveRecord::Base.try(:connection_db_config)&.configuration_hash || 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"
+    VERSION = "0.5.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.2
 platform: ruby
 authors:
 - SaleMove TechMovers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,20 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: dox-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: opentracing_test_tracer
   requirement: !ruby/object:Gem::Requirement
@@ -227,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: ActiveRecord OpenTracing intrumenter