instana 1.209.5 → 1.209.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d6046b9ecf69be7ee6dbc4db6922d10cd731c10e6a9439cab442856fe169e5d
-  data.tar.gz: f5a2a1c8a7d011bc9a1abc3da001f3f8adf91407bf54724728f85590aff77940
+  metadata.gz: 7ad727e388d233521b7837cfc0157cd6b5af54f307529ad5e58207894d6863de
+  data.tar.gz: 9fb40e5a5769d996195f076475c2ef5d67182e245e549cf14970dcc0779d6014
 SHA512:
-  metadata.gz: 19d223cebc5f38a3dd552eb7c188c51f815c2e340d83c0e214a748c1a464e9ff6488967ae583a6efba1a1552dc5249872c3993b2fb56e175ae399993301051d6
-  data.tar.gz: bc5dc0521fdc266c6e6f82559335a445f8c7e186b9405bfac93f5ceb028470405abad4a95391e3fea9864b413c3e1c6a16c43f06b3555a007bfe752893e67732
+  metadata.gz: 0f9e58d31701ffd88af39ff5ac25e7c87a443153122a63b6e319e04c545d3926318d4c5862b8a628a215325f6f873d26852eb426440ceaa19746c4c80e9d19e6
+  data.tar.gz: d83ea081e9721634bcbf0aff97b1fc67f78fdcfabe52bfbeda95f20fc144c017e16d137f74d02a54f9a0adbb028916c5a62596b7af2a7cb51a80880d0fc79f99

data/.circleci/config.yml

@@ -186,10 +186,12 @@ workflows:
               gemfile:
                 - "./gemfiles/aws_30.gemfile"
                 - "./gemfiles/cuba_30.gemfile"
+                - "./gemfiles/cuba_40.gemfile"
                 - "./gemfiles/dalli_20.gemfile"
                 - "./gemfiles/excon_02.gemfile"
                 - "./gemfiles/excon_079.gemfile"
                 - "./gemfiles/graphql_10.gemfile"
+                - "./gemfiles/graphql_20.gemfile"
                 - "./gemfiles/grpc_10.gemfile"
                 - "./gemfiles/net_http_01.gemfile"
                 - "./gemfiles/rack_16.gemfile"

data/README.md

@@ -4,25 +4,15 @@
 
 # Instana
 
-The Instana gem provides Ruby metrics and traces (request, queue & cross-host) for [Instana](https://www.instana.com/).
+The `instana` gem provides Ruby metrics and traces (request, queue & cross-host) for [Instana](https://www.instana.com/).
 
-[![CircleCI](https://circleci.com/gh/instana/ruby-sensor.svg?style=svg)](https://circleci.com/gh/instana/ruby-sensor)
-[![Gem Version](https://badge.fury.io/rb/instana.svg)](https://badge.fury.io/rb/instana)
-
-## Note
-
-This gem supports Ruby versions 2.0 or greater.
+This gem supports Ruby versions 2.7 or greater.
 
 Any and all feedback is welcome.  Happy Ruby visibility.
 
-[![rails](https://s3.amazonaws.com/instana/rails-logo.jpg?1)](http://rubyonrails.org/)
-[![roda](https://s3.amazonaws.com/instana/roda-logo.png?1)](http://roda.jeremyevans.net/)
-[![cuba](https://s3.amazonaws.com/instana/cuba-logo.png?1)](http://cuba.is/)
-[![mina logo 100px](https://cloud.githubusercontent.com/assets/395132/23832558/fcd5bdb2-0736-11e7-9809-3016e89698e2.png)](https://github.com/instana/mina-instana)
-[![sinatra](https://s3.amazonaws.com/instana/sinatra-logo.png?1)](http://www.sinatrarb.com/)
-[![padrino](https://s3.amazonaws.com/instana/padrino-logo.png?1)](http://padrinorb.com/)
-[![rack](https://s3.amazonaws.com/instana/rack-logo.png?1)](https://rack.github.io/)
-[![rack](https://user-images.githubusercontent.com/395132/27842764-27e0e452-610d-11e7-811f-8575f83b8944.png?1)](http://www.grpc.io/)
+[![Gem Version](https://badge.fury.io/rb/instana.svg)](https://badge.fury.io/rb/instana)
+[![CircleCI](https://circleci.com/gh/instana/ruby-sensor.svg?style=svg)](https://circleci.com/gh/instana/ruby-sensor)
+[![OpenTracing Badge](https://img.shields.io/badge/OpenTracing-enabled-blue.svg)](http://opentracing.io)
 
 ## Installation
 
@@ -42,7 +32,17 @@ Or install it yourself as:
 
 ## Usage
 
-The instana gem is a zero configuration tool that will automatically collect key metrics and distributed traces from your Ruby processes.  Just install and go.
+The `instana` gem is a zero configuration tool that will automatically collect key metrics and distributed traces from your Ruby processes.  Just install and go.
+
+### Supported Frameworks
+
+* [Cuba](https://cuba.is/)
+* [gRPC](https://grpc.io/)
+* [Padrino](https://padrinorb.com/)
+* [Roda](https://roda.jeremyevans.net/)
+* [Ruby on Rails](https://rubyonrails.org/)
+* [Rack](https://rack.github.io/)
+* [Sinatra](https://sinatrarb.com/)
 
 ## Configuration
 
@@ -56,7 +56,7 @@ This Ruby gem provides a simple API for tracing and also supports [OpenTracing](
 
 You can find more documentation covering supported components and minimum versions in the Instana [documentation portal](https://docs.instana.io/ecosystem/ruby/).
 
-# Want End User Monitoring (EUM)?
+## Want End User Monitoring (EUM)?
 
 Instana provides deep end user monitoring that links server side traces with browser events to give you a complete view from server to browser.
 

data/gemfiles/cuba_40.gemfile

@@ -0,0 +1,16 @@
+# (c) Copyright IBM Corp. 2023
+
+source "https://rubygems.org"
+
+gem "rack", ">=3.0.0"
+gem "rake"
+gem "minitest", "5.9.1"
+gem "minitest-reporters"
+gem "webmock"
+gem "puma"
+gem "rubocop", "~> 1.9"
+gem "rack-test"
+gem "simplecov", "~> 0.21.2"
+gem "cuba", ">= 4.0.1"
+
+gemspec path: "../"

data/gemfiles/graphql_20.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "minitest", "5.9.1"
+gem "minitest-reporters"
+gem "webmock"
+gem "puma"
+gem "rubocop", "~> 1.9"
+gem "rack-test"
+gem "simplecov", "~> 0.21.2"
+gem "graphql", ">= 2.0.21", "< 3.0"
+
+gemspec path: "../"

data/lib/instana/activators/sidekiq_client.rb

@@ -5,7 +5,8 @@ module Instana
   module Activators
     class SidekiqClient < Activator
       def can_instrument?
-        defined?(::Sidekiq) && ::Sidekiq.respond_to?(:configure_client) && ::Instana.config[:'sidekiq-client'][:enabled]
+        defined?(::Sidekiq) && ::Sidekiq.respond_to?(:configure_client) && ::Instana.config[:'sidekiq-client'][:enabled] &&
+          Gem::Specification.find_by_name('sidekiq').version < Gem::Version.new('5.3')
       end
 
       def instrument

data/lib/instana/activators/sidekiq_worker.rb

@@ -5,7 +5,8 @@ module Instana
   module Activators
     class SidekiqWorker < Activator
       def can_instrument?
-        defined?(::Sidekiq) && ::Sidekiq.respond_to?(:configure_server) && ::Instana.config[:'sidekiq-worker'][:enabled]
+        defined?(::Sidekiq) && ::Sidekiq.respond_to?(:configure_server) && ::Instana.config[:'sidekiq-worker'][:enabled] &&
+          Gem::Specification.find_by_name('sidekiq').version < Gem::Version.new('5.3')
       end
 
       def instrument

data/lib/instana/backend/process_info.rb

@@ -18,7 +18,7 @@ module Instana
       end
 
       def parent_pid
-        if in_container? && sched_pid != pid
+        if in_container? && !sched_pid.nil?
           sched_pid
         else
           pid

data/lib/instana/config.rb

@@ -53,8 +53,8 @@ module Instana
       # ::Instana.config[:sanitize_sql] = false
       @config[:sanitize_sql] = true
 
-      # W3 Trace Context Support
-      @config[:w3_trace_correlation] = ENV['INSTANA_DISABLE_W3C_TRACE_CORRELATION'].nil?
+      # W3C Trace Context Support
+      @config[:w3c_trace_correlation] = ENV['INSTANA_DISABLE_W3C_TRACE_CORRELATION'].nil?
 
       @config[:post_fork_proc] = proc { ::Instana.agent.spawn_background_thread }
 

data/lib/instana/instrumentation/instrumented_request.rb

@@ -9,7 +9,7 @@ require 'rack/request'
 
 module Instana
   class InstrumentedRequest < Rack::Request
-    W3_TRACE_PARENT_FORMAT = /00-(?<trace>[0-9a-f]+)-(?<parent>[0-9a-f]+)-(?<flags>[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})/.freeze
     INSTANA_TRACE_STATE = /in=(?<trace>[0-9a-f]+);(?<span>[0-9a-f]+)/.freeze
 
     def skip_trace?
@@ -32,16 +32,16 @@ module Instana
 
       context[:level] = @env['HTTP_X_INSTANA_L'][0] if @env['HTTP_X_INSTANA_L']
 
-      unless ::Instana.config[:w3_trace_correlation]
+      unless ::Instana.config[:w3c_trace_correlation]
         trace_state = parse_trace_state
 
-        if context[:from_w3] && trace_state.empty?
+        if context[:from_w3c] && trace_state.empty?
           context.delete(:span_id)
-          context[:from_w3] = false
-        elsif context[:from_w3] && !trace_state.empty?
+          context[:from_w3c] = false
+        elsif context[:from_w3c] && !trace_state.empty?
           context[:trace_id] = trace_state[:t]
           context[:span_id] = trace_state[:p]
-          context[:from_w3] = false
+          context[:from_w3c] = false
         end
       end
 
@@ -86,7 +86,7 @@ module Instana
     end
 
     def continuing_from_trace_parent?
-      incoming_context[:from_w3]
+      incoming_context[:from_w3c]
     end
 
     def synthetic?
@@ -122,13 +122,13 @@ module Instana
         long_instana_id: long_instana_id? ? sanitized_t : nil,
         external_trace_id: external_trace_id,
         external_state: @env['HTTP_TRACESTATE'],
-        from_w3: false
+        from_w3c: false
       }.reject { |_, v| v.nil? }
     end
 
     def context_from_trace_parent
       return {} unless @env.has_key?('HTTP_TRACEPARENT')
-      matches = @env['HTTP_TRACEPARENT'].match(W3_TRACE_PARENT_FORMAT)
+      matches = @env['HTTP_TRACEPARENT'].match(W3C_TRACE_PARENT_FORMAT)
       return {} unless matches
       return {} if matches_is_invalid(matches)
 
@@ -140,7 +140,7 @@ module Instana
         external_state: @env['HTTP_TRACESTATE'],
         trace_id: trace_id,
         span_id: span_id,
-        from_w3: true
+        from_w3c: true
       }
     end
 
@@ -154,7 +154,7 @@ module Instana
       {
         trace_id: state[:t],
         span_id: state[:p],
-        from_w3: false
+        from_w3c: false
       }.reject { |_, v| v.nil? }
     end
 

data/lib/instana/version.rb

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

data/test/frameworks/cuba_test.rb

@@ -6,7 +6,10 @@ require 'rack/test'
 
 class CubaTest < Minitest::Test
   include Rack::Test::Methods
-  APP = Rack::Builder.parse_file('test/support/apps/cuba/config.ru').first
+
+  # rack < 3.0.0 returns a two long array `app, options`
+  # rack >= 3.0.0 returns only the app
+  APP, *  = Rack::Builder.parse_file('test/support/apps/cuba/config.ru')
 
   def app
     APP

data/test/instrumentation/rack_instrumented_request_test.rb

@@ -4,7 +4,15 @@
 require 'test_helper'
 
 class RackInstrumentedRequestTest < Minitest::Test
-  def test_skip_trace_with_header
+  def test_suppression_via_x_instana_l
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '0'
+    )
+
+    assert req.skip_trace?
+  end
+
+  def test_suppression_via_x_instana_l_with_trailing_content
     req = Instana::InstrumentedRequest.new(
       'HTTP_X_INSTANA_L' => '0;sample-data'
     )
@@ -12,6 +20,20 @@ class RackInstrumentedRequestTest < Minitest::Test
     assert req.skip_trace?
   end
 
+  def test_no_suppression_assume_level_1_as_default
+    req = Instana::InstrumentedRequest.new({})
+
+    assert !req.skip_trace?
+  end
+
+  def test_no_suppression_when_x_instana_l_is_provided_explicitly
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '1'
+    )
+
+    assert !req.skip_trace?
+  end
+
   def test_skip_trace_without_header
     req = Instana::InstrumentedRequest.new({})
 
@@ -29,7 +51,7 @@ class RackInstrumentedRequestTest < Minitest::Test
     expected = {
       trace_id: id,
       span_id: id,
-      from_w3: false,
+      from_w3c: false,
       level: '1'
     }
 
@@ -37,9 +59,8 @@ class RackInstrumentedRequestTest < Minitest::Test
     refute req.continuing_from_trace_parent?
   end
 
-  def test_incoming_w3_content
+  def test_incoming_w3c_context
     req = Instana::InstrumentedRequest.new(
-      'HTTP_X_INSTANA_L' => '1',
       'HTTP_TRACEPARENT' => '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
     )
 
@@ -48,42 +69,81 @@ class RackInstrumentedRequestTest < Minitest::Test
       external_state: nil,
       trace_id: 'a3ce929d0e0e4736',
       span_id: '00f067aa0ba902b7',
-      from_w3: true,
-      level: '1'
+      from_w3c: true
     }
 
     assert_equal expected, req.incoming_context
     assert req.continuing_from_trace_parent?
   end
 
-  def test_incoming_w3_content_invalid_id
+  def test_incoming_w3c_context_newer_version_additional_fields
     req = Instana::InstrumentedRequest.new(
-      'HTTP_X_INSTANA_L' => '1',
-      'HTTP_TRACEPARENT' => '00-00000000000000000000000000000000-0000000000000000-01'
+      'HTTP_TRACEPARENT' => 'fe-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01-abcdefg'
     )
 
     expected = {
-      level: '1'
+      external_trace_id: '4bf92f3577b34da6a3ce929d0e0e4736',
+      external_state: nil,
+      trace_id: 'a3ce929d0e0e4736',
+      span_id: '00f067aa0ba902b7',
+      from_w3c: true
     }
 
     assert_equal expected, req.incoming_context
-    refute req.continuing_from_trace_parent?
+    assert req.continuing_from_trace_parent?
   end
 
-  def test_incoming_invalid_w3_content
+  def test_incoming_w3c_context_unknown_flags
     req = Instana::InstrumentedRequest.new(
-      'HTTP_X_INSTANA_L' => '1',
-      'HTTP_TRACEPARENT' => '00-XXa3ce929d0e0e4736-00f67aa0ba902b7-01'
+      'HTTP_TRACEPARENT' => '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-ff'
     )
 
     expected = {
-      level: '1'
+      external_trace_id: '4bf92f3577b34da6a3ce929d0e0e4736',
+      external_state: nil,
+      trace_id: 'a3ce929d0e0e4736',
+      span_id: '00f067aa0ba902b7',
+      from_w3c: true
     }
 
     assert_equal expected, req.incoming_context
+    assert req.continuing_from_trace_parent?
+  end
+
+  def test_incoming_w3c_context_invalid_version
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_TRACEPARENT' => 'ff-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
+    )
+
+    expected = {}
+
+    assert_equal expected, req.incoming_context
+    refute req.continuing_from_trace_parent?
+  end
+
+  def test_incoming_w3c_context_invalid_id
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_TRACEPARENT' => '00-00000000000000000000000000000000-0000000000000000-01'
+    )
+
+    expected = {}
+
+    assert_equal expected, req.incoming_context
+    refute req.continuing_from_trace_parent?
+  end
+
+  def test_incoming_invalid_w3c_context
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_TRACEPARENT' => '00-XXa3ce929d0e0e4736-00f67aa0ba902b7-01'
+    )
+
+    expected = {}
+
+    assert_equal expected, req.incoming_context
+    refute req.continuing_from_trace_parent?
   end
 
-  def test_incoming_w3_state
+  def test_incoming_w3c_state
     req = Instana::InstrumentedRequest.new(
       'HTTP_TRACESTATE' => 'a=12345,in=123;abe,c=[+]'
     )

data/test/instrumentation/rack_test.rb

@@ -69,7 +69,7 @@ class RackTest < Minitest::Test
     assert last_response.headers.key?("Server-Timing")
     assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
 
-    # W3 Trace Context
+    # W3C Trace Context
     assert_equal "00-#{rack_span[:t].rjust(32, '0')}-#{rack_span[:s]}-01", last_response.headers["Traceparent"]
     assert_equal "in=#{rack_span[:t]};#{rack_span[:s]}", last_response.headers["Tracestate"]
 
@@ -301,7 +301,7 @@ class RackTest < Minitest::Test
     assert_equal true, first_span[:sy]
   end
 
-  def test_basic_get_with_w3_trace
+  def test_basic_get_with_w3c_trace
     clear_all!
 
     header 'TRACEPARENT', '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
@@ -321,9 +321,9 @@ class RackTest < Minitest::Test
     assert first_span[:tp]
   end
 
-  def test_basic_get_with_w3_disabled
+  def test_basic_get_with_w3c_disabled
     clear_all!
-    ::Instana.config[:w3_trace_correlation] = false
+    ::Instana.config[:w3c_trace_correlation] = false
 
     header 'TRACEPARENT', '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
 
@@ -336,7 +336,7 @@ class RackTest < Minitest::Test
     first_span = spans.first
     assert_equal :rack, first_span[:n]
     refute first_span[:tp]
-    ::Instana.config[:w3_trace_correlation] = true
+    ::Instana.config[:w3c_trace_correlation] = true
   end
 
   def test_skip_trace

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.209.5
+  version: 1.209.7
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,11 +157,13 @@ files:
 - gemfiles/.bundle/config
 - gemfiles/aws_30.gemfile
 - gemfiles/cuba_30.gemfile
+- gemfiles/cuba_40.gemfile
 - gemfiles/dalli_20.gemfile
 - gemfiles/excon_02.gemfile
 - gemfiles/excon_021.gemfile
 - gemfiles/excon_079.gemfile
 - gemfiles/graphql_10.gemfile
+- gemfiles/graphql_20.gemfile
 - gemfiles/grpc_10.gemfile
 - gemfiles/mongo_216.gemfile
 - gemfiles/net_http_01.gemfile
@@ -382,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Ruby Distributed Tracing & Metrics Sensor for Instana