instana 1.204.0.pre3 → 1.207.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c2235234526a14bbb8818b104e9417f4683179b2166cb222fe136af32794d4
-  data.tar.gz: 16a190359fa7208ceeaf7170db5cfc732bcb464837f6acde9eb1c5be08b09eba
+  metadata.gz: 01f078ad2a63d8cd71303a9bf7b413209eda0b2f464ce72f88c84ae05bf797da
+  data.tar.gz: d547946bdbb52ea3c3c3a7fc317f7bcd2dd8ccf37d52507788bff1b85fc4434c
 SHA512:
-  metadata.gz: d1465d42aeee46d0db43c2563b6bea541efddb553bb30fec875cc1cc2b5de30303476258ad889ccc9c6b10c4e1164f12001c743c16de0dafebce8e0020fd850b
-  data.tar.gz: b87b819750e3901f524609b89c2c8a96ac54965d8c6db2f4100a9cc2586cfafd55be20b30516364fdbec1199da7db8c987b6fb8f4edfc82761624caf5ea5d94b
+  metadata.gz: df3a3926477ab6842628f7fe1062655e63760c0fc1e5100912c8191f5894b8b4dabb1e030441b0b924d379bd6be56a9b69e877c22220153acba3393af59e4b51
+  data.tar.gz: 05fd9a76497614afca946d9538577bdfda21bd3a901759b285d7033425610206fd5a88405f86e86d52928da8f9324798cbf579bb516d845a8749f7c000d98fdf

data/.circleci/config.yml

@@ -113,6 +113,10 @@ executors:
 commands:
   setup:
     steps:
+      - run:
+          name: Install iproute2
+          command: |
+            sudo apt-get install iproute2
       - run:
           name: Install Java
           command: |
@@ -141,13 +145,20 @@ commands:
       - run:
           name: Run SonarQube to capture coverage
           command: |
-            wget -O /tmp/sonar-scanner-cli.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.5.0.2216.zip
+            wget -O /tmp/sonar-scanner-cli.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.6.2.2472.zip
             unzip -d /tmp /tmp/sonar-scanner-cli.zip
-            /tmp/sonar-scanner-4.5.0.2216/bin/sonar-scanner \
-            -Dsonar.projectKey=ruby-sensor \
-            -Dsonar.sources=. \
-            -Dsonar.host.url="${SONARQUBE_URL}" \
-            -Dsonar.login="${SONARQUBE_LOGIN}"          
+            if [[ -n "${CIRCLE_PR_NUMBER}" ]]; then
+              /tmp/sonar-scanner-4.6.2.2472/bin/sonar-scanner \
+                -Dsonar.host.url="${SONARQUBE_URL}" \
+                -Dsonar.login="${SONARQUBE_LOGIN}" \
+                -Dsonar.pullrequest.key="${CIRCLE_PR_NUMBER}" \
+                -Dsonar.pullrequest.branch="${CIRCLE_BRANCH}"
+            else
+              /tmp/sonar-scanner-4.6.2.2472/bin/sonar-scanner \
+                -Dsonar.host.url="${SONARQUBE_URL}" \
+                -Dsonar.login="${SONARQUBE_LOGIN}" \
+                -Dsonar.branch.name="${CIRCLE_BRANCH}"
+            fi
   run_tests:
     steps:
       - run:
@@ -156,7 +167,7 @@ commands:
             mkdir _junit
             bundle exec rake
       - store_test_results:
-          path: ~/_junit
+          path: ~/project/_junit
   run_rubocop:
     steps:
       - run:
@@ -171,11 +182,11 @@ commands:
             mkdir -p ~/.gem
             echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
             chmod 0600 /home/circleci/.gem/credentials
-      - run: 
+      - run:
           name: Publish Gem
           command: |
             bundle exec rake release[origin]
-            
+
 jobs:
   test_core:
     parameters:

data/lib/instana/backend/host_agent_reporting_observer.rb

@@ -9,6 +9,7 @@ module Instana
       ENTITY_DATA_URL = '/com.instana.plugin.ruby.%i'.freeze
       RESPONSE_DATA_URL = '/com.instana.plugin.ruby/response.%i?messageId=%s'.freeze
       TRACES_DATA_URL = "/com.instana.plugin.ruby/traces.%i".freeze
+      TRACE_METRICS_URL = "/tracermetrics".freeze
 
       attr_reader :report_timer
 
@@ -35,10 +36,24 @@ module Instana
       def report_to_backend
         report_metrics if ::Instana.config[:metrics][:enabled]
         report_traces if ::Instana.config[:tracing][:enabled]
