instana 1.215.1 → 1.217.0

data/.tekton/task.yaml

@@ -57,6 +57,10 @@ spec:
   - name: mariadb
     # mariadb:11.3.2
     image: mariadb@sha256:851f05fe1e4cb290442c1b12b7108436a33fd8f6a733d4989950322d06d45c65
+    startupProbe:
+      initialDelaySeconds: 10
+      tcpSocket:
+        port: 3306
     env:
       - name: MYSQL_ROOT_PASSWORD # or MARIADB_ROOT_PASSWORD
         value: passw0rd
@@ -93,6 +97,10 @@ spec:
   - name: postgres
     # postgres:16.2-bookworm
     image: postgres@sha256:6b841c8f6a819884207402f1209a8116844365df15fca8cf556fc54a24c70800
+    startupProbe:
+      initialDelaySeconds: 10
+      tcpSocket:
+        port: 5432
     env:
       - name: POSTGRES_DB
         value: 'ci_test'
@@ -182,6 +190,10 @@ spec:
   - name: redis
     # redis:7.2.4-bookworm
     image: redis@sha256:fe98b2d39d462d06a7360e2860dd6ceff930745e3731eccb3c1406dd0dd7f744
+    startupProbe:
+      initialDelaySeconds: 10
+      tcpSocket:
+        port: 6379
   params:
   - name: imageDigest
     type: string
@@ -245,6 +257,10 @@ spec:
   - name: mongo
     # mongo:5.0.25-focal
     image: mongo@sha256:d1b8a7b77424347397653ab8ff500c66b1e9979b4cebf826951d37b0d3966721
+    startupProbe:
+      initialDelaySeconds: 10
+      tcpSocket:
+        port: 27017
   params:
   - name: imageDigest
     type: string
@@ -291,3 +307,143 @@ spec:
       workingDir: /workspace/ruby-sensor/
       command:
       - /workspace/ruby-sensor/.tekton/run_unittests.sh
