ruby-static-tracing 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5bea8f6cfef0a767f1cabe69d7e719944ed236974b5fab9885b86f7a81e884c
-  data.tar.gz: 82382b83d719379a7b11288e6ecc8a552de29c123067fa75ba8f8f5cffb40d13
+  metadata.gz: 39954c9a0d6ad64110b48b91b8900daf274a292ee2dea064560f68f43f8cc266
+  data.tar.gz: 527f1c4b74aa68d01aad5d71b717fea2e3fd006206ac39f7c7ba8dec004dbb03
 SHA512:
-  metadata.gz: 39811b0423ecbe035ed85f00b3baeb34f889f52752bcb0952781b93db8c5d81a611240bc954943cd4257563c6f7b0f6e96e98e70a6915625e37c37550e97eaef
-  data.tar.gz: b49a83b3c09ada4e06402d3265c6016a334dffd0ce667a27c30c0828340a2654aa92b568573435a624e1980024d74b55d40efcee495526ae7f90d3d6988673a8
+  metadata.gz: 7460cb3b9d32d96e888337f7464981dc221b4762a4735f6f3e13334eada3000a1148c1c7c5051ce5f5b737f3e869c4dd6566b791781c73606b9269543fa39316
+  data.tar.gz: 6c80c8393ba0109ba5b1d0e979626b0eeb7401b94d41b1e4d8241be4ab317306fafab0c378cd463d74a42ce213a35f0c3c62c701194b074b0e9596684f675b0d

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

@@ -17,17 +17,17 @@ def lib_dir
 end
 #  - Linux, via libstapsdt
 if StaticTracing::Platform.linux?
-  abort 'libstapsdt.h is missing, please install libstapsdt' unless find_header('libstapsdt.h')
 
   LIB_DIRS = [LIB_DIR, RbConfig::CONFIG['libdir']]
   HEADER_DIRS = [
                  File.join(BASE_DIR, 'include'),
-                 File.join(BASE_DIR, 'lib', 'libstapsdt'),
+                 File.join(BASE_DIR, 'lib', 'libstapsdt', 'src'),
                  RbConfig::CONFIG['includedir']
                 ]
 
   dir_config(MKMF_TARGET, HEADER_DIRS, LIB_DIRS)
 
+  abort 'libstapsdt.h is missing, please install libstapsdt' unless find_header('libstapsdt.h')
   have_header 'libstapsdt.h'
 
   unless have_library('stapsdt')

data/ext/ruby-static-tracing/linux/tracepoint.c

@@ -121,9 +121,9 @@ static Tracepoint_arg_types
       printf("ERROR - passed %i args, maximum 6 argument types can be passed", *argc);
       return NULL;
     }
-
+    int i;
     Tracepoint_arg_types *args = malloc(*argc * sizeof(Tracepoint_arg_types));
