callstacking-rails 0.1.26 → 0.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd320ce87181c823d9c35ab0e8a2b40a949f5e166d0fa0d3ee1a8f82b40fadd
-  data.tar.gz: 7312012b3df0a7d1ddcd5eaa050ea396ccbda9efcf76a7ea0182bff03d984fbd
+  metadata.gz: 8fa2fbfc31289e2837d702c573eb0c1f3bbd35c87a68edaedcc8345e82359003
+  data.tar.gz: 98228a480f6e39f17a4de540757bee6e23a5fc10db88af713cbbc71b41e3d1ca
 SHA512:
-  metadata.gz: b5fb76c2bf28e556b7111f6a51c74f7599407b9a1a158befd6fd42ef327e69e50d8dc4d147927cb040ec7241295296f8ac6f611e82ea3ba59c6a739b706e023f
-  data.tar.gz: 6aafeb709ef9c084730bc7fd20041b3ae2004702fa654d5fa3f0710020def68c1f15eb58a380afa0e6c3df6fd2e52422eabb1f1c76d1c403ccf0ebbcb257544d
+  metadata.gz: 142da9385fabbd53368c9e488dee76077e26fca257651447d11af284274d698c1ed09620e990ce0139cbdebbdd5718809f5dccdd9993f9ab8aadc95db78ab8b8
+  data.tar.gz: 90f40435ef2e0d6a95a3301c33c6023aa7d270ee442d47c4a49a92b7abc5102ba226dba3e9b8cf8ab041c6a4afab18b05f7d25a19a14ee3c14da41912c76a979

data/README.md

@@ -43,7 +43,17 @@ And then execute:
 ```bash
 $ bundle
 ```
