instrument_all_the_things 1.0.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac64a9b7acfa4de004260992b1c4f664587345e692a6f08f9798442b0568619d
-  data.tar.gz: 6bd26e6ea3186c4ca0883a4a2971dc2980f0c71409f6654a5da1ab183539b372
+  metadata.gz: f94f90a7539a296a29d43cac30fe9766addbe951afd9d1b6334457e167ae9941
+  data.tar.gz: 91827ee4e9ffb1da8eda1f630f322fa1d20e5ef7183d41352ce8f505405491a4
 SHA512:
-  metadata.gz: 97d28f7d5a86fbaf0cc1a9792ad26d39cc2a34ddc9bbbba9c82d413f19b785136af1319dc27f1a44c72f494b701fcf11003743edae6276c30a0ec100da054de8
-  data.tar.gz: d78092b9f1ad421ba8674ad830821558399dd471117f4fe1efda3905ef0dc472e421c4105288790582d76f15d60f8881a3da6554050ff69f50ae1a071e46fc19
+  metadata.gz: 50a2eeba0febe1f181402c216b42ad8ef91e976cc77acfc107acf78c57eab990cf4e250c16a94de934a23039a88b930c96dd370a59e980a0ccece378eff42f8d
+  data.tar.gz: a18c47fd122cfc81c950aae89c8595013e451d361dfadeaf1aed56d7768d08835241d59d35b094ee340c75e51adfc7e8e1fcb7459ee75192bda5b66960b8e2bf

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+3.0.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.2.0
+
+Remove unneeded kwargs option to support Ruby 3.0

data/Gemfile.lock

@@ -1,60 +1,67 @@
 PATH
   remote: .
   specs:
-    instrument_all_the_things (1.0.3)
+    instrument_all_the_things (1.1.1)
       ddtrace
       dogstatsd-ruby
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    benchmark-ips (2.7.2)
-    coderay (1.1.2)
-    ddtrace (0.33.1)
+    ast (2.4.2)
+    benchmark-ips (2.9.1)
+    coderay (1.1.3)
+    ddtrace (0.52.0)
+      ffi (~> 1.0)
       msgpack
-    diff-lcs (1.3)
-    docile (1.3.2)
-    dogstatsd-ruby (4.7.0)
-    jaro_winkler (1.5.4)
-    method_source (0.9.2)
-    msgpack (1.3.3)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    dogstatsd-ruby (5.2.0)
+    ffi (1.15.4)
+    method_source (1.0.0)
+    msgpack (1.4.2)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.21.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.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      simplecov-html (~> 0.11.0)
-    simplecov-html (0.11.0)
-    unicode-display_width (1.6.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -71,4 +78,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.0.2
+   2.2.22

data/README.md

@@ -93,6 +93,32 @@ also be passed to the DataDog tracer, and their [options](https://github.com/Dat
 | span_type | See DD Docs.                                                  | `nil`
 | tags      | Set of tags to be added to the span, expected to be a hash    | {}
 
+#### Dynamic Tags
+
+If a trace's tags need to reference either an instance variable or a parameter to the method being traced, you must pass in a proc for the tag value.
+
+For instance variables, this will look like this:
+```ruby
+instrument trace: { tags: [-> { "some_stat:#{some_instance_var}" }]}
+def my_instance_method
+...
+end
+```
+
+For parameter references, your proc will need to to have a parameter of `args` or `kwargs` (or both), depending on if the parameter you need to reference is a normal parameter or a keyword parameter. Examples:
+
+```ruby
+instrument trace: { tags: [->(args) { "log_args:#{args[0]}" }]}
+def my_instance_method(my_var)
+...
+end
+
+instrument trace: { tags: [->(kwargs) { "log_args:#{kwargs[:my_arg]}" }]}
+def my_instance_method(my_arg:)
+...
+end
+```
+
 ## Testing Support
 
 You can setup your test environment by running the following setup:

data/lib/instrument_all_the_things/helpers.rb

@@ -50,6 +50,9 @@ module InstrumentAllTheThings
 
     def self.included(other_class)
       other_class.extend(ClassMethods)
+
+      InstrumentAllTheThings::MethodProxy.for_class(other_class)
+      InstrumentAllTheThings::MethodProxy.for_class(other_class.singleton_class)
     end
   end
 end

data/lib/instrument_all_the_things/instrumentors/tracing.rb

@@ -11,19 +11,21 @@ module InstrumentAllTheThings
 
     TRACE_WRAPPER = proc do |opts, context|
       opts = if opts == true
-               DEFAULT_TRACE_OPTIONS
+               DEFAULT_TRACE_OPTIONS.dup
              else
                DEFAULT_TRACE_OPTIONS.merge(opts)
              end
 
+      span_name = opts.delete(:span_name)
+
       proc do |klass, next_blk, actual_code|
-        InstrumentAllTheThings.tracer.trace(
-          opts[:span_name],
-          tags: context[:tags] || {},
-          service: opts[:service],
-          resource: opts[:resource] || context.trace_name(klass),
-          span_type: opts[:span_type]
-        ) { next_blk.call(klass, actual_code) }
+        passed_ops = opts.dup
+        passed_ops[:resource] ||= context.trace_name(klass)
+        passed_ops[:tags] ||= {}
+
+        InstrumentAllTheThings.tracer.trace(span_name, passed_ops) do
+          next_blk.call(klass, actual_code)
+        end
       end
     end
   end

data/lib/instrument_all_the_things/method_proxy.rb

@@ -40,21 +40,24 @@ module InstrumentAllTheThings
         @_iatt_built_for = val
       end
 
-      def set_context_tags(klass, settings, *args, **kwargs) # rubocop:disable Lint/UnusedMethodArgument
+      def set_context_tags(klass, settings, args, kwargs)
         return unless settings.is_a?(Hash) && settings[:trace].is_a?(Hash) && settings[:trace][:tags]
 
         settings[:context][:tags] = settings[:trace][:tags].map do |tag|
           if tag.is_a?(Proc)
-            if tag.arity == 1
-              tag.call(eval(tag.parameters[0][1].to_s))
+            case tag.arity
+            when 2
+              tag.call(args, kwargs)
+            when 1
+              tag.parameters[0][1].to_s == 'args' ? tag.call(args) : tag.call(kwargs)
             else
               klass.instance_exec(&tag)
             end
           else
             tag
           end
-        rescue StandardError
-          nil
+          rescue StandardError
+            nil
         end.compact
       end
 

data/lib/instrument_all_the_things/testing/stat_tracker.rb

@@ -15,14 +15,14 @@ module InstrumentAllTheThings
       time
       timing
       ].each do |meth|
-        define_method(meth) do |*args, **kwargs, &blk|
+        define_method(meth) do |*args, &blk|
+          opts = args.last.is_a?(Hash) ? args.last : {}
           @emitted_values[meth][args[0]] << {
             args: args[1..-1],
-            tags: kwargs.fetch(:tags, []),
-            kwargs: kwargs,
+            tags: opts.fetch(:tags, []),
           }
 
-          super(*args, **kwargs, &blk)
+          super(*args, &blk)
         end
       end
 

data/lib/instrument_all_the_things/version.rb

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

data/lib/instrument_all_the_things.rb

@@ -28,8 +28,6 @@ module InstrumentAllTheThings
     end
 
     def stat_reporter
-      return @stat_reporter if defined?(@stat_reporter)
-
       @stat_reporter ||= Clients::StatReporter::DataDog.new(
         ENV.fetch('DATADOG_HOST', 'localhost'),
         ENV.fetch('DATADOG_PORT', 8125),
@@ -54,10 +52,10 @@ module InstrumentAllTheThings
       timing
       time
     ].each do |method_name|
-      define_method(method_name) do |*args, **kwargs, &blk|
+      define_method(method_name) do |*args, &blk|
         return unless stat_reporter
 
-        stat_reporter.public_send(method_name, *args, **kwargs, &blk)
+        stat_reporter.public_send(method_name, *args, &blk)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instrument_all_the_things
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Brian Malinconico
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ddtrace
@@ -149,6 +149,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -173,39 +174,42 @@ files:
 - lib/instrument_all_the_things/testing/trace_tracker.rb
 - lib/instrument_all_the_things/version.rb
 - logo.jpg
-- vendor/cache/ast-2.4.0.gem
-- vendor/cache/benchmark-ips-2.7.2.gem
-- vendor/cache/coderay-1.1.2.gem
-- vendor/cache/ddtrace-0.33.1.gem
-- vendor/cache/diff-lcs-1.3.gem
-- vendor/cache/docile-1.3.2.gem
-- vendor/cache/dogstatsd-ruby-4.7.0.gem
-- vendor/cache/jaro_winkler-1.5.4.gem
-- vendor/cache/method_source-0.9.2.gem
-- vendor/cache/msgpack-1.3.3.gem
-- vendor/cache/parallel-1.19.1.gem
-- vendor/cache/parser-2.7.0.2.gem
-- vendor/cache/pry-0.12.2.gem
+- vendor/cache/ast-2.4.2.gem
+- vendor/cache/benchmark-ips-2.9.1.gem
+- vendor/cache/coderay-1.1.3.gem
+- vendor/cache/ddtrace-0.52.0.gem
+- vendor/cache/diff-lcs-1.4.4.gem
+- vendor/cache/docile-1.4.0.gem
+- vendor/cache/dogstatsd-ruby-5.2.0.gem
+- vendor/cache/ffi-1.15.4.gem
+- vendor/cache/method_source-1.0.0.gem
+- vendor/cache/msgpack-1.4.2.gem
+- vendor/cache/parallel-1.21.0.gem
+- vendor/cache/parser-3.0.2.0.gem
+- vendor/cache/pry-0.14.1.gem
 - vendor/cache/rainbow-3.0.0.gem
 - vendor/cache/rake-10.5.0.gem
-- vendor/cache/rexml-3.2.4.gem
-- vendor/cache/rspec-3.9.0.gem
-- vendor/cache/rspec-core-3.9.1.gem
-- vendor/cache/rspec-expectations-3.9.0.gem
-- vendor/cache/rspec-mocks-3.9.1.gem
-- vendor/cache/rspec-support-3.9.2.gem
-- vendor/cache/rubocop-0.80.0.gem
-- vendor/cache/ruby-progressbar-1.10.1.gem
-- vendor/cache/simplecov-0.18.1.gem
-- vendor/cache/simplecov-html-0.11.0.gem
-- vendor/cache/unicode-display_width-1.6.1.gem
+- vendor/cache/regexp_parser-2.1.1.gem
+- vendor/cache/rexml-3.2.5.gem
+- vendor/cache/rspec-3.10.0.gem
+- vendor/cache/rspec-core-3.10.1.gem
+- 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
+- vendor/cache/simplecov_json_formatter-0.1.3.gem
+- vendor/cache/unicode-display_width-2.1.0.gem
 homepage: https://github.com/GetTerminus/instrument-all-the-things
 licenses: []
 metadata:
   allowed_push_host: https://www.rubygems.org
   homepage_uri: https://github.com/GetTerminus/instrument-all-the-things
   source_code_uri: https://github.com/GetTerminus/instrument-all-the-things
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,8 +224,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Make instrumentation with DataDog easy peasy
 test_files: []