instrument_all_the_things 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dca7567b1c5a509b2a0eb588455b908357715bf2e57b67cf68b8049fdbd38bed
-  data.tar.gz: 9404629cf4dc69252676f30742d5c4537342892258ece7d49ef72bc179125012
+  metadata.gz: 5092de92a898d3f15edde6f9379bdcbab22131323822744a5c3adbdc8868a922
+  data.tar.gz: 6e167a14df06cf6afc2f438dbdb4bd5d6d329a1d0299da62773e6a1fc36e60ef
 SHA512:
-  metadata.gz: 4d3018c4507be010ab4179ea09ba52c9842d7bb53dc105d9cc50bd8e2a7df58ce04c920b802a126d52ca51b4a20929def3ff11fe56b0bf643468bdb41c34b790
-  data.tar.gz: ab74f79b671305aabe0411cba5b25e67345ae22484034078d05b785755517ec0eafd5eb2870cbac9aed1541e283eef35fc8cd3f6508f1a345f584f13da83e506
+  metadata.gz: 552a49f66410a04d109fc9e722fa8e8739e117c3989be7b77e77b4e203c3c249af221a08309c048f91f3e733d8abbd7694d9f301d899f61db4483bd1bc746e70
+  data.tar.gz: 2b32646bd335b455d952169bbafd4439c8e9ee41117dd7ff5027749369103161e478f027657156cdb909cb30ebb4ea6b69e68a7979936fd0f48f82a73d759f6c

data/.rubocop-https---raw-githubusercontent-com-GetTerminus-ruby-shared-configs-master--rubocop-yml

@@ -3,7 +3,8 @@ AllCops:
     - Makefile
     - vendor/**/*
     - bin/**/*
-
+    - '**/*_pb.rb'
+    
 Layout/EndOfLine:
   Enabled: false
 
@@ -40,8 +41,6 @@ Layout/LineLength:
   Max: 280
   IgnoreCopDirectives: true
   AllowedPatterns: ['\A#', '\A\s*sig { .* }\Z']
-  Exclude:
-    - '**/*_pb.rb'
 
 Metrics/AbcSize:
   Enabled: true
@@ -76,7 +75,6 @@ Metrics/BlockLength:
   Max: 30
   Exclude:
     - spec/**/*.rb
-    - '**/*_pb.rb'
 
 Metrics/ParameterLists:
   Max: 6

data/README.md

@@ -44,28 +44,6 @@ class Foo
   end
 end
 ```
-### Garbage Collection Stats
-_Configuration Key `gc_stats`_
-
-Collects the difference between the specified keys during the execution of the method.
-
-Stat diffs are added to the active trace span as a tag, and a stat is emitted with the following format
-
-`klass_name.(instance|class)_methods.(stat_name)_change`
-
-#### Description of default stats
-_GC Stats are not thread local, if your app is multi threaded other threads may be contributing to these stats_
-| Option                  | Description
-| -----                   | ----
-| total_allocated_pages   | Total number of memory pages owned by this ruby process. Mature processes tend to see a slowdown in page allocations
-| total_allocated_objects | Total number of objects which have not been garbage collected yet
-| count                   | Total number of GC runs during this method's exuection
-
-#### Options
-| Option       | Description              | Default
-| -----        | ----                     | -----
-| diffed_stats | Stats to diff and record | [:total_allocated_pages, :total_allocated_objects, :count]
-
 ### Error Logging
 _Configuration Key `log_errors`_
 
@@ -129,8 +107,9 @@ require 'instrument_all_the_things/testing/trace_tracker'
 require 'instrument_all_the_things/testing/rspec_matchers'
 
 Datadog.configure do |c|
-  c.tracing.transport_options = proc { |t|
-    t.adapter :test, IATT::Testing::TraceTracker.new
+  c.tracing.test_mode.enabled = true 
+  c.tracing.test_mode.writer_options = {
+    transport: InstrumentAllTheThings::Testing::TraceTracker.tracker
   }
 end
 
@@ -166,10 +145,6 @@ some awesome rspec helpers like so:
   it 'traces' do
     expect {
       klass.new.foo
-
-      # Datadog writes trace to the wire and to the test harness asynchronously
-      # This helper is provided to force the flush before expectations are stated
-      flush_traces
     }.to change{
       emitted_spans(
         filtered_by: {resource: 'KlassName.foo'}
@@ -348,7 +323,6 @@ Calculating -------------------------------------
            the_works      7.404k (±12.9%) i/s -     36.936k in   5.100630s
           only_trace     27.968k (±12.7%) i/s -    139.209k in   5.061907s
   only_error_logging    638.098k (± 4.6%) i/s -      3.231M in   5.075275s
-       only_gc_stats     12.930k (±13.2%) i/s -     63.865k in   5.070874s
 only_execution_counts     9.847k (±11.1%) i/s -     49.088k in   5.073475s
 ```
 

data/instrument_all_the_things.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
-  spec.add_dependency 'ddtrace', '~> 1.0'
+  spec.add_dependency 'datadog', '~> 2.0'
   spec.add_dependency 'dogstatsd-ruby', '~> 5.0'
 
   spec.add_development_dependency 'benchmark-ips'

data/lib/instrument_all_the_things/instrumentors/all.rb

@@ -2,5 +2,4 @@
 
 require_relative './tracing'
 require_relative './error_logging'
-require_relative './gc_stats'
 require_relative './execution_count_and_timing'

data/lib/instrument_all_the_things/instrumentors/tracing.rb

@@ -21,6 +21,7 @@ module InstrumentAllTheThings
         passed_ops = opts.dup
         passed_ops[:resource] ||= context.trace_name(klass)
         passed_ops[:tags] ||= {}
