akita-har_logger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6d7e1e45f74876fef25c0840efa3b2715af8db8080411f628a7347e5d06fc9
-  data.tar.gz: 96f8b9e4f924ec89c93847bfd293ee62b1c91700f15f76e6a5fad8f525e01ad9
+  metadata.gz: 3da46a0fcf41a0f5f1f1d88261e7345713fe9487d7a7c4485d85e0ee808c8717
+  data.tar.gz: 8857a59375d849bf4c94b47a131c90a950f5bc06da6979c75815d3a6f1c0c4d9
 SHA512:
-  metadata.gz: f9f73e60c027ab1756f3c64f4e1687cd5d43c13a938b971972d3ab8cb49252c9506b5127e04cc3207e9b8868b43d3d18992da755ce4ff98ca8a1a74e26e48915
-  data.tar.gz: 5b9f0a079665e2ce5b79052ddc375843a55144e1913fb19aa423ba355234d342188a9e242f50759f28b335776f1ccf26e985459ad08d6e6a900900380d52de76
+  metadata.gz: a2a17be7f105d38c3f75b70bd42dd8982c189a129895ca887333fc3609d2e3f1c362fddffd7a77f97bd43358bc907982ea6b718f96515297cf9b65c437073a0d
+  data.tar.gz: 1919850a9c0be28cd22610699a17caec16bafa2b8bf9485ab4b0f7646fbf77a2b4c3294f676033ab6c14258bf52a7ffa08dd9fe3c7e0fe729c90fa228d2acfa2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    akita-har_logger (0.1.0)
+    akita-har_logger (0.2.0)
       json (~> 2.3)
 
 GEM

data/README.md

@@ -1,7 +1,7 @@
-# Akita HTTP Archive (HAR) logger for Rack applications
+# Akita HTTP Archive (HAR) logger for Rack/Rails applications
 
-This provides Rack middleware for logging HTTP request–response pairs to a HAR
-file.
+This provides Rack middleware and a Rails `ActionController` filter for logging
+HTTP request–response pairs to a HAR file.
 
 
 ## Installation
@@ -23,24 +23,59 @@ Or install it yourself as:
 
 ## Usage
 
-To instrument your Rack application, add `Akita::HarLogger::Middleware` to the
-top of your middleware stack. For convenience, you can use
-`Akita::HarLogger.instrument`, as follows.
-
-1. In your main `application.rb`, make `Akita::HarLogger` available:
-    ```ruby
-    require 'akita/har_logger'
-    ```
-2. Add the following line to the bottom of your `Rails::Application`
-   subclass. Specifying the output file is optional; if not given, it defaults
-   to `akita_trace_{timestamp}.har`.
-   ```ruby
-   Akita::HarLogger.instrument(config, '/path/to/output/har_file.har')
-   ```
-
-Now, when you run your Rack application, all HTTP requests and responses will
-be logged to the HAR file that you've specified. You can then upload this HAR
-file to Akita for analysis.
+There are two options for instrumenting your Rack/Rails application. The first
+is to use the HAR logger as Rack middleware. The second is to use it as a Rails
+`ActionController` filter.
+
+Depending on the framework you're using, one or both options may be available
+to you. If you are interested in logging RSpec tests, the filter option will
+capture traffic for both controller and request specs, whereas the middleware
+option only captures request specs.
+
+Once your application is instrumented, when you run the application, HTTP
+requests and responses will be logged to the HAR file that you've specified.
+You can then upload this HAR file to Akita for analysis.
+
+### Middleware
+
+To instrument with middleware, add `Akita::HarLogger::Middleware` to the top of
+your middleware stack. For convenience, you can call
+`Akita::HarLogger.instrument` to do this. We recommend adding this call to the
+bottom of `config/environments/test.rb` to add the middleware just to your test
+environment.
+
+Here is a sample configuration for a test environment that just adds the
+instrumentation.
+
+```ruby
+Rails.application.configure.do
+  # Other configuration for the Rails application...
+
+  # Put the HAR logger at the top of the middleware stack, and optionally
+  # give an output HAR file to save your trace. If not specified, this defaults
+  # to `akita_trace_{timestamp}.har`.
+  Akita::HarLogger.instrument(config, "akita_trace.har")
+end
+```
+
+### `ActionController` filter
+
+To instrument with a filter, add an instance of `Akita::HarLogger::Filter` as
+an `around_action` filter to your `ActionController` implementation. Here is an
+example of a bare-bones `app/controllers/application_controller.rb` with this
+instrumentation.
+
+```ruby
+class ApplicationController < ActionController::API
+  include Response
+  include ExceptionHandler
+
+  # Add the HAR logger as an `around_action` filter. Optionally give an output
+  # HAR file to save your trace. If not specified, this defaults to
+  # `akita_trace_{timestamp}.har`.
+  around_action Akita::HarLogger::Filter.new("akita_trace.har")
+end
+```
 
 
 ## Development

data/lib/akita/har_logger.rb

@@ -52,5 +52,37 @@ module Akita
         [ status, headers, body ]
       end
     end
+
+    # Logging filter for `ActionController`s.
+    # TODO: Some amount of code duplication here. Should refactor.
+    class Filter
+      def initialize(out_file_name = nil)
+        if out_file_name == nil then
+          out_file_name = "akita_trace_#{Time.now.to_i}.har"
+        end
+
+        # This queue is used to ensure that event logging is thread-safe. The
+        # main thread will enqueue HarEntry objects. The HAR writer thread
+        # below dequeues these objects and writes them to the output file.
+        @entry_queue = Queue.new
+        WriterThread.new out_file_name, @entry_queue
+      end
+
+      def around(controller)
+        start_time = Time.now
+
+        yield
+
+        end_time = Time.now
+        wait_time_ms = ((end_time.to_f - start_time.to_f) * 1000).round
+
+        response = controller.response
+        request = response.request
+
+        @entry_queue << (HarEntry.new start_time, wait_time_ms, request.env,
+                                      response.status, response.headers,
+                                      [response.body])
+      end
+    end
   end
 end

data/lib/akita/har_logger/version.rb

@@ -2,6 +2,6 @@
 
 module Akita
   module HarLogger
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akita-har_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jed Liu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Rails middleware for HAR logging