ruby-static-tracing 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ac00c672308f4c2f3f12935d4a64ed1a0ac190c09a32f0b6ef5f684bd05d4d1
-  data.tar.gz: c1ea10f2f75a1f230789d4dd093af6760a2f949be0cec0b5f30fe66c8b1dc8ad
+  metadata.gz: 1a43ab444f18179cf5d5cdcd677d5a2043a0849adaa4df605920f9869ed0191e
+  data.tar.gz: 49086fa125a903a9f48923ba22de6999fa01f87dde54e35dc5064941155135d1
 SHA512:
-  metadata.gz: d619816b75f523a10ef9e7f4ecfbc5d5067483661a9931d0199a012406313ab8fa3092ca71bf65fcfdc3e89ac222e6fa7b8848f66d965ab042c0eb4a73c0edcc
-  data.tar.gz: c1c98d614ec92e106a08b83492ec5f9a8c8017a749d394950ee633148927277a470111b5f918eaa16053fc5099e391807baa5ff5cf6c56c32420f193b11bb806
+  metadata.gz: 0d987dcb22dd0fbcf4294f6ba33792d383c289c52a241fd2579f36669330fc6935b928de947c9e51e48f9b22f751a79cb0a22be6ec7005605ebcb2e209f6c9f5
+  data.tar.gz: f11c5777711c104064de7664ce784a7e84fb1924b539011cf4bde22572eb62d432f31c83b024d4fe7401753a0621ce03fcb29d1ed5e42955f00e31b5ff83c414

data/lib/ruby-static-tracing.rb

@@ -6,7 +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/tracepoints'
 require 'ruby-static-tracing/configuration'
 require 'ruby-static-tracing/tracer'
 require 'ruby-static-tracing/tracers'

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

@@ -9,7 +9,7 @@ module StaticTracing
     attr_accessor :name
 
     # Provider couldn't be found in collection
-    class ProviderNotFound < StandardError; end
+    class ProviderMissingError < StandardError; end
 
     class << self
       # Gets a provider by name
@@ -21,7 +21,7 @@ module StaticTracing
       # Gets a provider instance by name
       def fetch(namespace)
         providers.fetch(namespace) do
-          raise ProviderNotFound
+          raise ProviderMissingError
         end
       end
 
@@ -37,11 +37,6 @@ module StaticTracing
         providers.values.each(&:disable)
       end
 
-      def clean
-        # FIXME: this should free first
-        @providers = {}
-      end
-
       private
 
       # A global collection of providers
@@ -58,9 +53,8 @@ module StaticTracing
       if tracepoint.is_a?(String)
         tracepoint = Tracepoint.new(namespace, tracepoint, *args)
       elsif tracepoint.is_a?(Tracepoint)
-        @tracepoints << tracepoint
+        @tracepoints[tracepoint.name] = tracepoint
       end
-      tracepoint
     end
 
     # Enable the provider, loading it into memory
@@ -82,6 +76,7 @@ module StaticTracing
     # Only supported on systems (linux) where backed by file
     def path; end
 
+    # Completely removes the provider
     def destroy; end
 
     private
@@ -95,7 +90,7 @@ module StaticTracing
         StaticTracing.issue_disabled_tracepoints_warning
       end
       @namespace = namespace
-      @tracepoints = []
+      @tracepoints = {}
     end
   end
 end

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

@@ -2,6 +2,17 @@
 
 module StaticTracing
   class Tracepoint
+    class TracepointMissingError < StandardError; end
+
+    class << self
+      # Gets a trace instance by provider name and name
+      def fetch(provider, name)
+        Provider.fetch(provider).tracepoints.fetch(name.to_s) do
+          raise TracepointMissingError
+        end
+      end
+    end
+
     class InvalidArgumentError < StandardError
       def initialize(argument, expected_type)
         error_message = <<~ERROR_MESSAGE
@@ -45,6 +56,7 @@ module StaticTracing
       _fire_tracepoint(values)
     end
 
+    # The provider this tracepoint is defined on
     def provider
       Provider.fetch(@provider_name)
     end

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

@@ -12,7 +12,8 @@ module StaticTracing
         include Tracer::Helpers
 
         def register(klass, *method_names, provider: nil)
-          provider ||= underscore(klass.name)
+          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)
@@ -42,10 +43,12 @@ module StaticTracing
 
             def add_override(methods)
               methods.each do |method|
-                Tracepoints.add(@provider, method, @data_types)
+                Tracepoint.new(@provider.namespace, method.to_s, *@data_types)
                 define_method(method.to_s, @wrapping_function)
               end
             end
+
+            attr_reader :provider
           end
         end
 

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

@@ -9,7 +9,9 @@ module StaticTracing
         duration = StaticTracing.nsec - start_time
         method_name = __method__.to_s
         provider = Tracer::Helpers.underscore(self.class.name)
-        Tracepoints.get(provider, method_name).fire(method_name, duration)
+        # 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
       }
 

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

@@ -9,7 +9,8 @@ module StaticTracing
         current_stack = send(:caller).join("\n")
         method_name = __method__.to_s
         provider = Tracer::Helpers.underscore(self.class.name)
-        Tracepoints.get(provider, method_name).fire(method_name, current_stack)
+        Tracepoint.fetch(provider, method_name).fire(method_name, current_stack)
+
         super(*args, &block)
       }
 

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

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