+        passed_ops[:type] = passed_ops.delete(:span_type)
 
         InstrumentAllTheThings.tracer.trace(span_name, **passed_ops) do
           next_blk.call(klass, actual_code)

data/lib/instrument_all_the_things/method_instrumentor.rb

@@ -5,9 +5,6 @@ require_relative './instrumentors/all'
 module InstrumentAllTheThings
   class MethodInstrumentor
     WRAPPERS = {
-      # Note that the order of these hash keys are applied top to bottom, with the first inserted key
-      # being the inner most wrapper
-      gc_stats: Instrumentors::GC_STATS_WRAPPER,
       error_logging: Instrumentors::ERROR_LOGGING_WRAPPER,
       execution_counts_and_timing: Instrumentors::EXECUTION_COUNT_AND_TIMING_WRAPPER,
       trace: Instrumentors::TRACE_WRAPPER,
@@ -15,7 +12,6 @@ module InstrumentAllTheThings
 
     DEFAULT_OPTIONS = {
       trace: true,
-      gc_stats: false,
       error_logging: true,
       execution_counts_and_timing: false,
     }.freeze

data/lib/instrument_all_the_things/method_proxy.rb

@@ -28,6 +28,10 @@ module InstrumentAllTheThings
         extend Instrumentor
       end
 
+      # attaching to the original to_s
+      method = klass.method(:to_s)
+      mod.define_singleton_method(:to_s, &method)
+
       mod._iatt_built_for = klass
 
       mod

data/lib/instrument_all_the_things/testing/rspec_matchers.rb

@@ -80,10 +80,6 @@ module InstrumentAllTheThings
         stats.inject(0) { |l, n| l + n[:args][0] }
       end
 
-      def flush_traces
-        Datadog::Tracing.send(:tracer)&.writer&.worker&.flush_data
-      end
-
       def emitted_spans(filtered_by: nil)
         sleep 0.01
         traces = InstrumentAllTheThings::Testing::TraceTracker.tracker.traces.map(&:dup)

data/lib/instrument_all_the_things/testing/trace_tracker.rb

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 
+require 'datadog/tracing/transport/io/client'
+
 module InstrumentAllTheThings
   module Testing
-    class TraceTracker
+    class TraceTracker < Datadog::Tracing::Transport::IO::Client
       attr_reader :traces
 
       def self.tracker
-        @tracker ||= new
+        @tracker ||= new(
+          StringIO.new,
+          Datadog::Core::Encoding::JSONEncoder,
+        )
       end
 
-      def initialize
+      def initialize(...)
+        super
         reset!
       end
 
@@ -17,8 +23,9 @@ module InstrumentAllTheThings
         @traces = []
       end
 
-      def <<(val)
-        @traces.concat(MessagePack.load(val[:body]).flatten)
+      def write_data(_, val)
+        body = JSON.parse(val)
+        @traces.concat(body.fetch('traces', []).flatten)
       end
     end
   end

data/lib/instrument_all_the_things/thread.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ddtrace'
+require 'datadog'
 
 # https://github.com/DataDog/dd-trace-rb/blob/master/docs/UpgradeGuide.md#between-threads
 class Thread

data/lib/instrument_all_the_things/version.rb

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

data/lib/instrument_all_the_things.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ddtrace'
+require 'datadog'
 
 require 'instrument_all_the_things/version'
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: instrument_all_the_things
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Brian Malinconico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ddtrace
+  name: datadog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +166,6 @@ files:
 - lib/instrument_all_the_things/instrumentors/all.rb
 - lib/instrument_all_the_things/instrumentors/error_logging.rb
 - lib/instrument_all_the_things/instrumentors/execution_count_and_timing.rb
-- lib/instrument_all_the_things/instrumentors/gc_stats.rb
 - lib/instrument_all_the_things/instrumentors/tracing.rb
 - lib/instrument_all_the_things/method_instrumentor.rb
 - lib/instrument_all_the_things/method_proxy.rb

data/lib/instrument_all_the_things/instrumentors/gc_stats.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module InstrumentAllTheThings
-  module Instrumentors
-    DEFAULT_GC_STATS_OPTIONS = {
-      diffed_stats: %i[
-        total_allocated_pages
-        total_allocated_objects
-        count
-      ].freeze,
-    }.freeze
-
-    # This is to make it easier to spec since other
-    # gems may call this
-    GC_STAT_GETTER = -> { GC.stat }
-
-    GC_STATS_WRAPPER = lambda do |opts, context|
-      opts = if opts == true
-               DEFAULT_GC_STATS_OPTIONS
-             else
-               DEFAULT_GC_STATS_OPTIONS.merge(opts)
-             end
-
-      report_value = proc do |klass, stat_name, value|
-        InstrumentAllTheThings.stat_reporter.histogram(
-          context.stats_name(klass) + ".#{stat_name}_change",
-          value,
-        )
-      end
-
-      lambda do |klass, next_blk, actual_code|
-        starting_values = GC_STAT_GETTER.call.slice(*opts[:diffed_stats])
-        next_blk.call(klass, actual_code).tap do
-          new_values = GC_STAT_GETTER.call.slice(*opts[:diffed_stats])
-
-          diff = new_values.merge(starting_values) do |_, new_value, starting_value|
-            new_value - starting_value
-          end
-
-          if (span = InstrumentAllTheThings.tracer.active_span)
-            span.set_tags(IATT.to_tracer_tags(diff, 'gc_stats'))
-          end
-
-          diff.each { |s, v| report_value.call(klass, s, v) }
-        end
-      end
-    end
-  end
-end