Instrument sequel gem

.circleci/config.yml

@@ -442,6 +442,24 @@ workflows:
                 - "./gemfiles/rails_61.gemfile"
                 - "./gemfiles/rails_70.gemfile"
                 - "./gemfiles/rails_71.gemfile"
+  sequel:
+      jobs:
+      - test_apprisal:
+          matrix:
+            parameters:
+              stack:
+                - ruby_30
+                - ruby_30_mysql2
+                - ruby_31
+                - ruby_31_mysql2
+                - ruby_32
+                - ruby_32_mysql2
+                - ruby_33
+                - ruby_33_mysql2
+                - ruby_34
+                - ruby_34_mysql2
+              gemfile:
+                - "./gemfiles/sequel_50.gemfile"
   report_coverage:
     jobs:
       - report_coverage

gemfiles/sequel_50.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+# (c) Copyright IBM Corp. 2024
+
+source "https://rubygems.org"
+
+gem "minitest-reporters"
+gem "webmock"
+gem "puma"
+gem "rack-test"
+gem "simplecov", "~> 0.21.2"
+gem "sequel", ">= 5.0"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", "0.5.5"
+
+gemspec path: "../"

lib/instana/activators/sequel.rb

@@ -0,0 +1,20 @@
+# (c) Copyright IBM Corp. 2024
+
+module Instana
+  module Activators
+    class Sequel < Activator
+      def can_instrument?
+        defined?(::Sequel::Database)
+      end
+
+      def instrument
+        require 'instana/instrumentation/sequel'
+
+        ::Sequel::Database
+          .prepend(Instana::Instrumentation::Sequel)
+
+        true
+      end
+    end
+  end
+end

lib/instana/config.rb

@@ -73,6 +73,7 @@ def initialize(logger: ::Instana.logger, agent_host: ENV['INSTANA_AGENT_HOST'],
       @config[:'resque-client']    = { :enabled => true, :propagate => true }
       @config[:'resque-worker']    = { :enabled => true, :'setup-fork' => true }
       @config[:'rest-client']      = { :enabled => true }
+      @config[:sequel] = { :enabled => true }
       @config[:'sidekiq-client']   = { :enabled => true }
       @config[:'sidekiq-worker']   = { :enabled => true }
     end

lib/instana/instrumentation/sequel.rb

@@ -0,0 +1,42 @@
+# (c) Copyright IBM Corp. 2024
+
+module Instana
+  module Instrumentation
+    module Sequel
+      IGNORED_SQL = %w[BEGIN COMMIT SET].freeze
+      VERSION_SELECT_STATEMENT = "SELECT VERSION()".freeze
+      SANITIZE_REGEXP = /('[\s\S][^']*'|\d*\.\d+|\d+|NULL)/i.freeze
+
+      def log_connection_yield(sql, conn, *args)
+        call_payload = {
+          sequel: {
+            adapter: opts[:adapter],
+            host: opts[:host],
+            username: opts[:user],
+            db: opts[:database],
+            sql: maybe_sanitize(sql)
+          }
+        }
+        maybe_trace(call_payload) { super(sql, conn, *args) }
+      end
+
+      private
+
+      def maybe_sanitize(sql)
+        ::Instana.config[:sanitize_sql] ? sql.gsub(SANITIZE_REGEXP, '?') : sql
+      end
+
+      def maybe_trace(call_payload, &blk)
+        if ::Instana.tracer.tracing? && !ignored?(call_payload)
+          ::Instana.tracer.trace(:sequel, call_payload, &blk)
+        else
+          yield
+        end
+      end
+
+      def ignored?(call_payload)
+        IGNORED_SQL.any? { |s| call_payload[:sequel][:sql].upcase.start_with?(s) } || call_payload[:sequel][:sql].upcase == VERSION_SELECT_STATEMENT
+      end
+    end
+  end
+end

lib/instana/tracing/span.rb

@@ -7,12 +7,12 @@ class Span
                          :memcache, :'net-http', :rack, :render, :'rpc-client',
                          :'rpc-server', :'sidekiq-client', :'sidekiq-worker',
                          :redis, :'resque-client', :'resque-worker', :'graphql.server', :dynamodb, :s3, :sns, :sqs, :'aws.lambda.entry', :activejob, :log, :"mail.actionmailer",
-                         :"aws.lambda.invoke", :mongo  ].freeze
+                         :"aws.lambda.invoke", :mongo, :sequel ].freeze
     ENTRY_SPANS = [ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server', :sqs,
                     :'aws.lambda.entry' ].freeze
     EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'resque-client',
                    :'rpc-client', :'sidekiq-client', :redis, :dynamodb, :s3, :sns, :sqs, :log, :"mail.actionmailer",
