callstacking-rails 0.1.29 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a645231d70a30c9296b1ffbd7f99ce8295f571bd7641b6389354f4fbd43ff153
-  data.tar.gz: 50d96385483deacfa0856b4af8cc8e59450d521d3237310735fa759de37f3bcb
+  metadata.gz: 7423b24771b1ee8ad73efbd79f287546e2b92876743424250064541c0a91eb0e
+  data.tar.gz: 79ef13978d8252f26950486c3589b7d8ad2d5414a35683ba95ea0768b6187e52
 SHA512:
-  metadata.gz: 0f7dddf5d3c1f944ce982d2ce5a803cc984dbcf757b29856f289039df9aa09608749c7998f567ca3da6ce0b8edd32289894cc5edd2f1afd8090b6c3416cb4a79
-  data.tar.gz: 8c692f7133164c596e0a39550867a0ee882a882e719c449564c16619fb485a522fbd77150a74ec86ff00b04b3a2ed946f57dcdd7f6385abcb59840e229ecbf63
+  metadata.gz: 52d1c88ad8385cf8f9f228672927fb8bcc3397fd4799e8dd3987885fe68982bbb6a45e32b7bad7ebae8aa02f9362e727636dc3c23f2b98a04427a1662023b8d5
+  data.tar.gz: 6f4ef1b35a429613b39fc898edb8e390711895134a0fddf295a988e9e738a182423fdfb923ae17008af36190086e7ef56189d597dae54def16ff913edcee7dd6

data/README.md

@@ -45,25 +45,18 @@ $ bundle
 ```
 
 ## CLI Setup
-Register an account at callstacking.com:
 
-> callstacking-rails register
+*Step 1:*
+> bundle exec callstacking-rails register
+ 
+The above command will open a browser window and allow you to register an account at callstacking.com.
+       
+*Step 2:*
+> bundle exec callstacking-rails setup
 
-Opens a browser window to register as a callstacking.com user.
+This interactively prompts you for your callstacking.com username/password.
 
-> callstacking-rails setup
-
-Interactively prompts you for your callstacking.com username/password.
-Stores auth details in `~/.callstacking`.
-
-You can have multiple environments.
-The default is `development`.
-
-The `development:` section in the `~/.callstacking` config contains your credentials.
-
-By setting the RAILS_ENV environment you can maintain multiple settings.
-
-Questions? Create an issue: https://github.com/callstacking/callstacking-rails/issues
+The auth details are stored in `~/.callstacking`.
 
 ## Enabling Tracing
                                         
@@ -78,7 +71,7 @@ and for a `debug` param to be set to `1`:
 class ApplicationController < ActionController::Base
   include Callstacking::Rails::Helpers::InstrumentHelper
 
-  around_action :callstacking_setup, if: -> { current_user&.admin? && params[:debug] == '1' }
+  prepend_around_action :callstacking_setup, if: -> { current_user&.admin? && params[:debug] == '1' }
 ```
 
 For the above setup, you would you have to be authenticated as an admin and would append `?debug=1` 
@@ -91,6 +84,8 @@ e.g.
 
 The local Rails server log outputs the trace URL. 
 
+<img width="1141" alt="screenshot of trace url output in Rails logs" src="https://user-images.githubusercontent.com/4600/236599713-49a82a83-d8c0-4e51-9442-5da1fbca7f9c.png">
+
 ## Production Environment
 
 For production, you can provide the auth token via the `CALLSTACKING_API_TOKEN` environment variable.
@@ -103,14 +98,20 @@ The traces are recorded at https://callstacking.com/traces
 
 For local 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.
+Click the icon and observe the trace.
+
+### Headless API requests
 
-For headless API requests, visit https://callstacking.com/traces to view your traces.
+The trace URL is output via the Rails logs.  https://callstacking.com/traces will updated with your latest trace.
 
 ## Tests
 ``
 rake app:test:all
 ``
 
+## Questions/Bugs/Feature Requests
+
+Create an issue: https://github.com/callstacking/callstacking-rails/issues
+
 ## License
-The gem is available as open source under the terms of the [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).
+The license can be viewed at https://github.com/callstacking/callstacking-rails/blob/main/LICENSE

data/lib/callstacking/rails/engine.rb

@@ -41,6 +41,7 @@ module Callstacking
 
       def self.start_tracing(controller)
         @@settings.enable!
+        @@loader.reset!
         @@instrumenter.enable!(@@loader.klasses.to_a)
         @@trace.begin_trace(controller)
 

data/lib/callstacking/rails/instrument.rb

@@ -80,6 +80,8 @@ module Callstacking
       end
 
       def enable!(klasses)
+        reset!
+
         Array.wrap(klasses).each do |klass|
           instrument_klass(klass, application_level: true)
         end
@@ -127,7 +129,10 @@ module Callstacking
         module_index = klass.ancestors.map(&:to_s).index(module_name)
 
         unless module_index
-          new_module = Object.const_set(module_name, Module.new)
+          # Development class reload -
+          #   ancestors are reset but module definition remains
+          new_module = Object.const_get(module_name) rescue nil
+          new_module||=Object.const_set(module_name, Module.new)
           span_modules << new_module
 
           new_module.instance_variable_set("@klass", klass)

data/lib/callstacking/rails/loader.rb

@@ -25,7 +25,9 @@ module Callstacking
         end
 
         trace.enable
+      end
 
+      def reset!
         instrumenter.instrument_method(ActionView::PartialRenderer, :render, application_level: false)
         instrumenter.instrument_method(ActionView::TemplateRenderer, :render, application_level: false)
       end

data/lib/callstacking/rails/trace.rb

@@ -35,10 +35,12 @@ module Callstacking
                       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)
+                      controller.request.headers, controller.request.params, @traces)
       end
 
       def end_trace(controller)
+        return if @trace_id.nil? || @tuid.nil?
+        
         complete_request(@trace_id, @tuid,
                          controller.action_name, controller.controller_name,
                          controller.action_name, controller.request.format,
@@ -141,7 +143,11 @@ module Callstacking
           traces.clear
         end
       end
-      def start_request(trace_id, tuid, method, controller, action, format, path, original_url, headers, params)
+      def start_request(trace_id, tuid, method, controller, action, format, path, original_url, headers, params, traces)
+        lock.synchronize do
+          traces.clear
+        end
+
         return if do_not_track_request?(original_url, format)
 
         client.create(trace_id, tuid,
@@ -167,10 +173,7 @@ module Callstacking
       end
 
       def complete_request(trace_id, tuid, method, controller, action, format, original_url, traces, max_trace_entries)
-        if do_not_track_request?(original_url, format)
-          traces.clear
-          return
-        end
+        return if do_not_track_request?(original_url, format)
 
         create_message(tuid, completed_request_message(method, controller, action, format),
                        spans.increment_order_num, traces)

data/lib/callstacking/rails/version.rb

@@ -1,5 +1,5 @@
 module Callstacking
   module Rails
-    VERSION = "0.1.29"
+    VERSION = "0.1.30"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callstacking-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.29
+  version: 0.1.30
 platform: ruby
 authors:
 - Jim Jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails