ruby-static-tracing 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a43ab444f18179cf5d5cdcd677d5a2043a0849adaa4df605920f9869ed0191e
-  data.tar.gz: 49086fa125a903a9f48923ba22de6999fa01f87dde54e35dc5064941155135d1
+  metadata.gz: d539146e2e9ea21dc04efcdf30e79191e6baa8b26df3404dce11caecce1f41c5
+  data.tar.gz: a7fcc027f75a89674c33ae66b133c871d3d498de2730a512e62de1849ba81d6d
 SHA512:
-  metadata.gz: 0d987dcb22dd0fbcf4294f6ba33792d383c289c52a241fd2579f36669330fc6935b928de947c9e51e48f9b22f751a79cb0a22be6ec7005605ebcb2e209f6c9f5
-  data.tar.gz: f11c5777711c104064de7664ce784a7e84fb1924b539011cf4bde22572eb62d432f31c83b024d4fe7401753a0621ce03fcb29d1ed5e42955f00e31b5ff83c414
+  metadata.gz: e5c3b59f152a01cbf066828b248ab10c5ec7453b4457fdd90cc5bf776fa0fb164e48a5c284bf6922bc9deb59f66db537ad17e80547dd567879b516e2592760a8
+  data.tar.gz: 531f8f45254b8bab2171ebc40afee1395322ff64d7635094a52b25bb1e4dd6915768fbd4bc45ddc4003491cdce0659dfcb4700f398b6eb96f3d5f2069a9dd867

data/ext/ruby-static-tracing/darwin/provider.c

