instana 1.209.2 → 1.209.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e62881ca493d4515cd39055d633464d33c1cd3e1b8921fcd63861bdfa4ebc258
-  data.tar.gz: fe6c75eef3bb9905c576fd50b47e7b67141b3d8c13ef9b225a801a353c87908a
+  metadata.gz: 1ba4c4719f68be4f2764f82f2880f37a9a121ced7957ea2660383e6eb37745a6
+  data.tar.gz: bbbc69a3de73ff922b33d67e5d11cb469518f7664636df4335b3ef7a903bc9af
 SHA512:
-  metadata.gz: 355994cc5dd31bf028a775dde54d49dcb62c6e83818747ace59fe8038d5b51438cb03b09973845e40ba53b8ca6a73c1a1c281a99cf3c22afab1209d1cb58db00
-  data.tar.gz: aa834ff80928730a5b267ebe840d6bc98a2ef41b240064f69301ef45def873a2271057e1a3d4d280b57a760294acb84ddc9b1f83177fac59bb1b711b4135fcd6
+  metadata.gz: 9facbe9690a6bb7ef461b8e56def7a74fa1b31d8349ecb7baf1d385d23213cc29800499126e71dc2090e0261874cf6de27aae3301bbebe36486259dd0b13a0f8
+  data.tar.gz: 4f962781ce7204792bddf1d9c8730c089511207dee880aecf68a17c7e3185f83a713639eade5b33e10d7bd99f7d52a151e95cc685143e0d50e262674d23670fa

data/.circleci/config.yml

@@ -3,37 +3,37 @@ version: 2.1
 executors:
   ruby_26:
     docker:
-      - image: circleci/ruby:2.6-node
+      - image: cimg/ruby:2.6-node
         environment:
           MEMCACHED_HOST: '127.0.0.1:11211'
           REDIS_URL: 'redis://127.0.0.1:6379'
           DATABASE_URL: 'sqlite3::memory:'
       - image: memcached
       - image: redis
-      - image: circleci/dynamodb
+      - image: amazon/dynamodb-local
       - image: minio/minio:latest
         command: ["server", "/data"]
       - image: s12v/sns
       - image: softwaremill/elasticmq-native
-      - image: circleci/mongo:5-focal-ram
+      - image: mongo:5-focal
   ruby_27:
     docker:
-      - image: circleci/ruby:2.7-node
+      - image: cimg/ruby:2.7-node
         environment:
           MEMCACHED_HOST: '127.0.0.1:11211'
           REDIS_URL: 'redis://127.0.0.1:6379'
           DATABASE_URL: 'sqlite3::memory:'
       - image: memcached
       - image: redis
-      - image: circleci/dynamodb
+      - image: amazon/dynamodb-local
       - image: minio/minio:latest
         command: ["server", "/data"]
       - image: s12v/sns
       - image: softwaremill/elasticmq-native
-      - image: circleci/mongo:5-focal-ram
+      - image: mongo:5-focal
   ruby_26_mysql2:
     docker:
-      - image: circleci/ruby:2.6-node
+      - image: cimg/ruby:2.6-node
         environment:
           DATABASE_URL: "mysql2://root@127.0.0.1:3306/ci_test"
       - image: mariadb
@@ -46,7 +46,7 @@ executors:
           MYSQL_ROOT_HOST: '%'
   ruby_27_mysql2:
     docker:
-      - image: circleci/ruby:2.7-node
+      - image: cimg/ruby:2.7-node
         environment:
           DATABASE_URL: "mysql2://root@127.0.0.1:3306/ci_test"
       - image: mariadb
@@ -59,7 +59,7 @@ executors:
           MYSQL_ROOT_HOST: '%'
   ruby_26_postgres:
     docker:
-      - image: circleci/ruby:2.6-node
+      - image: cimg/ruby:2.6-node
         environment:
           DATABASE_URL: "postgres://postgres:test@127.0.0.1:5432/ci_test"
       - image: postgres
@@ -68,7 +68,7 @@ executors:
           POSTGRES_DB: 'ci_test'
   ruby_27_postgres:
     docker:
-      - image: circleci/ruby:2.7-node
+      - image: cimg/ruby:2.7-node
         environment:
           DATABASE_URL: "postgres://postgres:test@127.0.0.1:5432/ci_test"
       - image: postgres

