perfetto 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 336d2d67b2921461a66687b0a06fca3ef0e925cbdc83e028bdbf2863ef3012d4
-  data.tar.gz: 3dc3d8b63d9029dcc10d5250f156663d5248da727652aa0b3cce42a55ac856af
+  metadata.gz: 7384eed21d076be3de57b5afa9fc886e979ccc4d89e167afc61e2800314d61f4
+  data.tar.gz: f6c71a99835e93c07734bfd790aba1d80fa86879327f2357007c184edbd0a619
 SHA512:
-  metadata.gz: c2771fce6b5aa3b804f6c79d7e64fde0af8238ba25d6325707634d5612a05254df7c6dbf0b34d78d8c2f9c9f502f331e0dd954805167993378f28540cc474c57
-  data.tar.gz: 2a006c86b49bad07a0a0d7117c65a5813dd9a957cb24992aee9b419efe0ac3644a92f6d63338a994b97e9ef800b25dc2bc941d0434a42c20443eb04c5b7aad5d
+  metadata.gz: c77bd5af96cb578659982e03d292893426a64d7d8ef7618ea5ab782005c519c6e2244b4d6cd7885fc2b9f2e76f6551e1fb3bd67b803552df3c8b8e861f671c38
+  data.tar.gz: e33c6fe69f65d1dcd2ed3a81ba6e2e699b85b89932511233638900514921d310dbf305f17bb0bb899fe39ac2593bac48667fcca452fa53f9fdf0467cf7a90923

data/README.md

@@ -4,7 +4,9 @@
 
 https://ui.perfetto.dev/
 
-# Usage
+## Usage
+
+### Basic
 
 ```ruby
 require "perfetto"
@@ -83,3 +85,26 @@ Perfetto.stop_tracing "example.pftrace"
 ```
 
 ![example](./example/example.png)
+
+### Rack Middleware
+
+```ruby
+# frozen_string_literal: true
+
+require "sinatra/base"
+require "perfetto"
+
+Perfetto.setup enable_tracing: true
+
+class Server < Sinatra::Base
+  use Perfetto::Middleware
+
+  get "/" do
+    "Hello World"
+  end
+end
+
+Perfetto.start_tracing
+Server.run!
+Perfetto.stop_tracing "middleware.pftrace"
+```

data/lib/perfetto/interceptor.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/MethodLength
+
 module Perfetto
   # To intercept method calls in other classes
   module Interceptor
@@ -39,7 +42,6 @@ module Perfetto
       def perfetto_trace_instance_method(method_name)
         return if method_name.to_s.start_with? "_pfi_"
 
-        # warn "Perfetto[InstanceMethod]: #{name}##{method_name}"
         perfetto_traced_instance_methods << method_name
 
         original_method = instance_method(method_name)
@@ -56,17 +58,16 @@ module Perfetto
       end
 
       def perfetto_trace_class_method(method_name)
-        return if method_name.to_s == "singleton_method_added" || method_name.to_s.start_with?("_pfc_")
+        return if method_name.to_s.start_with? "_pfc_"
 
-        # warn "Perfetto[ClassMethod]: #{name}.#{method_name}"
         perfetto_traced_class_methods << method_name
 
         original_method = method(method_name)
         singleton_class.send(:alias_method, "_pfc_#{method_name}", method_name)
 
         define_singleton_method(method_name) do |*args, **kwargs, &block|
-          category = self.name
-          task_name = "#{self.name}.#{method_name}"
+          category = name
+          task_name = "#{name}.#{method_name}"
           Perfetto.trace_event_begin category, task_name
           original_method.call(*args, **kwargs, &block)
         ensure
@@ -106,3 +107,5 @@ module Perfetto
     end
   end
 end
+# rubocop:enable Metrics/AbcSize
+# rubocop:enable Metrics/MethodLength

data/lib/perfetto/middleware.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Perfetto
+  # Rack middleware
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+    end
+
+    if Perfetto::Configure.enable_tracing
+      def call(env)
+        category = "RackMiddleware"
+        method = env["REQUEST_METHOD"] || "UNKNOWN"
+        path = env["PATH_INFO"] || "UNKNOWN PATH"
+        task_name = "#{method} #{path}"
+        Perfetto.trace_event_begin_with_debug_info category, task_name, "env", env.to_json
+        begin
+          @app.call(env)
+        ensure
+          Perfetto.trace_event_end category
+        end
+      end
+    else # Stub methods
+      def call(env)
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/perfetto/perfetto.rb

@@ -13,7 +13,7 @@ module Perfetto
       start_tracing_native Configure.buffer_size_kb
     end
 
-    def self.stop_tracing(trace_file_name = "#{Time.now.strftime("%Y%m%d%H%M%S")}.pftrace")
+    def self.stop_tracing(trace_file_name = "#{Time.now.strftime("%Y%m%d-%H-%M-%S")}.pftrace")
       stop_tracing_native trace_file_name
     end
 

data/lib/perfetto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Perfetto
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/perfetto.rb

@@ -20,5 +20,7 @@ module Perfetto
     require_relative "perfetto/perfetto"
     # Instrumentation Helper
     require_relative "perfetto/interceptor"
+    # Rack middleware
+    require_relative "perfetto/middleware"
   end
 end

data/perfetto.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/perfetto/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "perfetto"
+  spec.version = Perfetto::VERSION
+  spec.authors = ["Kowalski Dark"]
+  spec.email = ["github@akenonet.com"]
+
+  spec.summary = "Yet another event tracing library for Ruby."
+  spec.description = "Yet another event tracing library for Ruby."
+  spec.homepage = "https://github.com/yet-another-ai/perfetto.rb"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib ext]
+  spec.extensions = ["ext/perfetto/extconf.rb"]
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfetto
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kowalski Dark
@@ -35,8 +35,10 @@ files:
 - lib/perfetto/configure.rb
 - lib/perfetto/core_ext/configurable.rb
 - lib/perfetto/interceptor.rb
+- lib/perfetto/middleware.rb
 - lib/perfetto/perfetto.rb
 - lib/perfetto/version.rb
+- perfetto.gemspec
 - sig/perfetto.rbs
 homepage: https://github.com/yet-another-ai/perfetto.rb
 licenses: []