+---
+apiVersion: tekton.dev/v1
+kind: Task
+metadata:
+  name: ruby-tracer-unittest-sequel-sqlite3-task
+spec:
+  params:
+  - name: imageDigest
+    type: string
+  - name: gemfile
+    type: string
+  workspaces:
+    - name: task-pvc
+      mountPath: /workspace
+  steps:
+    - name: unittest
+      image: ruby@$(params.imageDigest)
+      env:
+        - name: TEST_CONFIGURATION
+          value: libraries
+        - name: BUNDLE_GEMFILE
+          value: $(params.gemfile)
+        - name: DATABASE_URL
+          value: "sqlite3::memory:"
+      workingDir: /workspace/ruby-sensor/
+      command:
+      - /workspace/ruby-sensor/.tekton/run_unittests.sh
+---
+apiVersion: tekton.dev/v1
+kind: Task
+metadata:
+  name: ruby-tracer-unittest-sequel-mysql2-task
+spec:
+  sidecars:
+  # MySQL (compatible Mariadb)
+  - name: mariadb
+    # mariadb:11.3.2
+    image: mariadb@sha256:851f05fe1e4cb290442c1b12b7108436a33fd8f6a733d4989950322d06d45c65
+    startupProbe:
+      initialDelaySeconds: 10
+      tcpSocket:
+        port: 3306
+    env:
+      - name: MYSQL_ROOT_PASSWORD # or MARIADB_ROOT_PASSWORD
+        value: passw0rd
+      - name: MYSQL_DATABASE # or MARIADB_DATABASE
+        value: ci_test
+  params:
+  - name: imageDigest
+    type: string
+  - name: gemfile
+    type: string
+  workspaces:
+    - name: task-pvc
+      mountPath: /workspace
+  steps:
+    - name: unittest
+      image: ruby@$(params.imageDigest)
+      env:
+        - name: TEST_CONFIGURATION
+          value: libraries
+        - name: BUNDLE_GEMFILE
+          value: $(params.gemfile)
+        - name: DATABASE_URL
+          value: "mysql2://root:passw0rd@127.0.0.1:3306/ci_test"
+      workingDir: /workspace/ruby-sensor/
+      command:
+      - /workspace/ruby-sensor/.tekton/run_unittests.sh
+---
+apiVersion: tekton.dev/v1
+kind: Task
+metadata:
+  name: ruby-generate-currency-report-task
+spec:
+  workspaces:
+    - name: task-pvc
+      mountPath: /workspace
+  steps:
+    - name: generate-currency-report
+      # 3.10.13-bookworm
+      image: python@sha256:c970ff53939772f47b0672e380328afb50d8fd1c0568ed4f82c22effc54244fc
+      script: |
+        #!/usr/bin/env bash
+
+        cd /workspace/ruby-sensor/.tekton/.currency
+
+        python -m venv /tmp/venv
+        source /tmp/venv/bin/activate
+        pip install -r resources/requirements.txt
+
+        python scripts/generate_report.py
+        if [ $? -ne 0 ]; then
+            echo "Error occured while generating the ruby tracer currency report." >&2
+            exit 1
+        fi
+        cat docs/report.md
+---
+apiVersion: tekton.dev/v1
+kind: Task
+metadata:
+  name: ruby-upload-currency-report-task
+spec:
+  params:
+    - name: github-token-secret
+      default: instanacd-github-api-token
+  workspaces:
+    - name: task-pvc
+      mountPath: /workspace
+  steps:
+    - name: upload-currency-report
+      # alpine/git:2.43.0
+      image: alpine/git@sha256:6ff4de047dcc8f0c7d75d2efff63fbc189e87d2f458305f2cc8f165ff83309cf
+      env:
+        - name: GH_ENTERPRISE_TOKEN
+          valueFrom:
+            secretKeyRef:
+              name: $(params.github-token-secret)
+              key: "GH_ENTERPRISE_TOKEN"
+      script: |
+        #!/bin/sh
+
+        cd /workspace        
+        git clone https://oauth2:$GH_ENTERPRISE_TOKEN@github.ibm.com/instana/tracer-reports.git
+
+        if [ $? -ne 0 ]; then
+            echo "The attempt to clone the tracer-reports repository failed, preventing the upload of ruby tracer currency report." >&2
+            exit 1
+        fi
+
+        cd tracer-reports
+
+        cp ../ruby-sensor/.tekton/.currency/docs/report.md ./automated/currency/ruby/report.md
+
+        git config user.name "Instanacd PAT for GitHub Enterprise"
+        git config user.email instana.ibm.github.enterprise@ibm.com
+        
+        git add .
+        
+        git commit -m "chore: Updated ruby currency report"
+        git push origin main

data/Rakefile

@@ -9,7 +9,7 @@ require 'json'
 Rake::TestTask.new(:test) do |t|
   t.verbose = false
   t.warning = false
-  t.ruby_opts = []
+  t.ruby_opts = ["--parser=parse.y"] if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('3.3')
 
   t.libs << "test"
   t.libs << "lib"

data/gemfiles/excon_0100.gemfile

@@ -0,0 +1,14 @@
+# (c) Copyright IBM Corp. 2023
+
+source "https://rubygems.org"
+
+gem "rack"
+gem "rackup"
+gem "minitest-reporters"
+gem "webmock"
+gem "puma"
+gem "rack-test"
+gem "simplecov", "~> 0.21.2"
+gem "excon", ">= 0.100.0", "< 1.0"
+
+gemspec path: "../"

data/gemfiles/excon_021.gemfile

@@ -12,6 +12,6 @@ gem "webmock"
 gem "puma"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
-gem "excon", ">= 0.21.0", "< 1.0"
+gem "excon", "0.21.0"
 
 gemspec path: "../"

data/gemfiles/excon_079.gemfile

