instrument_all_the_things 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f94f90a7539a296a29d43cac30fe9766addbe951afd9d1b6334457e167ae9941
-  data.tar.gz: 91827ee4e9ffb1da8eda1f630f322fa1d20e5ef7183d41352ce8f505405491a4
+  metadata.gz: 19a589699de098a3b92a317e37a7a901f6d3d90868fd889a41a1c7e04ebaa124
+  data.tar.gz: 2f7b79adb14a1ac4fcfc85f8993508d357d6bcd4caa63b9e1f482c95dcf9b85e
 SHA512:
-  metadata.gz: 50a2eeba0febe1f181402c216b42ad8ef91e976cc77acfc107acf78c57eab990cf4e250c16a94de934a23039a88b930c96dd370a59e980a0ccece378eff42f8d
-  data.tar.gz: a18c47fd122cfc81c950aae89c8595013e451d361dfadeaf1aed56d7768d08835241d59d35b094ee340c75e51adfc7e8e1fcb7459ee75192bda5b66960b8e2bf
+  metadata.gz: 6403abcf56557ca5dcd873c3f7133d6947eab41a4a1854cc7d25d8e0b55879478691d5682fa27c54833fa4e750c4893230852bd4edc6c2ac9516f1c2d720fa8d
+  data.tar.gz: ced3427628d48fc19f064b93c2647d991e0fbe4eec76e9365d1b7184d171b4c86d06b5d1ad0ac037eee703cc3a0f1d16beea4b13b1c1cd39d7ae6b4ba12c4f32

data/.rubocop.yml

@@ -1,4 +1,8 @@
+inherit_from: https://raw.githubusercontent.com/GetTerminus/ruby_shared_configs/master/.rubocop.yml
+
+
 AllCops:
+  TargetRubyVersion: 2.6
   Exclude:
     - Makefile
     - vendor/**/*

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in instrument_all_the_things.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    instrument_all_the_things (1.1.1)
+    instrument_all_the_things (1.3.0)
       ddtrace
       dogstatsd-ruby
 
@@ -43,16 +43,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.21.0)
+    rubocop (1.22.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/instrument_all_the_things.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Wrappers to make instrumentation of methods easy and pleasant to read'
   spec.homepage      = 'https://github.com/GetTerminus/instrument-all-the-things'
 
-  spec.metadata['allowed_push_host'] = "https://www.rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://www.rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/GetTerminus/instrument-all-the-things'
@@ -28,15 +28,16 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_dependency 'ddtrace'
   spec.add_dependency 'dogstatsd-ruby'
 
+  spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/instrument_all_the_things/clients/tracer/blackhole.rb

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
+
 module InstrumentAllTheThings
   module Clients
     class Blackhole
       class Span
-        def initialize
-        end
+        def initialize; end
 
-        def set_tag(name, value)
-        end
+        def set_tag(name, value); end
       end
 
-
       def initialize
         reset!
       end
 
-      def trace(name, options)
+      def trace(_name, _options)
         yield Span.new
       end
     end

data/lib/instrument_all_the_things/context.rb

@@ -5,7 +5,7 @@ module InstrumentAllTheThings
     def stats_name(klass_or_instance)
       @stats_name ||= [
         class_name(klass_or_instance),
-        (instance ? 'instance' : 'class') + '_methods',
+        "#{instance ? 'instance' : 'class'}_methods",
         method_name,
       ].join('.')
     end

data/lib/instrument_all_the_things/helpers.rb

@@ -21,7 +21,7 @@ module InstrumentAllTheThings
 
         settings[:context] = Context.new(
           method_name: method_name,
-          instance: false
+          instance: false,
         )
 
         InstrumentAllTheThings::MethodProxy
@@ -37,7 +37,7 @@ module InstrumentAllTheThings
 
         settings[:context] = Context.new(
           method_name: method_name,
-          instance: true
+          instance: true,
         )
 
         InstrumentAllTheThings::MethodProxy

data/lib/instrument_all_the_things/instrumentors/gc_stats.rb

@@ -7,7 +7,7 @@ module InstrumentAllTheThings
         total_allocated_pages
         total_allocated_objects
         count
-      ].freeze
+      ].freeze,
     }.freeze
 
     # This is to make it easier to spec since other
@@ -19,12 +19,12 @@ module InstrumentAllTheThings
                DEFAULT_GC_STATS_OPTIONS
              else
                DEFAULT_GC_STATS_OPTIONS.merge(opts)
-            end
+             end
 
       report_value = proc do |klass, stat_name, value|
         InstrumentAllTheThings.stat_reporter.histogram(
           context.stats_name(klass) + ".#{stat_name}_change",
-          value
+          value,
         )
       end
 
@@ -38,7 +38,7 @@ module InstrumentAllTheThings
           end
 
           if (span = InstrumentAllTheThings.tracer.active_span)
-            span.set_tag('gc_stats', diff)
+            span.set_tags(IATT.to_tracer_tags(diff, 'gc_stats'))
           end
 
           diff.each { |s, v| report_value.call(klass, s, v) }

data/lib/instrument_all_the_things/instrumentors/tracing.rb

@@ -6,7 +6,7 @@ module InstrumentAllTheThings
       service: '',
       span_type: '',
       tags: {},
-      span_name: 'method.execution'
+      span_name: 'method.execution',
     }.freeze
 
     TRACE_WRAPPER = proc do |opts, context|

data/lib/instrument_all_the_things/method_instrumentor.rb

@@ -17,7 +17,7 @@ module InstrumentAllTheThings
       trace: true,
       gc_stats: true,
       error_logging: true,
-      execution_counts_and_timing: true
+      execution_counts_and_timing: true,
     }.freeze
 
     attr_accessor :options, :instrumentor

data/lib/instrument_all_the_things/method_proxy.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:todo Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
 require_relative './method_instrumentor'
 
 module InstrumentAllTheThings
@@ -22,9 +24,13 @@ module InstrumentAllTheThings
     end
 
     def self.construct_for_class(klass)
-      Module.new do
+      mod = Module.new do
         extend Instrumentor
-      end.tap { |m| m._iatt_built_for = klass }
+      end
+
+      mod._iatt_built_for = klass
+
+      mod
     end
 
     module Instrumentor
@@ -56,8 +62,8 @@ module InstrumentAllTheThings
           else
             tag
           end
-          rescue StandardError
-            nil
+        rescue StandardError
+          nil
         end.compact
       end
 
@@ -75,3 +81,5 @@ module InstrumentAllTheThings
     end
   end
 end
+
+# rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

data/lib/instrument_all_the_things/testing/rspec_matchers.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+# rubocop:todo Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
 module InstrumentAllTheThings
   module Testing
     module RSpecMatchers
       def histogram_value(counter_name)
         stats = InstrumentAllTheThings.stat_reporter.emitted_values[:histogram][counter_name]
-        stats.inject(0){|l, n| l + n[:args][0] }
+        stats.inject(0) { |l, n| l + n[:args][0] }
       end
 
       def distribution_values(distribution_name, with_tags: nil)
@@ -13,11 +15,11 @@ module InstrumentAllTheThings
 
         if with_tags && !stats.empty?
           stats = stats.select do |s|
-            with_tags.all?{|t| s[:tags].include?(t) }
+            with_tags.all? { |t| s[:tags].include?(t) }
           end
         end
 
-        stats&.map{|i| i[:args] }&.map(&:first) || []
+        stats&.map { |i| i[:args] }&.map(&:first) || []
       end
 
       def histogram_values(histogram_name, with_tags: nil)
@@ -25,11 +27,11 @@ module InstrumentAllTheThings
 
         if with_tags && !stats.empty?
           stats = stats.select do |s|
-            with_tags.all?{|t| s[:tags].include?(t) }
+            with_tags.all? { |t| s[:tags].include?(t) }
           end
         end
 
-        stats&.map{|i| i[:args] }&.map(&:first) || []
+        stats&.map { |i| i[:args] }&.map(&:first) || []
       end
 
       def timing_values(timing_name, with_tags: nil)
@@ -37,11 +39,11 @@ module InstrumentAllTheThings
 
         if with_tags && !stats.empty?
           stats = stats.select do |s|
-            with_tags.all?{|t| s[:tags].include?(t) }
+            with_tags.all? { |t| s[:tags].include?(t) }
           end
         end
 
-        stats&.map{|i| i[:args] }&.map(&:first) || []
+        stats&.map { |i| i[:args] }&.map(&:first) || []
       end
 
       def set_value(counter_name, with_tags: nil)
@@ -49,11 +51,11 @@ module InstrumentAllTheThings
 
         if with_tags && !stats.empty?
           stats = stats.select do |s|
-            with_tags.all?{|t| s[:tags].include?(t) }
+            with_tags.all? { |t| s[:tags].include?(t) }
           end
         end
 
-        data = stats&.map{|i| i[:args] }&.map(&:first)
+        data = stats&.map { |i| i[:args] }&.map(&:first)
         data ? data.uniq.length : 0
       end
 
@@ -62,7 +64,7 @@ module InstrumentAllTheThings
 
         if with_tags && !stats.empty?
           stats = stats.select do |s|
-            with_tags.all?{|t| s[:tags].include?(t) }
+            with_tags.all? { |t| s[:tags].include?(t) }
           end
         end
         stats.last&.fetch(:args)&.first
@@ -72,10 +74,10 @@ module InstrumentAllTheThings
         stats = InstrumentAllTheThings.stat_reporter.emitted_values[:count][counter_name]
         if with_tags && !stats.empty?
           stats = stats.select do |s|
-            with_tags.all?{|t| s[:tags].include?(t) }
+            with_tags.all? { |t| s[:tags].include?(t) }
           end
         end
-        stats.inject(0){|l, n| l + n[:args][0] }
+        stats.inject(0) { |l, n| l + n[:args][0] }
       end
 
       def flush_traces
@@ -95,3 +97,5 @@ module InstrumentAllTheThings
     end
   end
 end
+
+# rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

data/lib/instrument_all_the_things/testing/stat_tracker.rb

@@ -6,19 +6,20 @@ module InstrumentAllTheThings
   module Testing
     class StatTracker < Clients::StatReporter::DataDog
       attr_reader :emitted_values
+
       %i[
-      count
-      distribution
-      gauge
-      histogram
-      set
-      time
-      timing
+        count
+        distribution
+        gauge
+        histogram
+        set
+        time
+        timing
       ].each do |meth|
         define_method(meth) do |*args, &blk|
           opts = args.last.is_a?(Hash) ? args.last : {}
           @emitted_values[meth][args[0]] << {
-            args: args[1..-1],
+            args: args[1..],
             tags: opts.fetch(:tags, []),
           }
 

data/lib/instrument_all_the_things/testing/trace_tracker.rb

@@ -18,7 +18,7 @@ module InstrumentAllTheThings
       end
 
       def <<(val)
-        @traces = @traces.concat(MessagePack.load(val[:body]).flatten)
+        @traces.concat(MessagePack.load(val[:body]).flatten)
       end
     end
   end

data/lib/instrument_all_the_things/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InstrumentAllTheThings
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/instrument_all_the_things.rb

@@ -23,7 +23,7 @@ module InstrumentAllTheThings
                     App.logger
                   else
                     require 'logger'
-                    Logger.new(STDOUT)
+                    Logger.new($stdout)
                   end
     end
 
@@ -63,6 +63,33 @@ module InstrumentAllTheThings
   def self.included(other)
     other.include(Helpers)
   end
+
+  def self.tag_active_span(tag_name, tag_value)
+    tracer&.active_span&.set_tags(to_tracer_tags(tag_name => tag_value))
+  end
+
+  def self.tag_active_root_span(tag_name, tag_value)
+    tracer&.active_span&.set_tags(to_tracer_tags(tag_name => tag_value))
+  end
+
+  def self.to_tracer_tags(hsh, prefix = nil)
+    hsh.each_with_object({}) do |(hash_key, value), acc|
+      key = prefix ? "#{prefix}.#{hash_key}" : hash_key
+
+      case value
+      when Hash
+        acc.merge!(to_tracer_tags(value, key))
+      when Array
+        content = value.each_with_index.each_with_object({}) do |(item, index), reformed|
+          reformed[index] = item
+        end
+
+        acc.merge!(to_tracer_tags(content, key))
+      else
+        acc[key] = value
+      end
+    end
+  end
 end
 
 IATT = InstrumentAllTheThings unless defined?(IATT)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instrument_all_the_things
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Brian Malinconico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ddtrace
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -196,8 +196,6 @@ files:
 - vendor/cache/rspec-expectations-3.10.1.gem
 - vendor/cache/rspec-mocks-3.10.2.gem
 - vendor/cache/rspec-support-3.10.2.gem
-- vendor/cache/rubocop-1.21.0.gem
-- vendor/cache/rubocop-ast-1.11.0.gem
 - vendor/cache/ruby-progressbar-1.11.0.gem
 - vendor/cache/simplecov-0.21.2.gem
 - vendor/cache/simplecov-html-0.12.3.gem
@@ -217,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="