data/lib/tasks/docker.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Quick helpers to get a dev env set up
+namespace :docker do
+  desc 'Builds the development docker image'
+  task :build do
+    system("docker build -f #{File.join(DOCKER_DIR, 'Dockerfile.ci')} #{DOCKER_DIR} -t quay.io/dalehamel/ruby-static-tracing")
+  end
+
+  desc 'Runs the development docker image'
+  task :run do
+    `docker run --privileged --name ruby-static-tracing-#{Time.now.getutc.to_i} -v $(pwd):/app -d quay.io/dalehamel/ruby-static-tracing:latest /bin/sh -c "sleep infinity"`.strip
+    system("docker exec -ti #{latest_running_container_id} /app/vagrant/debugfs.sh")
+  end
+
+  desc 'Provides a shell within the development docker image'
+  task :shell do
+    system("docker exec -ti #{latest_running_container_id} bash")
+  end
+
+  desc 'Build and install the gem'
+  task :install do
+    system("docker exec -ti #{latest_running_container_id} bash -c 'bundle install && bundle exec rake install'")
+  end
+  desc 'Runs integration tests within the development docker image'
+  task :integration do
+    system("docker exec -ti #{latest_running_container_id} bash -c 'bundle install && bundle exec rake clean && bundle exec rake build && bundle exec rake integration'")
+  end
+
+  desc 'Wrap running test in docker'
+  task :test do
+    exit system("docker exec -ti #{latest_running_container_id} \
+         bash -c 'mv vendor vendor.bak; bundle install && \
+                 bundle exec rake test; err=$?;
+                 rm -rf vendor; mv vendor.bak vendor;
+                 exit $err'")
+  end
+
+  desc 'Wrap running Rubocop in docker'
+  task :rubocop do
+    exit system("docker exec -ti #{latest_running_container_id} \
+         bash -c 'mv vendor ../vendor.bak; bundle install && \
+                 bundle exec rake clean;
+                 bundle exec rake rubocop; err=$?;
+                 rm -rf vendor; mv ../vendor.bak vendor;
+                 exit $err'")
+  end
+
+  desc 'Check C files for linting issues'
+  task :clangfmt do
+    exit system("docker exec -ti #{latest_running_container_id} \
+         bash -c 'mv vendor vendor.bak; bundle install && \
+                 bundle exec rake clangfmt; err=$?;
+                 rm -rf vendor; mv vendor.bak vendor;
+                 exit $err'")
+  end
+
+  desc 'Cleans up all development docker images for this project'
+  task :clean do
+    system('docker container ls --quiet --filter name=ruby-static-tracing* | xargs -I@ docker container kill @')
+  end
+
+  desc 'Pulls development image'
+  task :pull do
+    system('docker pull quay.io/dalehamel/ruby-static-tracing')
+  end
+
+  desc 'Push development image'
+  task :push do
+    system('docker push quay.io/dalehamel/ruby-static-tracing')
+  end
+
+  desc 'Fully set up a development docker image, and get a shell'
+  task up: %i[build run shell]
+
+  def latest_running_container_id
+    container_id = `docker container ls --latest --quiet --filter status=running --filter name=ruby-static-tracing*`.strip
+    if container_id.empty?
+      raise 'No containers running, please run rake docker:run and then retry this task'
+    else
+      container_id
+    end
+  end
+end

data/lib/tasks/vagrant.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+namespace :vagrant do
+  desc 'Sets up a vagrant VM, needed for our development environment.'
+  task :up do
+    system('vagrant up')
+  end
+
+  desc 'Provides a shell within vagrant.'
+  task :ssh do
+    system('vagrant ssh')
+  end
+
+  desc 'Enters a shell within our development docker image, within vagrant.'
+  task :shell do
+    system("vagrant ssh -c 'cd /vagrant && bundle exec rake docker:shell'")
+  end
+
+  desc 'Runs tests within the development docker image, within vagrant'
+  task :tests do
+    system("vagrant ssh -c 'cd /vagrant && bundle exec rake docker:tests'")
+  end
+
+  desc 'Runs integration tests within the development docker image, within vagrant'
+  task :integration do
+    system("vagrant ssh -c 'cd /vagrant && bundle exec rake docker:integration'")
+  end
+
+  desc 'Cleans up the vagrant VM'
+  task :clean do
+    system('vagrant destroy')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-static-tracing
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Dale Hamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unmixer
@@ -188,7 +188,6 @@ files:
 - lib/ruby-static-tracing/platform.rb
 - 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
@@ -197,6 +196,8 @@ files:
 - 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
 homepage: https://github.com/dalehamel/ruby-static-tracing
 licenses:
 - MIT

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module StaticTracing
-  # FIXME: - why do we need this class? We should store tracepoints
-  # on providers, and get the list of all tracepoints from the list of providers
-  class Tracepoints
-    class ProviderMissingError < StandardError; end
-    class TracepointMissingError < StandardError; end
-
-    class << self
-      def add(provider, name, data_types)
-        tracepoints[provider][name.to_s] ||= begin
-          StaticTracing::Tracepoint.new(provider, name.to_s, *data_types)
-        end
-      end
-
-      def get(provider, name)
-        tracepoints
-          .fetch(provider) { raise_error(ProviderMissingError) }
-          .fetch(name) { raise_error(TracepointMissingError) }
-      end
-
-      def clean
-        @tracepoints ||= Hash.new { |hash, key| hash[key] = {} }
-      end
-
-      private
-
-      def tracepoints
-        @tracepoints ||= Hash.new { |hash, key| hash[key] = {} }
-      end
-
-      def raise_error(error)
-        raise error
-      end
-    end
-  end
-end