@@ -12,6 +12,6 @@ gem "webmock"
 gem "puma"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
-gem "excon", ">= 0.79.0", "< 1.0"
+gem "excon", "0.79.0"
 
 gemspec path: "../"

data/gemfiles/excon_100.gemfile

@@ -1,4 +1,4 @@
-# (c) Copyright IBM Corp. 2023
+# (c) Copyright IBM Corp. 2024
 
 source "https://rubygems.org"
 
@@ -9,6 +9,6 @@ gem "webmock"
 gem "puma"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
-gem "excon", ">= 0.100.0", "< 1.0"
+gem "excon", ">= 1.0.0", "< 2.0"
 
 gemspec path: "../"

data/gemfiles/rails_61.gemfile

@@ -11,6 +11,7 @@ gem "puma"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
 gem "mail", ">= 2.8.1"
+gem "mutex_m" # mutex_m is not part of the default gems since Ruby 3.4.0
 gem "rails", ">= 6.1", "< 7.0"
 gem "mysql2", "0.5.5"
 gem "pg"

data/gemfiles/rails_70.gemfile

@@ -8,6 +8,7 @@ gem "puma"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
 gem "mail", ">= 2.8.1"
+gem "mutex_m" # mutex_m is not part of the default gems since Ruby 3.4.0
 gem "rails", "7.0.3"
 gem "mysql2", "0.5.5"
 gem "pg"

data/gemfiles/rails_71.gemfile

@@ -8,7 +8,8 @@ gem "puma"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
 gem "mail", ">= 2.8.1"
-gem "rails", ">= 7.1"
+gem "mutex_m" # mutex_m is not part of the default gems since Ruby 3.4.0
+gem "rails", "~> 7.1"
 gem "mysql2", "0.5.5"
 gem "pg"
 gem "sqlite3", "~> 1.4"

data/gemfiles/rails_80.gemfile

@@ -0,0 +1,17 @@
+# (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 "mail", ">= 2.8.1"
+gem "mutex_m" # mutex_m is not part of the default gems since Ruby 3.4.0
+gem "rails", ">= 8.0"
+gem "mysql2", "0.5.5"
+gem "pg"
+gem "sqlite3", ">= 2.1"
+
+gemspec path: "../"

data/gemfiles/{excon_02.gemfile → sequel_56.gemfile}

@@ -1,17 +1,16 @@
 # This file was generated by Appraisal
 
-# (c) Copyright IBM Corp. 2021
-# (c) Copyright Instana Inc. 2021
+# (c) Copyright IBM Corp. 2024
 
 source "https://rubygems.org"
 
-gem "rack"
-gem "rackup"
 gem "minitest-reporters"
 gem "webmock"
 gem "puma"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
-gem "excon", ">= 0.21.0", "< 1.0"
+gem "sequel", "~> 5.60.0"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", "0.5.5"
 
 gemspec path: "../"

data/gemfiles/sequel_57.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.70.0"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", "0.5.5"
+
+gemspec path: "../"

data/gemfiles/sequel_58.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.80"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", "0.5.5"
+
+gemspec path: "../"

data/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

data/lib/instana/backend/host_agent.rb

@@ -12,6 +12,8 @@ module Instana
         @logger = logger
         @future = nil
         @client = nil
+        # Timer task to poll for agent liveliness
+        @agent_connection_task = Concurrent::TimerTask.new(execution_interval: 75) { announce }
       end
 
       def setup; end
@@ -27,7 +29,12 @@ module Instana
       alias start spawn_background_thread
 
       def announce
-        @client = until_not_nil { HostAgentLookup.new.call }
+        @client = with_timeout { HostAgentLookup.new.call }
+        # Shuts down the connection task based on agent connection client.
+        @client ? @agent_connection_task.shutdown : @agent_connection_task.execute
+        # Do not continue further if the agent is down/connection to the agent is unsuccessfull
+        return nil unless @client
+
         begin
           @discovery.send(:observers)&.send(:notify_and_delete_observers, Time.now, nil, nil)
         ensure