-   
+
+Add the following to your `ApplicationController`:
+
+```
+class ApplicationController < ActionController::Base
+  include Callstacking::Rails::Helpers::InstrumentHelper
+
+  around_action :callstacking_setup, if: -> { params[:debug] == '1' }
+```
+
+
 Register an account at callstacking.com
 ```bash
 callstacking-rails register
@@ -57,17 +67,9 @@ callstacking-rails setup
             
 You're now ready to start tracing.
 
-## Usage
+## CLI Setup
 Usage:
 
-> callstacking-rails enable
-
-Enables the callstacking tracing.
-
-> callstacking-rails disable
-
-Disables the callstacking tracing.
-
 > callstacking-rails register
 
 Opens a browser window to register as a callstacking.com user.
@@ -86,6 +88,9 @@ By setting the RAILS_ENV environment you can maintain multiple settings.
 
 Questions? Create an issue: https://github.com/callstacking/callstacking-rails/issues
 
+## Tracing
+To initiate a trace, append the `debug=1` param to the URL of the page you want to trace. As outlined in the `around_action` you setup above.
+
 ## Environment
 
 You can provide the auth token via the `CALLSTACKING_AUTH_TOKEN` environment variable.
@@ -95,10 +100,12 @@ Your API token values can be viewed at https://callstacking.com/api_tokens
 You can enable/disable tracing via the `CALLSTACKING_ENABLED` environment variable (false|true).
 
 ## Trace Output
-When you open a page for your app, once the page has rendered, you will see a `💥` icon on the right hand side.
+For HTML requests, once your page has rendered, you will see a `💥` icon on the right hand side.
 
 Click the icon and observe the full callstack context.
 
+For headless API requests, visit https://callstacking.com/traces to view your traces.
+
 ## Tests
 ``
 rake app:test:all

data/lib/callstacking/rails/engine.rb

@@ -11,8 +11,8 @@ require "callstacking/rails/client/base"
 require "callstacking/rails/client/authenticate"
 require "callstacking/rails/client/trace"
 require "callstacking/rails/cli"
-require "callstacking/rails/traces_helper"
 require "callstacking/rails/time_based_uuid"
+require "callstacking/rails/helpers/instrument_helper"
 
 module Callstacking
   module Rails
@@ -32,41 +32,26 @@ module Callstacking
         app.config.assets.precompile << "checkpoint_rails_manifest.js"
       end
 
-      initializer 'local_helper.action_controller' do
-        ActiveSupport.on_load :action_controller do
-          include Callstacking::Rails::TracesHelper
-        end
-      end
-
       config.after_initialize do
-        if @@settings.enabled?
-          puts "Call Stacking enabled (#{Callstacking::Rails::Env.environment})"
-
-          ActionController::Base.send :after_action do
-            inject_hud(@@settings)
-          end
-
-          @@loader = Callstacking::Rails::Loader.new(@@instrumenter,
-                                                     excluded: @@settings.excluded + EXCLUDED_TEST_CLASSES)
-          @@loader.on_load
-
-          @@trace.request_tracing
-        else
-          puts "Call Stacking disabled (#{Callstacking::Rails::Env.environment})"
-        end
+        puts "Call Stacking enabled (#{Callstacking::Rails::Env.environment})"
+          
+        @@loader = Callstacking::Rails::Loader.new(@@instrumenter, excluded: @@settings.excluded + EXCLUDED_TEST_CLASSES)
+        @@loader.on_load
       end
 
-      def self.start_tracing
-        return false if @@settings.disabled?
+      def self.start_tracing(controller)
+        @@settings.enable!
+        @@instrumenter.enable!(@@loader.klasses.to_a)
+        @@trace.begin_trace(controller)
 
-        @@instrumenter.enable!(@@loader.klasses)
         true
       end
 
-      def self.stop_tracing
-        return false if @@settings.disabled?
-
+      def self.stop_tracing(controller)
+        @@settings.disable!
         @@instrumenter.disable!
+        @@trace.end_trace(controller)
+
         true
       end
     end

data/lib/callstacking/rails/helpers/heads_up_display_helper.rb

@@ -0,0 +1,55 @@
+require 'action_view/helpers'
+require "action_view/context.rb"
+
+module Callstacking
+  module Rails
+    module Helpers
+      module HeadsUpDisplayHelper
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::JavaScriptHelper
+        include ActionView::Context
+
+        def hud(url)
+          frame_url = "#{url || Callstacking::Rails::Settings::PRODUCTION_URL}/traces/#{Callstacking::Rails::Trace.current_trace_id}/print"
+
+          body = []
+          body << (content_tag(:div, data: { turbo: false },
+                               style: 'top: 50%; right: 10px; font-size: 24pt; :hover{text-shadow: 1px 1px 2px #000000};
+                            padding: 0px; position: fixed; height: 50px; width: 40px; cursor: pointer;',
+                               onclick: 'document.getElementById("callstacking-debugger").style.display = "unset";
+                              document.getElementById("callstacking-close").style.display = "unset";') do
+            "<span title='ctrl-d'><center>#{Callstacking::Rails::Trace::ICON}</center></span>".html_safe
+          end)
+
+          body << (content_tag(:iframe, src: frame_url, id: 'callstacking-debugger', data: { turbo: false },
+                               style: "width: 50%; height: 100%; overflow: scroll; top: 20px; right: 20px; position: fixed;
+                            z-index: 99; opacity: 1.0; background-color: #FFF; color: #000; border: 1px solid;
+                            margin: 0; padding: 0; box-shadow: 5px 5px; display: none;") do
+          end)
+
+          body << (javascript_tag('
+          document.onkeyup = function(e) {
+            // Mac - option-d   Win - alt-d
+            if (e.ctrlKey && e.which == 68) {
+              if (document.getElementById("callstacking-debugger").style.display === "none") {
+                document.getElementById("callstacking-debugger").style.display = "block";
+                document.getElementById("callstacking-debugger").contentDocument.location.reload(true);
+                document.getElementById("callstacking-debugger").focus();
+              } else {
+                document.getElementById("callstacking-debugger").style.display = "none";
+              }
+            }
+          };'))
+
+          body.join
+        end
+
+        def inject_hud(settings, request, response)
+          if request.format.html?
+            response.body = response.body.sub(/<\/body>/i, "#{hud(settings.url)}</body>")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/callstacking/rails/helpers/instrument_helper.rb

@@ -0,0 +1,16 @@
+module Callstacking
+  module Rails
+    module Helpers
+      module InstrumentHelper
+        extend ActiveSupport::Concern
+        def callstacking_setup
+          Callstacking::Rails::Engine.start_tracing(self)
+
+          yield
+        ensure
+          Callstacking::Rails::Engine.stop_tracing(self)
+        end
+      end
+    end
+  end
+end

data/lib/callstacking/rails/loader.rb

@@ -20,7 +20,6 @@ module Callstacking
           if path =~ /#{::Rails.root.to_s}/ &&
             !klasses.include?(klass) &&
             !excluded_klass
-              instrumenter.instrument_klass(klass)
               klasses << klass
           end
         end

data/lib/callstacking/rails/settings.rb

@@ -37,11 +37,18 @@ module Callstacking
       def self.enable!
         ::Rails.cache.write(CACHE_KEY, true)
       end
+      def enable!
+        self.class.enable!
+      end
 
       def self.disable!
         ::Rails.cache.write(CACHE_KEY, false)
       end
 
+      def disable!
+        self.class.disable!
+      end
+
       def enabled?
         return ::Rails.cache.read(CACHE_KEY) unless ::Rails.cache.read(CACHE_KEY).nil?
         return false if ENV[ENV_KEY] == 'false'

data/lib/callstacking/rails/trace.rb

@@ -1,9 +1,12 @@
 require "rails"
 require 'active_support/core_ext/object/deep_dup'
+require "callstacking/rails/helpers/heads_up_display_helper"
 
 module Callstacking
   module Rails
     class Trace
+      include Callstacking::Rails::Helpers::HeadsUpDisplayHelper
+      
       attr_accessor :spans, :client, :lock
       attr_reader :settings
       cattr_accessor :current_trace_id
@@ -13,39 +16,36 @@ module Callstacking
       MAX_TRACE_ENTRIES = 3000
 
       def initialize(spans)
-        @traces = []
-        @spans  = spans
+        @traces   = []
+        @spans    = spans
         @settings = Callstacking::Rails::Settings.new
 
-        @lock   = Mutex.new
-        @client = Callstacking::Rails::Client::Trace.new(settings.url, settings.auth_token)
+        @lock     = Mutex.new
+        @client   = Callstacking::Rails::Client::Trace.new(settings.url, settings.auth_token)
 
         init_uuids(nil, nil)
         init_callbacks(nil)
       end
 
-      def request_tracing
-        tuid     = nil
-        trace_id = nil
+      def begin_trace(controller)
+        @trace_id, @tuid = init_uuids(controller.request&.request_id || SecureRandom.uuid, TimeBasedUUID.generate)
+        init_callbacks(@tuid)
 
-        ActiveSupport::Notifications.subscribe("start_processing.action_controller") do |_name, _start, _finish, _id, payload|
-          trace_id, tuid = init_uuids(payload[:request]&.request_id || SecureRandom.uuid, TimeBasedUUID.generate)
-          init_callbacks(tuid)
+        start_request(@trace_id, @tuid,
+                      controller.action_name, controller.controller_name,
+                      controller.action_name, controller.request.format, ::Rails.root.to_s,
+                      controller.request&.original_url,
+                      controller.request.headers, controller.request.params)
+      end
 
-          start_request(trace_id, tuid,
-                        payload[:method], payload[:controller],
-                        payload[:action], payload[:format], ::Rails.root.to_s,
-                        payload[:request]&.original_url || payload[:path],
-                        payload[:headers], payload[:params])
-        end
+      def end_trace(controller)
+        complete_request(@trace_id, @tuid,
+                         controller.action_name, controller.controller_name,
+                         controller.action_name, controller.request.format,
+                         controller.request&.original_url,
+                         @traces, MAX_TRACE_ENTRIES)
 
-        ActiveSupport::Notifications.subscribe("process_action.action_controller") do |_name, _start, _finish, _id, payload|
-          complete_request(trace_id, tuid,
-                           payload[:method], payload[:controller],
-                           payload[:action], payload[:format],
-                           payload[:request]&.original_url || payload[:path],
-                           @traces, MAX_TRACE_ENTRIES)
-        end
+        inject_hud(@settings, controller.request, controller.response)
       end
 
       private
@@ -63,7 +63,7 @@ module Callstacking
       def init_uuids(trace_id, tuid)
         Callstacking::Rails::Trace.current_trace_id = trace_id
         Callstacking::Rails::Trace.current_tuid = tuid
-        
+
         return trace_id, tuid
       end
 

data/lib/callstacking/rails/version.rb

@@ -1,5 +1,5 @@
 module Callstacking
   module Rails
-    VERSION = "0.1.26"
+    VERSION = "0.1.27"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callstacking-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.26
+  version: 0.1.27
 platform: ruby
 authors:
 - Jim Jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,8 @@ files:
 - lib/callstacking/rails/client/trace.rb
 - lib/callstacking/rails/engine.rb
 - lib/callstacking/rails/env.rb
+- lib/callstacking/rails/helpers/heads_up_display_helper.rb
+- lib/callstacking/rails/helpers/instrument_helper.rb
 - lib/callstacking/rails/instrument.rb
 - lib/callstacking/rails/loader.rb
 - lib/callstacking/rails/settings.rb
@@ -115,7 +117,6 @@ files:
 - lib/callstacking/rails/spans.rb
 - lib/callstacking/rails/time_based_uuid.rb
 - lib/callstacking/rails/trace.rb
-- lib/callstacking/rails/traces_helper.rb
 - lib/callstacking/rails/version.rb
 - lib/tasks/checkpoint/rails_tasks.rake
 homepage: https://github.com/callstacking/callstacking-rails

data/lib/callstacking/rails/traces_helper.rb

@@ -1,51 +0,0 @@
-require 'action_view/helpers'
-require "action_view/context.rb"
-
-module Callstacking
-  module Rails
-    module TracesHelper
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::JavaScriptHelper
-      include ActionView::Context
-
-      def hud(url)
-        frame_url = "#{url || Callstacking::Rails::Settings::PRODUCTION_URL}/traces/#{Callstacking::Rails::Trace.current_trace_id}/print"
-
-        body = []
-        body << (content_tag( :div, data: { turbo:false },
-                    style: 'top: 50%; right: 10px; font-size: 24pt; :hover{text-shadow: 1px 1px 2px #000000};
-                            padding: 0px; position: fixed; height: 50px; width: 40px; cursor: pointer;',
-                    onclick: 'document.getElementById("callstacking-debugger").style.display = "unset";
-                              document.getElementById("callstacking-close").style.display = "unset";') do
-          "<span title='ctrl-d'><center>#{Callstacking::Rails::Trace::ICON}</center></span>".html_safe
-        end)
-        
-        body << (content_tag(:iframe, src: frame_url, id: 'callstacking-debugger', data: { turbo:false },
-                    style: "width: 50%; height: 100%; overflow: scroll; top: 20px; right: 20px; position: fixed;
-                            z-index: 99; opacity: 1.0; background-color: #FFF; color: #000; border: 1px solid;
-                            margin: 0; padding: 0; box-shadow: 5px 5px; display: none;") do
-        end)
-
-        body << (javascript_tag('
-          document.onkeyup = function(e) {
-            // Mac - option-d   Win - alt-d
-            if (e.ctrlKey && e.which == 68) {
-              if (document.getElementById("callstacking-debugger").style.display === "none") {
-                document.getElementById("callstacking-debugger").style.display = "block";
-                document.getElementById("callstacking-debugger").contentDocument.location.reload(true);
-                document.getElementById("callstacking-debugger").focus();
-              } else {
-                document.getElementById("callstacking-debugger").style.display = "none";
-              }
-            }
-          };'))
-        
-        body.join
-      end
-
-      def inject_hud(settings)
-        response.body = response.body.sub(/<\/body>/i, "#{hud(settings.url)}</body>")
-      end
-    end
-  end
-end