opentracing-instrumentation 0.1.14 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0deff013f5e114188fd45e5babe206deb828806074e5d5cdb64d2d0bd12039b9
-  data.tar.gz: b9db37bc148a276e95f6b9b843c8524ac0fcb81b9a136aa9e95532f7d18f9d25
+  metadata.gz: 8879aaa3c59021d2ca28453df552f98e0d15b6770c12cf16aea578438e332013
+  data.tar.gz: '087834496d2097fe029aa460470651447f9d2bba325e95b3fd3a8cc873d137d4'
 SHA512:
-  metadata.gz: 7dac1db7d02ba70d447d2db46f28b31a2549e2d9636a9ead1013940af8e9338d5d75dfa6ce86a6d71b8eabbc26f17119be80b1110a9b0ccc3be8013f237b78a9
-  data.tar.gz: c604dfdd5b4f0e77f7bb5c29cc3a2c11e77540e6d8c69b901509af2f89c48575d6ff57cdc44d97e4f52ad4815a842684a16a723bfa874daa4ec9735fbc043e11
+  metadata.gz: c5c204ba373e323a0ac3ba96d1ba81a4be53ef537890304a30cb7f701ffc5ce0a989f5ac7eeb2b5c1850908d606d090dc61bff08f3ee49090a6d656b3071597d
+  data.tar.gz: fa54f0a639bf05536ba3d0fd0771c75497ba619dde142c8e1d5575fd5a782f0eb7ff0e33cc5148cd4338d6a526dc9893ade3d13c95e0f45455a00f93c0786862

data/.drone.jsonnet