@@ -74,14 +81,16 @@ module Instana
 
       private
 
-      def until_not_nil
-        loop do
+      def with_timeout
+        15.times do
           result = yield
           return result unless result.nil?
 
           @logger.debug("Waiting on a connection to the agent.")
           sleep(1)
         end
+        @logger.info("Agent connection timed out retrying after 60 seconds")
+        nil
       end
 
       def discovery_value

data/lib/instana/config.rb

@@ -73,6 +73,7 @@ module Instana
       @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

data/lib/instana/instrumentation/active_record.rb

@@ -6,7 +6,7 @@ module Instana
     module ActiveRecord
       IGNORED_NAMES = %w[SCHEMA EXPLAIN CACHE].freeze
       IGNORED_SQL = %w[BEGIN COMMIT SET].freeze
-      SANITIZE_REGEXP = /('[\s\S][^']*'|\d*\.\d+|\d+|NULL)/i.freeze
+      SANITIZE_REGEXP = /('[\s\S][^']*'|\d*\.\d+|\d+|NULL)/i
 
       def log(sql, name = 'SQL', binds = [], *args, **kwargs, &block)
         call_payload = {

data/lib/instana/instrumentation/instrumented_request.rb

@@ -9,8 +9,8 @@ require 'rack/request'
 
 module Instana
   class InstrumentedRequest < Rack::Request
-    W3C_TRACE_PARENT_FORMAT = /[0-9a-f][0-9a-e]-(?<trace>[0-9a-f]{32})-(?<parent>[0-9a-f]{16})-(?<flags>[0-9a-f]{2})/.freeze
-    INSTANA_TRACE_STATE = /in=(?<trace>[0-9a-f]+);(?<span>[0-9a-f]+)/.freeze
+    W3C_TRACE_PARENT_FORMAT = /[0-9a-f][0-9a-e]-(?<trace>[0-9a-f]{32})-(?<parent>[0-9a-f]{16})-(?<flags>[0-9a-f]{2})/
+    INSTANA_TRACE_STATE = /in=(?<trace>[0-9a-f]+);(?<span>[0-9a-f]+)/
 
     def skip_trace?
       # Honor X-Instana-L

data/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
+
+      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

data/lib/instana/tracing/span.rb

@@ -7,12 +7,12 @@ module Instana
                          :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

data/lib/instana/version.rb

@@ -2,6 +2,6 @@
 # (c) Copyright Instana Inc. 2016
 
 module Instana
-  VERSION = "1.215.1"
+  VERSION = "1.217.0"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/lib/instana.rb

@@ -1,7 +1,8 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2016
-
-require 'instana/setup'
+if ENV.fetch('INSTANA_DISABLE', false) && defined?(::Instana)
+  Object.send(:remove_const, :Instana)
+end
 
 # Boot the instana agent background thread.  If you wish to have greater
 # control on the where and which thread this is run in, instead use
@@ -14,6 +15,7 @@ require 'instana/setup'
 
 # :nocov:
 unless ENV.fetch('INSTANA_DISABLE', false)
+  require 'instana/setup'
   ::Instana::Activator.start
   ::Instana.agent.spawn_background_thread
 

data/test/activator_test.rb

@@ -43,7 +43,7 @@ class ActivatorTest < Minitest::Test
     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

data/test/instrumentation/rails_active_record_test.rb

@@ -17,7 +17,7 @@ class RailsActiveRecordTest < Minitest::Test
     ActiveRecord::Migration.suppress_messages do
       ActiveRecord::Migration.run(CreateBlocks, direction: :down)
     end
-    ActiveRecord::Base.remove_connection(@connection)
+    ActiveRecord::Base.remove_connection
   end
 
   def test_config_defaults

data/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