-    for (int i = 0; i < *argc; i++)
+    for (i = 0; i < *argc; i++)
     {
       VALUE str = rb_funcall(rb_ary_entry(vargs, i), rb_intern("to_s"), 0, Qnil);
       const char* cStr = RSTRING_PTR(str);
@@ -158,7 +158,8 @@ static Tracepoint_fire_arg
 
     Tracepoint_fire_arg *args = malloc(*argc * sizeof(Tracepoint_fire_arg));
     //printf("SIZE: %i ARGC: %i \n", sizeof(Tracepoint_fire_arg), *argc);
-    for (int i = 0; i < *argc; i++)
+    int i;
+    for (i = 0; i < *argc; i++)
     {
       VALUE val = rb_ary_entry(vargs, i);
       switch(TYPE(val))

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'singleton'
-
 module StaticTracing
   class Configuration
     module Modes
@@ -41,7 +39,7 @@ module StaticTracing
     end
 
     def add_tracer(tracer)
-      StaticTracing.tracers << tracer
+      Tracers.add(tracer)
     end
 
     private

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

@@ -3,38 +3,6 @@
 module StaticTracing
   module Platform
     extend self
-    UNSUPPORTED_POST_INSTALL_MESSAGE = %(
-    WARNING: You have installed this on an unsupported platform, somehow.
-
-    You should verify for yourself that the behavior on your platform is safe.
-    )
-
-    LINUX_POST_INSTALL_MESSAGE = %(
-    WARNING: you will need a new kernel (4.14+) that supports eBPF.
-
-    You should use the newest possible version of bpftrace
-    ).freeze
-
-    DARWIN_POST_INSTALL_MESSAGE = %(
-    WARNING: tracing with dtrace will not work with SIP enabled.
-
-    SIP is enabled by default on recent versions of OSX. You can
-    check if SIP is enabled with:
-
-        csrutil status
-
-    If you want to test your probes out locally, you will need to at
-    least allow dtrace. To do this, you must reboot into recovery mode
-    by holding CMD + R while your Mac is booting. Once it has booted,
-    open a terminal and type:
-
-        csrutil clear
-        csrutil enable --without-dtrace
-
-    After this, you should be able to use dtrace on the tracepoints you
-    define here. If it still doesn't work, you can disable SIP entirely
-    but this is not recommended for security purposes.
-    ).freeze
 
     def linux?
       /linux/.match(RUBY_PLATFORM)
@@ -44,16 +12,8 @@ module StaticTracing
       /darwin/.match(RUBY_PLATFORM)
     end
 
-    def post_install_message
-      message = begin
-        if linux?
-          LINUX_POST_INSTALL_MESSAGE
-        elsif darwin?
-          DARWIN_POST_INSTALL_MESSAGE
-        else
-          UNSUPPORTED_POST_INSTALL_MESSAGE
-        end
-      end
+    def supported_platform?
+      linux? || darwin?
     end
   end
 end

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

@@ -42,8 +42,7 @@ module StaticTracing
     attr_reader :namespace
 
     def initialize(namespace)
-      if StaticTracing::Platform.linux? ||
-         StaticTracing::Platform.darwin?
+      if StaticTracing::Platform.supported_platform?
         provider_initialize(namespace)
       else
         StaticTracing.issue_disabled_tracepoints_warning

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

@@ -26,8 +26,7 @@ module StaticTracing
       validate_args(args)
       @args = args
 
-      if StaticTracing::Platform.linux? ||
-         StaticTracing::Platform.darwin?
+      if StaticTracing::Platform.supported_platform?
         tracepoint_initialize(provider, name, args)
       else
         StaticTracing.issue_disabled_tracepoints_warning

data/lib/ruby-static-tracing/{tracers → tracer}/base.rb

@@ -1,13 +1,13 @@
 require 'unmixer'
 using Unmixer
 
-require 'ruby-static-tracing/tracers/helpers'
+require 'ruby-static-tracing/tracer/helpers'
 
 module StaticTracing
-  module Tracers
+  module Tracer
     class Base
       class << self
-        include Tracers::Helpers
+        include Tracer::Helpers
 
         def register(klass, *method_names, provider: nil)
           provider ||= underscore(klass.name)

data/lib/ruby-static-tracing/{tracers → tracer}/concerns/latency_tracer.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'ruby-static-tracing/tracers/latency_tracer'
-
 module StaticTracing
-  module Tracers
+  module Tracer
     module Concerns
-      module LatencyTracer
+      module Latency
         def self.included(base)
           methods = base.public_instance_methods(false)
-          StaticTracing::Tracers::LatencyTracer.register(base, methods)
+          StaticTracing::Tracer::Latency.register(base, methods)
         end
       end
     end

data/lib/ruby-static-tracing/{tracers → tracer}/helpers.rb

@@ -1,5 +1,5 @@
 module StaticTracing
-  module Tracers
+  module Tracer
     module Helpers
       extend self
 

data/lib/ruby-static-tracing/{tracers/latency_tracer.rb → tracer/latency.rb}

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
-require 'ruby-static-tracing/tracers/base'
 
 module StaticTracing
-  module Tracers
-    class LatencyTracer < Base
+  module Tracer
+    class Latency < Base
       set_wrapping_function -> (*args, &block) {
         start_time = StaticTracing.nsec
         result = super(*args, &block)
         duration = StaticTracing.nsec - start_time
         method_name = __method__.to_s
-        provider = Tracers::Helpers.underscore(self.class.name)
+        provider = Tracer::Helpers.underscore(self.class.name)
         Tracepoints.get(provider, method_name).fire(method_name, duration)
         result
       }

data/lib/ruby-static-tracing/{tracers/stack_tracer.rb → tracer/stack.rb}

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'ruby-static-tracing/tracers/base'
-
 module StaticTracing
-  module Tracers
-    class StackTracer < Base
+  module Tracer
+    class Stack < Base
       set_wrapping_function -> (*args, &block) {
         current_stack = self.send(:caller).join("\n")
         method_name = __method__.to_s
-        provider = Tracers::Helpers.underscore(self.class.name)
+        provider = Tracer::Helpers.underscore(self.class.name)
         Tracepoints.get(provider, method_name).fire(method_name, current_stack)
         super(*args, &block)
       }

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

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

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

@@ -1,4 +1,42 @@
 # frozen_string_literal: true
 
-require_relative 'tracers/latency_tracer'
-require_relative 'tracers/stack_tracer'
+module StaticTracing
+  class Tracers
+    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
+
+      def enable!
+        tracers.each(&:enable!)
+      end
+
+      def disable!
+        tracers.each(&:disable!)
+      end
+
+      def clean
+        @tracers = []
+      end
+
+      private
+
+      def tracers
+        @tracers ||= []
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StaticTracing
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/ruby-static-tracing.rb

@@ -8,6 +8,7 @@ require 'ruby-static-tracing/provider'
 require 'ruby-static-tracing/tracepoint'
 require 'ruby-static-tracing/tracepoints'
 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
@@ -45,7 +46,7 @@ module StaticTracing
   # Overwrite the definition of all functions that are enabled
   # with a wrapped version that has tracing enabled
   def enable!
-    tracers.each(&:enable!)
+    StaticTracing::Tracers.enable!
     StaticTracing::Provider.enable!
     @enabled = true
   end
@@ -53,20 +54,11 @@ module StaticTracing
   # Overwrite the definition of all functions to their original definition,
   # no longer wrapping them
   def disable!
-    tracers.each(&:disable!)
+    StaticTracing::Tracers.disable!
     StaticTracing::Provider.disable!
     @enabled = false
   end
 
-  # Retrieves a hash of all registered providers
-  def providers
-    @providers ||= {}
-  end
-
-  def tracers
-    @tracers ||= []
-  end
-
   def toggle_tracing!
     enabled? ? disable! : enable!
   end
@@ -76,4 +68,4 @@ module StaticTracing
   end
 end
 
-require 'ruby-static-tracing/ruby_static_tracing' if StaticTracing::Platform.linux? || StaticTracing::Platform.darwin?
+require 'ruby-static-tracing/ruby_static_tracing' if StaticTracing::Platform.supported_platform?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-static-tracing
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Dale Hamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unmixer
@@ -161,14 +161,15 @@ files:
 - lib/ruby-static-tracing/provider.rb
 - lib/ruby-static-tracing/tracepoint.rb
 - lib/ruby-static-tracing/tracepoints.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/tracers/base.rb
-- lib/ruby-static-tracing/tracers/concerns/latency_tracer.rb
-- lib/ruby-static-tracing/tracers/helpers.rb
-- lib/ruby-static-tracing/tracers/latency_tracer.rb
-- lib/ruby-static-tracing/tracers/stack_tracer.rb
 - lib/ruby-static-tracing/version.rb
-homepage: https://github.com/shopify/ruby-static-tracing
+homepage: https://github.com/dalehamel/ruby-static-tracing
 licenses:
 - MIT
 metadata: {}