@@ -1,6 +1,6 @@
 local TestPipeline(os, arch, ruby_version) = {
   kind: "pipeline",
-  type: "docker",
+  type: "kubernetes",
   name: os + "_" + arch + "_ruby_" + ruby_version,
 
   platform: {
@@ -14,7 +14,7 @@ local TestPipeline(os, arch, ruby_version) = {
       image: "ruby:" + ruby_version + "-alpine",
       commands: [
         "apk add --update git ruby-dev build-base",
-        "gem install bundler:2.1.4",
+        "gem install bundler:$$(cat .BUNDLER_VERSION)",
         "bundle",
         "rake",
       ]
@@ -23,10 +23,10 @@ local TestPipeline(os, arch, ruby_version) = {
 };
 
 local TARGETS = [
-  {os: "linux", arch: "arm64", ruby_version: "2.4"},
   {os: "linux", arch: "arm", ruby_version: "2.5"},
   {os: "linux", arch: "arm", ruby_version: "2.6"},
   {os: "linux", arch: "arm64", ruby_version: "2.7"},
+  {os: "linux", arch: "arm64", ruby_version: "3.0"},
 ];
 
 [

data/.gitlab-ci.yml

@@ -23,15 +23,6 @@ stages:
   script:
   - bundle exec rake
 
-test/2.4:
-  <<: *test_shared
-  stage: test
-  image: ruby:2.4-alpine
-
-  cache:
-    paths:
-    - vendor/ruby/2.4.0
-
 test/2.5:
   <<: *test_shared
   stage: test
@@ -59,6 +50,15 @@ test/2.7:
     paths:
     - vendor/ruby/2.7.0
 
+test/3.0:
+  <<: *test_shared
+  stage: test
+  image: ruby:3.0-alpine
+
+  cache:
+    paths:
+    - vendor/ruby/3.0.0
+
 publish:
   stage: publish
   image: ruby:2.7-alpine

data/.rubocop.yml

@@ -3,9 +3,15 @@ require:
   - rubocop-performance
   - rubocop-thread_safety
 
+AllCops:
+    NewCops: enable
+
 Layout/LineLength:
   Max: 100
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 18
+
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.5.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.2.0
+- Drop support ruby 2.4
+- Support ruby 3.0
+- Update rubocop and fix new warnings

data/GEM_VERSION

@@ -1 +1 @@
-0.1.14
+0.2.0

data/Gemfile

@@ -7,13 +7,13 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in opentracing-instrumentation.gemspec
 gemspec
 
-gem 'test-tracer',
-    github: 'michal-granec/ruby-test-tracer',
-    branch: 'update_opentracing_dependencies'
-gem 'tracing-matchers',
-    github: 'c0va23/ruby-tracing-matchers',
-    branch: 'feature/michal-granec/ruby-test-tracer-compatibility'
-
 group :development do
+  gem 'test-tracer',
+      github: 'michal-granec/ruby-test-tracer',
+      branch: 'update_opentracing_dependencies'
+  gem 'tracing-matchers',
+      github: 'c0va23/ruby-tracing-matchers',
+      branch: 'feature/michal-granec/ruby-test-tracer-compatibility'
+
   gem 'pry-byebug', '~> 3.8'
 end

data/Gemfile.lock

@@ -18,7 +18,7 @@ GIT
 PATH
   remote: .
   specs:
-    opentracing-instrumentation (0.1.14)
+    opentracing-instrumentation (0.1.18)
       json
       opentracing (~> 0.5.0)
 
@@ -31,7 +31,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     amq-protocol (2.3.0)
-    ast (2.4.0)
+    ast (2.4.2)
     bson (4.8.0)
     bunny (2.14.4)
       amq-protocol (~> 2.3, >= 2.3.0)
@@ -50,16 +50,15 @@ GEM
       multi_json (~> 1.12)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     json (2.3.0)
     method_source (0.9.2)
-    minitest (5.14.0)
+    minitest (5.14.4)
     multi_json (1.14.1)
     multipart-post (2.1.1)
     opentracing (0.5.0)
-    parallel (1.19.1)
-    parser (2.7.0.5)
-      ast (~> 2.4.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -70,7 +69,8 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     redis (3.3.5)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -84,26 +84,31 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.15.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
-    rubocop-thread_safety (0.3.4)
-      rubocop (>= 0.51.0)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    rubocop-thread_safety (0.4.2)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.11.0)
     thread_safe (0.3.6)
     thrift (0.11.0.0)
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -121,10 +126,10 @@ DEPENDENCIES
   rake (~> 13.0)
   redis (~> 3.3.5)
   rspec (~> 3.0)
-  rubocop (~> 0.80.0)
-  rubocop-performance (~> 1.5.2)
-  rubocop-rspec (~> 1.38.1)
-  rubocop-thread_safety (~> 0.3.4)
+  rubocop (~> 1.15.0)
+  rubocop-performance (~> 1.11.3)
+  rubocop-rspec (~> 2.3.0)
+  rubocop-thread_safety (~> 0.4.2)
   test-tracer!
   thrift (~> 0.11.0)
   tracing-matchers!

data/lib/opentracing/instrumentation/bunny.rb

@@ -10,27 +10,27 @@ module OpenTracing
       module_path = 'opentracing/instrumentation/bunny'
 
       autoload :ConsumeOperationNameBuilder,
-               module_path + '/consume_operation_name_builder'
+               "#{module_path}/consume_operation_name_builder"
       autoload :ConsumeTagsBuilder,
-               module_path + '/consume_tags_builder'
+               "#{module_path}/consume_tags_builder"
       autoload :ConsumeTracer,
-               module_path + '/consume_tracer'
+               "#{module_path}/consume_tracer"
       autoload :ConsumeTracerConfig,
-               module_path + '/consume_tracer_config'
+               "#{module_path}/consume_tracer_config"
       autoload :HeadersBuilder,
-               module_path + '/headers_builder'
+               "#{module_path}/headers_builder"
       autoload :HeadersInjector,
-               module_path + '/headers_injector'
+               "#{module_path}/headers_injector"
       autoload :PublishOperationNameBuilder,
-               module_path + '/publish_operation_name_builder'
+               "#{module_path}/publish_operation_name_builder"
       autoload :PublishTagsBuilder,
-               module_path + '/publish_tags_builder'
+               "#{module_path}/publish_tags_builder"
       autoload :PublishTracer,
-               module_path + '/publish_tracer'
+               "#{module_path}/publish_tracer"
       autoload :PublishTracerConfig,
-               module_path + '/publish_tracer_config'
+               "#{module_path}/publish_tracer_config"
       autoload :RegexpRoutingKeySanitazer,
-               module_path + '/regexp_routing_key_sanitazer'
+               "#{module_path}/regexp_routing_key_sanitazer"
     end
   end
 end

data/lib/opentracing/instrumentation/bunny/regexp_routing_key_sanitazer.rb

@@ -32,7 +32,7 @@ module OpenTracing
         def sanitaze_routing_key(routing_key)
           routing_key
             .split(ROUTING_KEY_SEPARATOR)
-            .map(&method(:filter_part))
+            .map { |part| filter_part(part) }
             .join(ROUTING_KEY_SEPARATOR)
         end
 

data/lib/opentracing/instrumentation/common.rb

@@ -8,6 +8,8 @@ module OpenTracing
     module Common
       autoload :ErrorWriter,
                'opentracing/instrumentation/common/error_writer'
+      autoload :OperationNameBuilder,
+               'opentracing/instrumentation/common/operation_name_builder'
     end
   end
 end

data/lib/opentracing/instrumentation/common/error_writer.rb

@@ -10,8 +10,8 @@ module OpenTracing
         LOG_ERROR_EVENT = 'error'
         ERROR_TAG = 'error'
 
-        attr_reader :set_error_tag
-        attr_reader :log_error_event
+        attr_reader :set_error_tag,
+                    :log_error_event
 
         # @param set_error_tag [TrueClass,ErrorClass] enable set error tag
         # @param log_error_event [TrueClass, ErrorClass] enable log exception
@@ -32,6 +32,11 @@ module OpenTracing
           log_error(span, exception, event)
         end
 
+        def ==(other)
+          set_error_tag == other.set_error_tag &&
+            log_error_event == other.log_error_event
+        end
+
         private
 
         def tag_error(span)

data/lib/opentracing/instrumentation/common/operation_name_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    module Common
+      # Build operation name by template and tags
+      class OperationNameBuilder
+        def initialize(operation_name_template:)
+          @operation_name_template = operation_name_template
+        end
+
+        # build operation name with tags
+        def build(tags)
+          format(operation_name_template, **tags)
+        end
+
+        private
+
+        attr_reader :operation_name_template
+      end
+    end
+  end
+end

data/lib/opentracing/instrumentation/faraday/response_logger.rb

@@ -20,10 +20,10 @@ module OpenTracing
           content_type: 'Content-Type',
         }.freeze
 
-        attr_reader :request_tag_headers
-        attr_reader :request_log_headers
-        attr_reader :response_tag_headers
-        attr_reader :response_log_headers
+        attr_reader :request_tag_headers,
+                    :request_log_headers,
+                    :response_tag_headers,
+                    :response_log_headers
 
         def initialize(
           request_log_headers: DEFAULT_REQUEST_LOG_HEADERS,

data/lib/opentracing/instrumentation/faraday/trace_middleware.rb

@@ -193,7 +193,7 @@ module OpenTracing
             event: 'error',
             message: error.message,
             'error.kind': error.class.to_s,
-            'stack': error.backtrace,
+            stack: error.backtrace,
           )
         end
       end

data/lib/opentracing/instrumentation/hutch.rb

@@ -12,17 +12,17 @@ module OpenTracing
       module_path = 'opentracing/instrumentation/hutch'
 
       autoload :ConsumeOperationNameBuilder,
-               module_path + '/consume_operation_name_builder'
+               "#{module_path}/consume_operation_name_builder"
       autoload :ConsumeTagsBuilder,
-               module_path + '/consume_tags_builder'
+               "#{module_path}/consume_tags_builder"
       autoload :ConsumeTracer,
-               module_path + '/consume_tracer'
+               "#{module_path}/consume_tracer"
       autoload :ConsumeTracerBuilder,
-               module_path + '/consume_tracer_builder'
+               "#{module_path}/consume_tracer_builder"
       autoload :ConsumeTracerConfig,
-               module_path + '/consume_tracer_config'
+               "#{module_path}/consume_tracer_config"
       autoload :GlobalPropertiesBuilder,
-               module_path + '/global_properties_builder'
+               "#{module_path}/global_properties_builder"
     end
   end
 end

data/lib/opentracing/instrumentation/mongo.rb

@@ -9,6 +9,8 @@ module OpenTracing
                'opentracing/instrumentation/mongo/operation_name_builder'
       autoload :TraceSubscriber, 'opentracing/instrumentation/mongo/trace_subscriber'
       autoload :QuerySanitazer, 'opentracing/instrumentation/mongo/query_sanitazer'
+      autoload :SampleSafetyArgumentChecker,
+               'opentracing/instrumentation/mongo/sample_safety_argument_checker'
     end
   end
 end

data/lib/opentracing/instrumentation/mongo/query_sanitazer.rb

@@ -19,9 +19,12 @@ module OpenTracing
         DEFAULT_EXCLUDE_KEYS = %w[lsid].freeze
 
         def initialize(
+          safety_argument_checker: SampleSafetyArgumentChecker.new,
           safe_classes: DEFAULT_SAFE_CLASSES,
           exclude_keys: DEFAULT_EXCLUDE_KEYS
         )
+          super()
+          @safety_argument_checker = safety_argument_checker
           @safe_classes = safe_classes
           @exclude_keys = exclude_keys
         end
@@ -36,8 +39,9 @@ module OpenTracing
 
         private
 
-        attr_reader :safe_classes
-        attr_reader :exclude_keys
+        attr_reader :safe_classes,
+                    :exclude_keys,
+                    :safety_argument_checker
 
         OBJECT_ID_PLACEHOLDER = '$oid'
         STRING_PLACEHOLDER = '$string'
@@ -68,9 +72,18 @@ module OpenTracing
         end
 
         def sanitaze_hash(hash)
-          hash.transform_values do |value|
-            sanitaze_value(value)
-          end
+          hash.map do |(key, value)|
+            # TODO: pass command name.
+            # TODO: recursive build path to key
+            safe_value =
+              if safety_argument_checker.argument_safe?(nil, key, value)
+                value
+              else
+                sanitaze_value(value)
+              end
+
+            [key, safe_value]
+          end.to_h
         end
 
         def sanitaze_array(array)