data/.github/ISSUE_TEMPLATE/config.yml

@@ -3,3 +3,6 @@ contact_links:
   - name: Instana Support Portal
     url: https://support.instana.com
     about: Please ask questions related to your installation there. 
+  - name: Feature Requests
+    url: https://automation-management.ideas.ibm.com/?project=INSTANA
+    about: Please file feature requests there (or search for existing requests and vote for them). Do not use Github issues for feature requests.

data/.github/workflows/pr_commits_signed_off.yml

@@ -0,0 +1,16 @@
+name: Find signed commits
+on:
+  pull_request_target:
+    branches:
+      - master # or the name of your main branch
+jobs:
+  check-sign-off:
+    name: Write comment if unsigned commits found
+    env:
+      FORCE_COLOR: 1
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: live627/check-pr-signoff-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

data/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+## Contributing In General
+Our project welcomes external contributions. If you have an itch, please feel
+free to scratch it.
+
+To contribute code or documentation, please submit a [pull request](https://github.com/instana/ruby-sensor/pulls).
+
+A good way to familiarize yourself with the codebase and contribution process is
+to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/instana/ruby-sensor/issues).
+<!--Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.-->
+
+**Note: We appreciate your effort, and want to avoid a situation where a contribution
+requires extensive rework (by you or by us), sits in backlog for a long time, or
+cannot be accepted at all!**
+
+### Proposing new features
+
+If you would like to implement a new feature, please [raise an issue](https://github.com/instana/ruby-sensor/issues)
+before sending a pull request so the feature can be discussed. This is to avoid
+you wasting your valuable time working on a feature that the project developers
+are not interested in accepting into the code base.
+
+### Fixing bugs
+
+If you would like to fix a bug, please [raise an issue](https://github.com/instana/ruby-sensor/issues) before sending a
+pull request so it can be tracked.
+
+### Merge approval
+
+The project maintainers use LGTM (Looks Good To Me) in comments on the code
+review to indicate acceptance. A change requires LGTMs from two of the
+maintainers of each component affected.
+
+For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
+
+## Legal
+
+Each source file must include a license header for the MIT
+License. Using the SPDX format is the simplest approach.
+e.g.
+
+```
+/*
+Copyright <holder> All Rights Reserved.
+
+SPDX-License-Identifier: MIT
+*/
+```
+
+We have tried to make it as easy as possible to make contributions. This
+applies to how we handle the legal aspects of contribution. We use the
+same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin)
+uses to manage code contributions.
+
+We simply ask that when submitting a patch for review, the developer
+must include a sign-off statement in the commit message.
+
+Here is an example Signed-off-by line, which indicates that the
+submitter accepts the DCO:
+
+```
+Signed-off-by: John Doe <john.doe@example.com>
+```
+
+You can include this automatically when you commit a change to your
+local git repository using the following command:
+
+```
+git commit -s
+```
+
+<!--
+## Communication
+**FIXME** Please feel free to connect with us on our [Slack channel](link).
+
+## Setup
+**FIXME** Please add any special setup instructions for your project to help the developer
+become productive quickly.
+
+## Testing
+**FIXME** Please provide information that helps the developer test any changes they make
+before submitting.
+
+## Coding style guidelines
+**FIXME** Optional, but recommended: please share any specific style guidelines you might
+have for your project.
+-->

data/Gemfile

@@ -13,7 +13,10 @@ gem 'rubocop', '~> 1.9'
 
 # Rack v2 dropped support for Ruby 2.2 and higher.
 if RUBY_VERSION < '2.2'
-  gem 'rack', '~> 1.6'
+  gem 'rack', '<3.0.0', '~> 1.6'
+else
+  gem 'rack', '<3.0.0'
+  # gem 'rackup'
 end
 gem 'rack-test'
 

data/MAINTAINERS.md

@@ -0,0 +1,3 @@
+# MAINTAINERS
+
+[instana/eng-ruby](https://github.com/orgs/instana/teams/eng-ruby) can be reached with @instana/eng-ruby

data/gemfiles/cuba_30.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/gemfiles/excon_02.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/gemfiles/excon_079.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/gemfiles/net_http_01.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/gemfiles/rails_50.gemfile

@@ -13,6 +13,7 @@ gem "puma"
 gem "rubocop", "~> 1.9"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
+gem "mail", "< 2.8.0"
 gem "rails", ">= 5.0", "< 5.1"
 gem "mysql2", "0.4.10"
 gem "pg"

data/gemfiles/rails_52.gemfile

@@ -13,6 +13,7 @@ gem "puma"
 gem "rubocop", "~> 1.9"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
+gem "mail", "< 2.8.0"
 gem "rails", ">= 5.2", "< 6.0"
 gem "mysql2", "0.4.10"
 gem "pg"

data/gemfiles/rails_60.gemfile

@@ -13,6 +13,7 @@ gem "puma"
 gem "rubocop", "~> 1.9"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
+gem "mail", "< 2.8.0"
 gem "rails", ">= 6.0", "< 6.1"
 gem "mysql2", "0.4.10"
 gem "pg"

data/gemfiles/resque_20.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "redis", "< 5.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"
@@ -13,6 +14,6 @@ gem "puma"
 gem "rubocop", "~> 1.9"
 gem "rack-test"
 gem "simplecov", "~> 0.21.2"
-gem "resque", ">= 2.0", "< 3.0"
+gem "resque", ">= 2.0", "< 2.3.0"
 
 gemspec path: "../"

data/gemfiles/rest_client_16.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/gemfiles/rest_client_20.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/gemfiles/roda_20.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/gemfiles/roda_30.gemfile

@@ -5,6 +5,7 @@
 
 source "https://rubygems.org"
 
+gem "rack", "<3.0.0"
 gem "rake"
 gem "minitest", "5.9.1"
 gem "minitest-reporters"

data/lib/instana/backend/host_agent.rb

@@ -52,9 +52,15 @@ module Instana
         }.reject { |_, v| v.nil? }
       end
 
-      # @return [Array] extra headers to include in the trace
+      # @return [Array] extra headers to capture with HTTP spans
       def extra_headers
-        discovery_value['extraHeaders']
+        if discovery_value['tracing']
+          # Starting with discovery version 1.6.4, this value is in tracing.extra-http-headers.
+          discovery_value['tracing']['extra-http-headers']
+        else
+          # Legacy fallback for discovery versions <= 1.6.3.
+          discovery_value['extraHeaders']
+        end
       end
 
       # @return [Hash] values which are removed from urls sent to the backend

data/lib/instana/instrumentation/rack.rb

@@ -13,8 +13,7 @@ module Instana
     def call(env)
       req = InstrumentedRequest.new(env)
       kvs = {
-        http: req.request_tags,
-        service: ENV['INSTANA_SERVICE_NAME']
+        http: req.request_tags
       }.reject { |_, v| v.nil? }
 
       current_span = ::Instana.tracer.log_start_or_continue(:rack, {}, req.incoming_context)

data/lib/instana/instrumentation/resque.rb

@@ -69,9 +69,6 @@ module Instana
         kvs[:'resque-worker'] = {}
 
         begin
-          if ENV.key?('INSTANA_SERVICE_NAME')
-            kvs[:service] = ENV['INSTANA_SERVICE_NAME']
-          end
           kvs[:'resque-worker'][:job] = job.payload['class'].to_s
           kvs[:'resque-worker'][:queue] = job.queue
         rescue => e

data/lib/instana/instrumentation/shoryuken.rb

@@ -21,9 +21,9 @@ module Instana
       private
 
       def incomming_context_from(attributes)
-        trace_id = try(attributes, 'X_INSTANA_T', 'X_INSTANA_ST')
-        span_id = try(attributes, 'X_INSTANA_S', 'X_INSTANA_SS')
-        level = try(attributes, 'X_INSTANA_L', 'X_INSTANA_SL')
+        trace_id = read_message_header(attributes, 'X_INSTANA_T')
+        span_id = read_message_header(attributes, 'X_INSTANA_S')
+        level = read_message_header(attributes, 'X_INSTANA_L')
 
         {
           trace_id: trace_id,
@@ -32,12 +32,8 @@ module Instana
         }.reject { |_, v| v.nil? }
       end
 
-      def try(attributes, *args)
-        key = args.detect do |a|
-          attributes && attributes[a] && attributes[a].respond_to?(:string_value)
-        end
-
-        attributes[key].string_value if attributes && key
+      def read_message_header(attributes, key)
+        attributes[key].string_value if attributes && attributes[key] && attributes[key].respond_to?(:string_value)
       end
     end
   end

data/lib/instana/instrumentation/sidekiq-worker.rb

@@ -18,10 +18,6 @@ module Instana
           kv_payload[:'sidekiq-worker'][:'redis-url'] = "#{opts[:host]}:#{opts[:port]}"
         end
 
-        if ENV.key?('INSTANA_SERVICE_NAME')
-          kv_payload[:service] = ENV['INSTANA_SERVICE_NAME']
-        end
-
         context = {}
         if msg.key?('X-Instana-T')
           trace_id = msg.delete('X-Instana-T')

data/lib/instana/tracer.rb

@@ -180,11 +180,7 @@ module Instana
       self.current_span.set_tags(kvs)
       self.current_span.close
 
-      if self.current_span.parent
-        self.current_span = self.current_span.parent
-      else
-        self.current_span = nil
-      end
+      self.current_span = self.current_span.parent || nil
     end
 
     # Closes out the current span in the current trace

data/lib/instana/tracing/span.rb

@@ -55,6 +55,10 @@ module Instana
 
       @data[:data] = {}
 
+      if ENV.key?('INSTANA_SERVICE_NAME')
+        @data[:data][:service] = ENV['INSTANA_SERVICE_NAME']
+      end
+
       # Entity Source
       @data[:f] = ::Instana.agent.source
       # Start time

data/lib/instana/version.rb

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

data/test/backend/host_agent_test.rb

@@ -45,6 +45,24 @@ class HostAgentTest < Minitest::Test
     assert_equal 1, subject.source[:e]
   end
 
+  def test_extra_headers_from_tracing_config
+    discovery = Concurrent::Atom.new(
+      {
+        'tracing' => {
+          'extra-http-headers' => ["X-Header-1", "X-Header-2"]
+        }
+      }
+    )
+    subject = Instana::Backend::HostAgent.new(discovery: discovery)
+    assert_equal ["X-Header-1", "X-Header-2"], subject.extra_headers
+  end
+
+  def test_extra_headers_legacy
+    discovery = Concurrent::Atom.new({'extraHeaders' => ["X-Header-3", "X-Header-4"]})
+    subject = Instana::Backend::HostAgent.new(discovery: discovery)
+    assert_equal ["X-Header-3", "X-Header-4"], subject.extra_headers
+  end
+
   def test_start
     subject = Instana::Backend::HostAgent.new
     assert subject.respond_to? :start

data/test/tracing/opentracing_test.rb

@@ -3,7 +3,13 @@
 
 require 'test_helper'
 require 'rack/test'
-require 'rack/lobster'
+
+if Rack.release >= '3.0.0'
+  require 'rackup/lobster'
+else
+  require 'rack/lobster'
+end
+
 require "opentracing"
 
 module Instana
@@ -45,7 +51,11 @@ class OpenTracerTest < Minitest::Test
       use Rack::ShowExceptions
       use Instana::OTRack2
       map "/mrlobster" do
-        run Rack::Lobster.new
+        if Rack.release >= '3.0.0'
+          run Rackup::Lobster.new
+        else
+          run Rack::Lobster.new
+        end
       end
     }
   end

data/test/tracing/span_test.rb

@@ -162,4 +162,18 @@ class SpanTest < Minitest::Test
     assert_equal 0, metrics[:opened]
     assert_equal 0, metrics[:closed]
   end
+
+  def test_custom_service_name_set
+    service_name = 'MyVeryCustomRubyServiceNameForInstanaTesting'
+    ENV['INSTANA_SERVICE_NAME'] = service_name
+    span = Instana::Span.new(:excon)
+    assert_equal(service_name, span[:data][:service])
+  ensure
+    ENV.delete('INSTANA_SERVICE_NAME')
+  end
+
+  def test_no_custom_service_name_set
+    span = Instana::Span.new(:excon)
+    assert_nil(span[:data][:service])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.209.2
+  version: 1.209.3
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,12 +137,15 @@ files:
 - ".fasterer.yml"
 - ".github/ISSUE_TEMPLATE/bug.yml"
 - ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/workflows/pr_commits_signed_off.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Appraisals
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- MAINTAINERS.md
 - README.md
 - Rakefile
 - bin/console
@@ -379,7 +382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Ruby Distributed Tracing & Metrics Sensor for Instana