@@ -41,7 +41,13 @@ provider_enable(VALUE self) {
   static_tracing_provider_t *res = NULL;
   TypedData_Get_Struct(self, static_tracing_provider_t,
                        &static_tracing_provider_type, res);
-  return usdt_provider_enable(res->usdt_provider) == 0 ? Qtrue : Qfalse;
+  int rc = usdt_provider_enable(res->usdt_provider);
+
+  // FIXME how to better log this? raise an exception probabaly
+  //if (rc != 0)
+  //  printf("Error: %s\n", res->usdt_provider->error);
+
+  return rc == 0 ? Qtrue : Qfalse;
 }
 
 /*

data/ext/ruby-static-tracing/darwin/ruby_static_tracing.c

@@ -35,8 +35,8 @@ void Init_ruby_static_tracing() {
 
   rb_define_alloc_func(cProvider, static_tracing_provider_alloc);
   rb_define_method(cProvider, "provider_initialize", provider_initialize, 1);
-  rb_define_method(cProvider, "enable", provider_enable, 0);
-  rb_define_method(cProvider, "disable", provider_disable, 0);
+  rb_define_method(cProvider, "_enable_provider", provider_enable, 0);
+  rb_define_method(cProvider, "_disable_provider", provider_disable, 0);
   rb_define_method(cProvider, "destroy", provider_destroy, 0);
 
   rb_define_alloc_func(cTracepoint, static_tracing_tracepoint_alloc);

data/ext/ruby-static-tracing/extconf.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 $LOAD_PATH.unshift File.expand_path('../../lib', __dir__).freeze
 
 require 'mkmf'

data/lib/ruby-static-tracing.rb

@@ -6,9 +6,6 @@ require 'ruby-static-tracing/version'
 require 'ruby-static-tracing/platform'
 require 'ruby-static-tracing/provider'
 require 'ruby-static-tracing/tracepoint'
-require 'ruby-static-tracing/configuration'
-require 'ruby-static-tracing/tracer'
-require 'ruby-static-tracing/tracers'
 
 # FIXME: Including StaticTracing should cause every method in a module or class to be registered
 # Implement this by introspecting all methods on the includor, and wrapping them.
@@ -47,7 +44,6 @@ module StaticTracing
   # Overwrite the definition of all functions that are enabled
   # with a wrapped version that has tracing enabled
   def enable!
-    StaticTracing::Tracers.enable!
     StaticTracing::Provider.enable! # FIXME individually call enable
     @enabled = true
   end
@@ -55,7 +51,6 @@ module StaticTracing
   # Overwrite the definition of all functions to their original definition,
   # no longer wrapping them
   def disable!
-    StaticTracing::Tracers.disable!
     StaticTracing::Provider.disable! # FIXME dangerous
     @enabled = false
   end
@@ -64,15 +59,6 @@ module StaticTracing
   def toggle_tracing!
     enabled? ? disable! : enable!
   end
-
-  # Block to configure static tracing, eg:
-  #
-  #   StaticTracing.configure do |config|
-  #     config.add_tracer(StaticTracing::Tracer::Latency)
-  #   end
-  def configure
-    yield Configuration.instance
-  end
 end
 
 require 'ruby-static-tracing/ruby_static_tracing' if StaticTracing::Platform.supported_platform?

data/lib/ruby-static-tracing/version.rb

@@ -2,5 +2,5 @@
 
 module StaticTracing
   # The current version of this gem
-  VERSION = '0.0.15'
+  VERSION = '0.0.16'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-static-tracing
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Dale Hamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: unmixer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -188,13 +174,6 @@ files:
 - lib/ruby-static-tracing/platform.rb
 - lib/ruby-static-tracing/provider.rb
 - lib/ruby-static-tracing/tracepoint.rb
-- lib/ruby-static-tracing/tracer.rb
-- lib/ruby-static-tracing/tracer/base.rb
-- lib/ruby-static-tracing/tracer/concerns/latency_tracer.rb
-- lib/ruby-static-tracing/tracer/helpers.rb
-- lib/ruby-static-tracing/tracer/latency.rb
-- lib/ruby-static-tracing/tracer/stack.rb
-- lib/ruby-static-tracing/tracers.rb
 - lib/ruby-static-tracing/version.rb
 - lib/tasks/docker.rb
 - lib/tasks/vagrant.rb
@@ -218,8 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: USDT tracing for Ruby

data/lib/ruby-static-tracing/tracer.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'tracer/base'
-require_relative 'tracer/latency'
-require_relative 'tracer/stack'

data/lib/ruby-static-tracing/tracer/base.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'unmixer'
-using Unmixer
-
-require 'ruby-static-tracing/tracer/helpers'
-
-module StaticTracing
-  module Tracer
-    class Base
-      class << self
-        include Tracer::Helpers
-
-        def register(klass, *method_names, provider: nil)
-          provider_name ||= underscore(klass.name)
-          provider = Provider.register(provider_name)
-          method_overrides = function_wrapper.new(provider, @wrapping_function, @data_types)
-          modified_classes[klass] ||= method_overrides
-          modified_classes[klass].add_override(method_names.flatten)
-        end
-
-        def enable!
-          modified_classes.each do |klass, wrapped_methods|
-            klass.prepend(wrapped_methods)
-          end
-        end
-
-        def disable!
-          modified_classes.each do |klass, wrapped_methods|
-            klass.instance_eval { unprepend(wrapped_methods) }
-          end
-        end
-
-        private
-
-        def function_wrapper
-          Class.new(Module) do
-            def initialize(provider, wrapping_function, data_types)
-              @provider = provider
-              @wrapping_function = wrapping_function
-              @data_types = data_types
-            end
-
-            def add_override(methods)
-              methods.each do |method|
-                Tracepoint.new(@provider.namespace, method.to_s, *@data_types)
-                define_method(method.to_s, @wrapping_function)
-              end
-            end
-
-            attr_reader :provider
-          end
-        end
-
-        def modified_classes
-          @modified_classes ||= {}
-        end
-
-        def set_tracepoint_data_types(*args)
-          @data_types = *args
-        end
-
-        def tracepoint_data_types
-          @data_types
-        end
-
-        def set_wrapping_function(callable)
-          @wrapping_function = callable
-        end
-      end
-    end
-  end
-end

data/lib/ruby-static-tracing/tracer/concerns/latency_tracer.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module StaticTracing
-  module Tracer
-    module Concerns
-      # Including this module will cause the target
-      # to have latency tracers added around every method
-      module Latency
-        def self.included(base)
-          methods = base.public_instance_methods(false)
-          StaticTracing::Tracer::Latency.register(base, methods)
-        end
-      end
-    end
-  end
-end

data/lib/ruby-static-tracing/tracer/helpers.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module StaticTracing
-  module Tracer
-    module Helpers
-      module_function
-
-      def underscore(class_name)
-        class_name.gsub(/::/, '_')
-                  .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-                  .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-                  .tr('-', '_')
-                  .downcase
-      end
-    end
-  end
-end

data/lib/ruby-static-tracing/tracer/latency.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module StaticTracing
-  module Tracer
-    class Latency < Base
-      set_wrapping_function lambda { |*args, &block|
-        start_time = StaticTracing.nsec
-        result = super(*args, &block)
-        duration = StaticTracing.nsec - start_time
-        method_name = __method__.to_s
-        provider = Tracer::Helpers.underscore(self.class.name)
-        # FIXME: benchmark this, we may need to cache the provider instance on the object
-        # This lookup is a bit of a hack
-        Tracepoint.fetch(provider, method_name).fire(method_name, duration)
-        result
-      }
-
-      set_tracepoint_data_types(String, Integer)
-    end
-  end
-end

data/lib/ruby-static-tracing/tracer/stack.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module StaticTracing
-  module Tracer
-    # A stack tracer gets the stack trace at point when
-    # the tracer is executed
-    class Stack < Base
-      set_wrapping_function lambda { |*args, &block|
-        current_stack = send(:caller).join("\n")
-        method_name = __method__.to_s
-        provider = Tracer::Helpers.underscore(self.class.name)
-        Tracepoint.fetch(provider, method_name).fire(method_name, current_stack)
-
-        super(*args, &block)
-      }
-
-      set_tracepoint_data_types(String, String)
-    end
-  end
-end

data/lib/ruby-static-tracing/tracers.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module StaticTracing
-  # Tracers are a layer of abstraction above tracepoints. They are opinionated
-  # and contextual ways of applying tracepoints to an application.
-  class Tracers
-    # Error for an invalid tracer
-    class InvalidTracerError < StandardError
-      def initialize
-        msg = <<~MSG
-          You need to add a valid tracer.
-
-          To create a valid tracer please inherit from StaticTracing::Tracer::Base
-          and follow the guide on how to create tracers
-        MSG
-        super(msg)
-      end
-    end
-
-    class << self
-      def add(tracer)
-        raise InvalidTracerError unless tracer < StaticTracing::Tracer::Base
-
-        tracers << tracer
-      end
-
-      # Enables each tracer, overriding original
-      # method definition with traced one
-      def enable!
-        tracers.each(&:enable!)
-      end
-
-      # Disables each tracer, replacing the method definition
-      def disable!
-        tracers.each(&:disable!)
-      end
-
-      # Clears all tracers
-      def clean
-        # FIXME: - actuallly ensure destroyed to avoid memory leaks
-        @tracers = []
-      end
-
-      private
-
-      def tracers
-        @tracers ||= []
-      end
-    end
-  end
-end