-                   :"aws.lambda.invoke", :mongo ].freeze
+                   :"aws.lambda.invoke", :mongo, :sequel ].freeze
     HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
 
     attr_accessor :parent

test/activator_test.rb

@@ -43,7 +43,7 @@ def test_unlimited_activated_set
     ENV.delete('INSTANA_ACTIVATE_SET')
     subject = activated_set
     assert_instance_of Set, subject
-    assert_equal 31, subject.length
+    assert_equal 32, subject.length
   ensure
     ENV.delete('INSTANA_ACTIVATE_SET')
   end

test/instrumentation/sequel_test.rb

@@ -0,0 +1,105 @@
+# (c) Copyright IBM Corp. 2024
+
+require 'test_helper'
+require 'sequel'
+
+class SequelTest < Minitest::Test
+  def setup
+    skip unless ENV['DATABASE_URL']
+    db_url = ENV['DATABASE_URL'].sub("sqlite3", "sqlite")
+    @db = Sequel.connect(db_url)
+    @db.create_table!(:blocks) do
+      String :name
+      String :color
+    end
+    @model = @db[:blocks]
+  end
+
+  def teardown
+    @db.drop_table(:blocks)
+    @db.disconnect
+  end
+
+  def test_config_defaults
+    assert ::Instana.config[:sanitize_sql] == true
+    assert ::Instana.config[:sequel].is_a?(Hash)
+    assert ::Instana.config[:sequel].key?(:enabled)
+    assert_equal true, ::Instana.config[:sequel][:enabled]
+  end
+
+  def test_create
+    Instana::Tracer.start_or_continue_trace(:sequel_test, {}) do
+      @model.insert(name: 'core', color: 'blue')
+    end
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :sequel)
+    data = span[:data][:sequel]
+    assert data[:sql].start_with?('INSERT INTO')
+  end
+
+  def test_read
+    @model.insert(name: 'core', color: 'blue')
+    Instana::Tracer.start_or_continue_trace(:sequel_test, {}) do
+      @model.where(name: 'core').first
+    end
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :sequel)
+    data = span[:data][:sequel]
+    assert data[:sql].start_with?('SELECT')
+    assert_nil span[:ec]
+  end
+
+  def test_update
+    @model.insert(name: 'core', color: 'blue')
+    Instana::Tracer.start_or_continue_trace(:sequel_test, {}) do
+      @model.where(name: 'core').update(color: 'red')
+    end
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :sequel)
+    data = span[:data][:sequel]
+    assert data[:sql].start_with?('UPDATE')
+    assert_nil span[:ec]
+    assert_equal 'red', @model.where(name: 'core').first[:color]
+  end
+
+  def test_delete
+    @model.insert(name: 'core', color: 'blue')
+    Instana::Tracer.start_or_continue_trace(:sequel_test, {}) do
+      @model.where(name: 'core').delete
+    end
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :sequel)
+    data = span[:data][:sequel]
+    assert data[:sql].start_with?('DELETE')
+    assert_nil span[:ec]
+    assert_nil @model.where(name: 'core').first
+  end
+
+  def test_raw
+    Instana::Tracer.start_or_continue_trace(:sequel_test, {}) do
+      @db.run('SELECT 1')
+    end
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :sequel)
+    data = span[:data][:sequel]
+    assert 'SELECT 1', data[:sql]
+    assert_nil span[:ec]
+  end
+
+  def test_raw_error
+    assert_raises Sequel::DatabaseError do
+      Instana::Tracer.start_or_continue_trace(:sequel_test, {}) do
+        @db.run('INVALID')
+      end
+    end
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :sequel)
+    assert_equal 1, span[:ec]
+  end
+end