rack_middleware_metrics 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98990077c946511fb1f4b12324b71802b2b7d0a5541c598e1f4396698f545fa3
-  data.tar.gz: 9f209425500a239563c966cf4ceaaf29d5d831d6c5df2e6f4dfcc559ef189b56
+  metadata.gz: d25a76b74595b845fd92fffd63b0cc1b383f78642ee834ceb85b7add4a4945d9
+  data.tar.gz: 9691ccdcb57e694c0702ff9037ea830ecf057060dca2400e7fd76078b55e5be9
 SHA512:
-  metadata.gz: e00125579f4516e61a798ff8f69b04446ea0e2803a3953ea5bdf83fb90638c87f6edc7095e416a39e7ccc79272007d2b019422cecef1653865ac2e14b1916632
-  data.tar.gz: a7c14ed40b52f708e33ea7538c1a01c40e86b096d4c3dbd2dbb1968ce5182fc561c6bfb5cc0295984e254c0f3e1148dfbf5e2fd637ffc973ab8d28dd94289588
+  metadata.gz: 072aa309b1d14e2bd6ec960fe04777d4a29be2733536777779d25671ad5d827ccc7dad95f3db115a55f9d4b6f7907f6437c4f957f603125746227998891cf639
+  data.tar.gz: 82c42fada205c45dc77a7ce6a525294fc2986c248ec865d32eb7abf00e6e0368c994bfc38f7726c9e3aa48e419d317ca0c2d42223cf1cf5b914dceb98daac4df

data/README.md

@@ -1,54 +1,95 @@
+[![Build Status](https://travis-ci.com/reedjosh/RackMiddlewareMetrics.svg?branch=main)](https://travis-ci.com/reedjosh/RackMiddlewareMetrics)
 # Metrics Reporter
 A minimalist Application Performance Monitoring (APM) library for Ruby on Rails.
 
-[![Build Status](https://travis-ci.com/reedjosh/RackMiddlewareMetrics.svg?branch=main)](https://travis-ci.com/reedjosh/RackMiddlewareMetrics)
-
-Reports: 
-- The time that the request enters the middleware. 
-- The time that it leaves the middleware.
-- Request path
-- The request's parameter list.
-- MD5 hash value of the rendered output.
-- Current thread and process ids.
 
-Appends to a CSV file. 
+The middleware generates a CSV file with the followinfg fields (no header):
+- Request Time: the timestamp when the request enters the middleware
+- Response Time: the timestamp when the response leaves the middleware
+- Elapsed Time: the time betwen request and response
+- Path: the URI of the request
+- Params: a semi-colon delimited list of GET parameters
+- Thread ID: the thread ID of the current request
+- Process ID: the process ID of the current request
+- MD5: the hash value of the response body
 
 The location and name of the file are configurable by the user. 
 
-Adds itself to the hosting Ruby on Rails application using Railties AND the agent
+Optionally: Does MD5 calculation in Rust if native extention is built.
 
-Does MD5 calculation in Rust.
+## Getting Started
 
-Getting Started
+[Yard Docs](https://rubydoc.info/github/reedjosh/RackMiddlewareMetrics)
 
+### Installation
+Install from [ruby gems](https://rubygems.org/gems/rack_middleware_metrics)
 
-## Etc... Notes
-TODO: Add the Gem to an open source Ruby on Rails project (RedMine, Discourse, etc) and generate 
-a performance metrics CSV file.
+`bundle add rack_middleware_metrics`
 
-TODO: The Rack middleware should be implemented as a Railtie
+### Non-rails Setup
+See [example](https://github.com/reedjosh/RackMiddlewareMetrics/blob/main/example/thin_rack_app.rb) for setup with rack directly.
+```ruby
+class RackApp
+  def self.call _env
+    [200, { some_header: 'a value' }, ['Hi!']]
+  end
+end
 
-The middleware should generate a CSV file with the following fields:
-- Request Time: the timestamp when the request enters the middleware
-- Response Time: the timestamp when the request leaves the middleware
-- Elapsed Time: the time betwen request and response
-- Path: the URI of the request
-- Params: a semi-colon delimited list of GET parameters
-- MD5: the hashed value of the response body
-- Process ID: the process ID of the current request
-- Thread ID: the thread ID of the current request
+app =
+  Rack::Builder.app do
+    use(RackMiddlewareMetrics::Reporter, logpath: 'some_metrics_filepath.csv')
+    run(RackApp)
+  end
+
+handler = Rack::Handler::Thin
+handler.run(app, Port: 8082)
+```
+
+### Rails setup.
+The middleware is automatically registered with Rails. But to configure the logpath add:
+``` ruby
+    config.rack_middleware_metrics.logpath = Rails.root / 'some_metrics_filepath.csv'
+```
+to `config/environments/*.rb`
+
+## Example Output from Redmine Rails Project
+
+| Start                   | End                     | Duration(S) | URI                          | Params               | Thread       | PID | MD5                             |
+|-------------------------|-------------------------|-------------|------------------------------|----------------------|--------------|-----|---------------------------------|
+|2020-10-27 13:32:46 -0700|2020-10-27 13:32:47 -0700| 0.698014072 |http://localhost:3000/        |                      |55890640      |18581|1724d0f493f9ed2e191d9aeb49df0f4c |
+|2020-10-27 13:33:07 -0700|2020-10-27 13:33:07 -0700| 0.02697148  |http://localhost:3000/        |                      |70368509891620|18581|80eabd1e0373408b0a40b08b0eec6c3f |
+|2020-10-28 09:40:16 -0700|2020-10-28 09:40:16 -0700| 0.717337538 |http://localhost:3000/        |                      |55777940      |16173|89ab1d3fcc2d9dcdef4a50d79e9dcaff |
+|2020-10-28 09:40:41 -0700|2020-10-28 09:40:41 -0700| 0.103701273 |http://localhost:3000/projects|                      |55777940      |16173|d2ddd9efc455f83cb24060e6593d6c6c |
+|2020-10-28 09:41:44 -0700|2020-10-28 09:41:44 -0700| 0.051811471 |http://localhost:3000/projects|blah=funk             |70368510966560|16173|eb2dacf2043e866a9e8925e53d471e6f |
+|2020-10-28 09:44:02 -0700|2020-10-28 09:44:03 -0700| 0.831327261 |http://localhost:3000/projects|blah=funk;blah2=2funky|55777780      |17355|40895fa7af099cae3f48b27f149beb30 |
+
+
+## Development
+
+CI/CD is managed via [Travis CI](https://travis-ci.com/github/reedjosh/RackMiddlewareMetrics).
+
+### Build and Test Manually
+Build via:
+
+`bundler install --path=vendor`
+
+Run spec via:
+
+`./bin/rspec`
+
+### Build the Rust Extension
+Install Rust if not present.
+
+`curl https://sh.rustup.rs -sSf | sh -s -- -y`
+
+`source $HOME/.cargo/env`
 
-Done: The filename and path of the generated CSV file should be configurable by the user of the Gem
-Almost Done: generate the MD5 hash in Rust using Helix
-Flesh out further: Write unit tests in RSpec.
-Done: Add Travis CI.
-Partially: Write a README that explains what you built and how to use it.
+Build extension.
 
-Goals: 
-- Write idiomatic and well-tested ruby code in a gem.
-- Make sharable among many Ruby on Rails projects even with MD5 generation in rust.
-- Use rvm/Travis to test many ruby versions.
+`./bin/rake build`
 
-### Build Gem via:
-`gem build metrics_reporter.gemspec`
+### PRs and Testing
+A pull request will trigger builds for each of the Ruby versions supported against Ubuntu Xenial.
 
+### Release
+Releases from Travis are triggered whenever a commit to the main branch is tagged. Spec tests must pass for release to occur.

data/lib/md5_gen.rb

@@ -1,25 +1,41 @@
 # frozen_string_literal: true
 
 # lib/md5_gen.rb
-#
-# Provide md5 compute function that either uses native extention or Ruby digest lib.
 require 'helix_runtime'
 require('digest/md5')
 
+begin
+  require('md5_ruby_ext/native')
+  EXT_LOADED = true
+rescue LoadError
+  warn('Unable to load md5_ruby_ext/native. Falling back to Ruby digest/md5. ' \
+       'Please run `rake build` to build native extension.')
+  EXT_LOADED = false
+end
+
+# Provides md5 compute function that either uses native extention or Ruby digest lib.
 module MD5Gen
-  begin
-    require('md5_ruby_ext/native')
-    def MD5Gen.compute body
-      MRubyExt.compute(body)
-    # Can only work on UTF-8 strings atm. Helix limitation.
-    rescue TypeError
-      Digest::MD5.hexdigest(body)
-    end
-  rescue LoadError
-    warn('Unable to load md5_ruby_ext/native. Falling back to Ruby digest/md5. ' \
-         'Please run `rake build` to build native extension.')
-    def MD5Gen.compute body # rubocop:disable Lint/DuplicateMethods
-      Digest::MD5.hexdigest(body)
+  # Define the underlying_compute_method based upon whether the rust extention is loaded.
+  class << self
+    if EXT_LOADED
+      define_method(:underlying_compute_method) do |body|
+        MRubyExt.compute(body)
+      # Can only work on UTF-8 strings atm. Helix limitation.
+      rescue TypeError
+        Digest::MD5.hexdigest(body)
+      end
+    else
+      define_method(:underlying_compute_method) do |body|
+        Digest::MD5.hexdigest(body)
+      end
     end
   end
+
+  # Convert body string to MD5 hash.
+  #
+  # @param body [String] the body to be hashed.
+  # @return [String] the hash of the body.
+  def self.compute body
+    underlying_compute_method(body)
+  end
 end

data/lib/rack_middleware_metrics.rb

@@ -6,6 +6,6 @@ require 'rack_middleware_metrics/reporter'
 
 require 'rack_middleware_metrics/railtie' if defined?(Rails)
 
+# A minimalist Application Performance Monitoring (APM) library for Ruby on Rails.
 module RackMiddlewareMetrics
-  class Error < StandardError; end
 end

data/lib/rack_middleware_metrics/railtie.rb

@@ -2,7 +2,7 @@
 
 # lib/rack_middleware_metrics/railtie.rb
 module RackMiddlewareMetrics
-  # Rails init...
+  # Rails railtie plugin. Adds configuration, startup, and md5 ext build task.
   class Railtie < Rails::Railtie
     config.rack_middleware_metrics = ActiveSupport::OrderedOptions.new
     initializer 'rack_middleware_metrics.configure_rails_initialization' do |app|
@@ -10,5 +10,8 @@ module RackMiddlewareMetrics
         config.rack_middleware_metrics.fetch(:logpath, Rails.root / 'rack_metrics.csv')
       app.middleware.use(Reporter, config.rack_middleware_metrics)
     end
+    rake_tasks do
+      load(Pathname(__FILE__).parent.parent / 'tasks/helix_runtime.rake')
+    end
   end
 end

data/lib/rack_middleware_metrics/reporter.rb

@@ -6,11 +6,19 @@
 require 'time'
 require 'rack'
 require 'md5_gen'
+require 'uri'
+require 'csv'
 
-# The main Gem...
 module RackMiddlewareMetrics
   # The metrics reporter middleware.
   class Reporter
+    # Initialize the reporter middleware.
+    #
+    # @param app [rack::RackApp] the app to add metrics reporting to.
+    # @param *args [Array<any>, nil] arguments to pass through to the app.
+    #   A hash passed as the final argument will be used as config options--of which :logpath
+    #   can be used to specify the metrics reporter logpath.
+    # @returns [Reporter] a new instance of Reporter.
     def initialize app, *args
       @app = app
 
@@ -19,28 +27,59 @@ module RackMiddlewareMetrics
       @logpath = Pathname.new(options.fetch(:logpath, 'rack_metrics.csv'))
     end
 
+    # Converts data from rack env object to uri.
+    #
+    # @param env [rack::ENV] the request env.
+    # @return [String] the uri.
     def uri_from env
       "#{ env['rack.url_scheme'] }://#{ env['SERVER_NAME'] }"\
             ":#{ env['SERVER_PORT'] }#{ env['PATH_INFO'] }"
     end
 
+    # Converts data from rack env object to semicolon delimited parameters.
+    # Original semicolons escaped with %3B the ASCII equivalent.
+    # See https://www.december.com/html/spec/esccodes.html for more details.
+    #
+    # @param env [rack::ENV] the request env.
+    # @return [String] semicolon delimited parameters..
+    def params_from env
+      params = Hash[URI.decode_www_form(env['QUERY_STRING'])]
+      params = params.map { |key, val| "#{ key }=#{ val }" }
+      params.map { |param| param.gsub(';', '%3B') }.join(';')
+    end
+
+    # Run the request--call next step in middleware/server chain with added timing.
+    #
+    # @param env [rack::ENV] the request env.
+    # @return [Array<Array<Objects>>] the response objects: [status, headers, body] plus
+    #   added timing such that the final form is:
+    #   [[status, headers, body], [start_time, end_time, duration]]
     def timed_call env
       start_time = Time.now
       response = @app.call(env)
       end_time = Time.now
-      duration = start_time - end_time
+      duration = end_time - start_time
       [*response, [start_time, end_time, duration]]
     end
 
+    # Run the request--call next step in middleware/server chain with added timing.
+    #
+    # @param data [Array<objects>] metrics data to append to logfile.
+    # @return [void]
     def append_data data
-      logline = "#{ data.join(',') }\n"
-      @logpath.open(mode: 'a') { |logfile| logfile.write(logline) }
+      CSV.open(@logpath, 'a') do |csv|
+        csv << data
+      end
     end
 
+    # Main middleware entry and exit point. Logs metrics as specified.
+    #
+    # @param env [rack::ENV] the request env.
+    # @return [Array<objects>] of the form: [status, headers, body]
     def call env
       status, headers, body, timing = timed_call(env)
 
-      query_params = env['QUERY_STRING']
+      query_params = params_from(env)
       uri = uri_from(env)
       thread_id =  Thread.current.object_id
       process_id = Process.pid

data/lib/rack_middleware_metrics/version.rb

@@ -1,3 +1,3 @@
 module RackMiddlewareMetrics
-  VERSION ||= "0.0.1"
+  VERSION ||= "0.0.7"
 end

data/lib/tasks/helix_runtime.rake

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 # lib/tasks/helix_runtime.rake
 require 'helix_runtime/build_task'
 
-HelixRuntime::BuildTask.new()
+Dir.chdir(Pathname(__FILE__).parent) do
+  HelixRuntime::BuildTask.new
 
-task default: :build
+  task default: :build
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack_middleware_metrics
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.7
 platform: ruby
 authors:
 - reedjosh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: helix_runtime
@@ -66,7 +66,6 @@ files:
 - ".rubocop.yml"
 - ".solargraph.yml"
 - ".travis.yml"
-- ".~lock.GIST_API.odt#"
 - Cargo.lock
 - Cargo.toml
 - Gemfile
@@ -99,7 +98,6 @@ files:
 - example/.keep
 - example/thin_rack_app.rb
 - lib/md5_gen.rb
-- lib/md5_ruby_ext.rb
 - lib/rack_middleware_metrics.rb
 - lib/rack_middleware_metrics/railtie.rb
 - lib/rack_middleware_metrics/reporter.rb
@@ -129,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A rack based middleware that does fun/silly metrics reporting.

data/.~lock.GIST_API.odt#

@@ -1 +0,0 @@
-,jreed,jayr.localdomain,14.07.2017 13:50,file:///home/jreed/.config/libreoffice/4;

data/lib/md5_ruby_ext.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-# lib/md5_ruby_ext.rb
-require 'helix_runtime'
-
-begin
-  require('md5_ruby_ext/native')
-rescue LoadError
-  warn('Unable to load md5_ruby_ext/native. Please run `rake build`... Requires Rust/cargo.')
-end