+        report_trace_stats if ::Instana.config[:tracing][:enabled]
       rescue StandardError => e
         @logger.error(%(#{e}\n#{e.backtrace.join("\n")}))
       end
 
+      def report_trace_stats
+        discovery = @discovery.value
+        return unless discovery
+
+        payload = {
+          tracer: 'ruby',
+          pid: discovery['pid'],
+          metrics: @processor.span_metrics
+        }
+
+        @client.send_request('POST', TRACE_METRICS_URL, payload)
+      end
+
       def report_traces
         discovery = @discovery.value
         return unless discovery
@@ -87,17 +102,27 @@ module Instana
       end
 
       def metrics_payload(discovery)
-        proc_table = Sys::ProcTable.ps(pid: Process.pid)
-        process = ProcessInfo.new(proc_table)
-
-        {
+        payload = {
           pid: discovery['pid'],
-          name: Util.get_app_name,
-          exec_args: process.arguments,
-          gc: GCSnapshot.instance.report,
-          thread: {count: ::Thread.list.count},
-          memory: {rss_size: proc_table.rss / 1024} # Bytes to Kilobytes
+          name: Util.get_app_name
         }
+
+        if ::Instana.config[:metrics][:memory][:enabled]
+          proc_table = Sys::ProcTable.ps(pid: Process.pid)
+          process = ProcessInfo.new(proc_table)
+          payload[:exec_args] = process.arguments
+          payload[:memory] = {rss_size: process.memory_used}
+        end
+
+        if ::Instana.config[:metrics][:gc][:enabled]
+          payload[:gc] = GCSnapshot.instance.report
+        end
+
+        if ::Instana.config[:metrics][:thread][:enabled]
+          payload[:thread] = {count: ::Thread.list.count}
+        end
+
+        payload
       end
     end
   end

data/lib/instana/backend/process_info.rb

@@ -47,6 +47,14 @@ module Instana
         File.read(path).match(/\d+/).to_s.to_i
       end
 
+      def memory_used
+        if RbConfig::CONFIG['host_os'].include?('darwin')
+          rss / 1024
+        else
+          rss * 4096
+        end
+      end
+
       private
 
       def clean_arguments(arguments)

data/lib/instana/instrumentation/active_record.rb

@@ -19,7 +19,7 @@ module Instana
           }
         }
 
-        if binds.all? { |b| b.respond_to?(:value_before_type_cast) }
+        if binds.all? { |b| b.respond_to?(:value_before_type_cast) } && !::Instana.config[:sanitize_sql]
           mapped = binds.map(&:value_before_type_cast)
           call_payload[:activerecord][:binds] = mapped
         end

data/lib/instana/tracing/processor.rb

@@ -20,6 +20,9 @@ module Instana
       @batch_size = 3000
       @logger = logger
       @pid = Process.pid
+
+      @spans_opened = Concurrent::AtomicFixnum.new(0)
+      @spans_closed = Concurrent::AtomicFixnum.new(0)
     end
 
     # Adds a span to the span queue
@@ -34,9 +37,31 @@ module Instana
       end
       # :nocov:
 
+      @spans_closed.increment
       @queue.push(span)
     end
 
+    # Note that we've started a new span. Used to
+    # generate monitoring metrics.
+    def start_span(_)
+      @spans_opened.increment
+    end
+
+    # Clears and retrieves metrics associated with span creation and submission
+    def span_metrics
+      response = {
+        opened: @spans_opened.value,
+        closed: @spans_closed.value,
+        filtered: 0,
+        dropped: 0
+      }
+
+      @spans_opened.value = 0
+      @spans_closed.value = 0
+
+      response
+    end
+
     ##
     # send
     #
@@ -82,6 +107,9 @@ module Instana
     # test suite to reset state.
     #
     def clear!
+      @spans_opened.value = 0
+      @spans_closed.value = 0
+
       until @queue.empty? do
         # Non-blocking pop; ignore exception
         @queue.pop(true) rescue nil

data/lib/instana/tracing/span.rb

@@ -71,6 +71,8 @@ module Instana
         configure_custom(name)
       end
 
+      ::Instana.processor.start_span(self)
+
       # Attach a backtrace to all exit spans
       add_stack if ::Instana.config[:collect_backtraces] && exit_span?
     end

data/lib/instana/version.rb

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

data/sonar-project.properties

@@ -0,0 +1,9 @@
+sonar.projectKey=ruby-sensor
+sonar.sources=lib
+sonar.tests=test
+sonar.exclusions=_junit/*
+sonar.ruby.coverage.reportPaths=coverage/coverage.json
+sonar.links.homepage=https://github.com/instana/ruby-sensor/
+sonar.links.ci=https://circleci.com/gh/instana/ruby-sensor
+sonar.links.issue=https://github.com/instana/ruby-sensor/issues
+sonar.links.scm=https://github.com/instana/ruby-sensor/

data/test/backend/host_agent_reporting_observer_test.rb

@@ -23,6 +23,8 @@ class HostAgentReportingObserverTest < Minitest::Test
   end
 
   def test_report
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
     stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
       .to_return(status: 200)
 
@@ -35,6 +37,8 @@ class HostAgentReportingObserverTest < Minitest::Test
   end
 
   def test_report_fail
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
     stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
       .to_return(status: 500)
 
@@ -54,6 +58,9 @@ class HostAgentReportingObserverTest < Minitest::Test
       args: {file: 'test_helper.rb'}
     )
 
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
+
     stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
       .to_return(status: 200, body: action)
 
@@ -75,6 +82,9 @@ class HostAgentReportingObserverTest < Minitest::Test
                          args: {file: 'test_helper.rb'}
                        ])
 
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
+
     stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
       .to_return(status: 200, body: action)
 
@@ -90,6 +100,9 @@ class HostAgentReportingObserverTest < Minitest::Test
   end
 
   def test_agent_action_error
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
+
     stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
       .to_return(status: 200, body: 'INVALID')
 
@@ -114,6 +127,75 @@ class HostAgentReportingObserverTest < Minitest::Test
     ::Instana.config[:metrics][:enabled] = true
   end
 
+  def test_disable_metrics_memory
+    ::Instana.config[:metrics][:memory][:enabled] = false
+
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
+
+    stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
+      .with(body: ->(data) { (JSON.parse(data).keys & ['exec_args', 'memory']).length.eql?(0) })
+      .to_return(status: 200)
+
+    stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby/traces.0")
+      .to_return(status: 200)
+
+    client = Instana::Backend::RequestClient.new('10.10.10.10', 9292)
+    discovery = Concurrent::Atom.new({'pid' => 0})
+
+    subject = Instana::Backend::HostAgentReportingObserver.new(client, discovery, timer_class: MockTimer)
+
+    subject.report_timer.block.call
+  ensure
+    ::Instana.config[:metrics][:memory][:enabled] = true
+  end
+
+  def test_disable_gc
+    ::Instana.config[:metrics][:gc][:enabled] = false
+
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
+
+    stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
+      .with(body: ->(data) { (JSON.parse(data).keys & ['gc']).length.eql?(0) })
+      .to_return(status: 200)
+
+    stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby/traces.0")
+      .to_return(status: 200)
+
+    client = Instana::Backend::RequestClient.new('10.10.10.10', 9292)
+    discovery = Concurrent::Atom.new({'pid' => 0})
+
+    subject = Instana::Backend::HostAgentReportingObserver.new(client, discovery, timer_class: MockTimer)
+
+    subject.report_timer.block.call
+  ensure
+    ::Instana.config[:metrics][:gc][:enabled] = true
+  end
+
+  def test_disable_thread
+    ::Instana.config[:metrics][:thread][:enabled] = false
+
+    stub_request(:post, "http://10.10.10.10:9292/tracermetrics")
+      .to_return(status: 200)
+
+    stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby.0")
+      .with(body: ->(data) { (JSON.parse(data).keys & ['thread']).length.eql?(0) })
+      .to_return(status: 200)
+
+    stub_request(:post, "http://10.10.10.10:9292/com.instana.plugin.ruby/traces.0")
+      .to_return(status: 200)
+
+    client = Instana::Backend::RequestClient.new('10.10.10.10', 9292)
+    discovery = Concurrent::Atom.new({'pid' => 0})
+
+    subject = Instana::Backend::HostAgentReportingObserver.new(client, discovery, timer_class: MockTimer)
+
+    subject.report_timer.block.call
+  ensure
+    ::Instana.config[:metrics][:thread][:enabled] = true
+  end
+
   def test_disable_tracing
     ::Instana.config[:tracing][:enabled] = false
 

data/test/backend/process_info_test.rb

@@ -60,4 +60,24 @@ class ProcessInfoTest < Minitest::Test
       assert_equal subject.sched_pid, subject.parent_pid
     end
   end
+
+  def test_osx_memory_used
+    host_os = RbConfig::CONFIG['host_os']
+    RbConfig::CONFIG['host_os'] = 'darwin'
+
+    subject = Instana::Backend::ProcessInfo.new(OpenStruct.new(rss: 1024))
+    assert_equal 1, subject.memory_used
+  ensure
+    RbConfig::CONFIG['host_os'] = host_os
+  end
+
+  def test_linux_memory_used
+    host_os = RbConfig::CONFIG['host_os']
+    RbConfig::CONFIG['host_os'] = 'linux'
+
+    subject = Instana::Backend::ProcessInfo.new(OpenStruct.new(rss: 1))
+    assert_equal 4096, subject.memory_used
+  ensure
+    RbConfig::CONFIG['host_os'] = host_os
+  end
 end

data/test/instrumentation/rails_active_record_test.rb

@@ -38,8 +38,6 @@ class RailsActiveRecordTest < Minitest::Test
     data = span[:data][:activerecord]
 
     assert data[:sql].start_with?('INSERT INTO')
-    assert 'core', data[:binds][0]
-    assert 'blue', data[:binds][1]
   end
 
   def test_read
@@ -54,8 +52,6 @@ class RailsActiveRecordTest < Minitest::Test
     data = span[:data][:activerecord]
 
     assert data[:sql].start_with?('SELECT')
-    assert 'core', data[:binds][0]
-    assert 1, data[:binds][1]
   end
 
   def test_update
@@ -73,8 +69,6 @@ class RailsActiveRecordTest < Minitest::Test
     data = span[:data][:activerecord]
 
     assert data[:sql].start_with?('UPDATE')
-    assert 'red', data[:binds][0]
-    assert 1, data[:binds][2]
   end
 
   def test_delete
@@ -90,7 +84,6 @@ class RailsActiveRecordTest < Minitest::Test
     data = span[:data][:activerecord]
 
     assert data[:sql].start_with?('DELETE')
-    assert 1, data[:binds][0]
   end
 
   def test_raw

data/test/support/apps/resque/jobs/resque_error_job.rb

@@ -10,8 +10,6 @@ class ErrorJob
   def self.perform
     if ENV.key?('REDIS_URL')
       redis = Redis.new(:url => ENV['REDIS_URL'])
-    elsif ENV.key?('REDIS_URL')
-      redis = Redis.new(:url => ENV['REDIS_URL'])
     else
       redis = Redis.new(:url => 'localhost:6379')
     end
@@ -20,6 +18,5 @@ class ErrorJob
     redis.set('ts', dt)
 
     raise Exception.new("Silly Rabbit, Trix are for kids.")
-    redis.set(:nb_id, 2)
   end
 end

data/test/support/apps/resque/jobs/resque_fast_job.rb

@@ -12,8 +12,6 @@ class FastJob
 
     if ENV.key?('REDIS_URL')
       redis = Redis.new(:url => ENV['REDIS_URL'])
-    elsif ENV.key?('REDIS_URL')
-      redis = Redis.new(:url => ENV['REDIS_URL'])
     else
       redis = Redis.new(:url => 'redis://localhost:6379')
     end

data/test/tracing/custom_test.rb

@@ -111,7 +111,6 @@ class CustomTracingTest < Minitest::Test
 
       ::Instana.tracer.log_entry(:custom_span, kvs)
       raise "custom tracing error.  This is only a test"
-      ::Instana.tracer.log_info({:on_info_kv => 1})
     rescue => e
       ::Instana.tracer.log_error(e)
     ensure

data/test/tracing/span_test.rb

@@ -133,4 +133,21 @@ class SpanTest < Minitest::Test
     assert_equal({}, span.tags)
     time.verify
   end
+
+  def test_inc_processed_counts
+    clear_all!
+
+    span = Instana::Span.new(:excon)
+    span.close
+
+    metrics = Instana.processor.span_metrics
+
+    assert_equal 1, metrics[:opened]
+    assert_equal 1, metrics[:closed]
+
+    metrics = Instana.processor.span_metrics
+
+    assert_equal 0, metrics[:opened]
+    assert_equal 0, metrics[:closed]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.204.0.pre3
+  version: 1.207.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -275,6 +275,7 @@ files:
 - lib/instana/version.rb
 - lib/opentracing.rb
 - log/.keep
+- sonar-project.properties
 - test/activator_test.rb
 - test/backend/agent_test.rb
 - test/backend/gc_snapshot_test.rb
@@ -370,9 +371,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: