full_request_logger 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbae2d623039dd9c1b3f1f956adcb5769a4eae0aaae14b2bcaa2f1272fd3d8ac
+  data.tar.gz: 8799755a93425af26cf02bb6fa38f53cc0087ff1cea0318845f26326dc0a5b0c
+SHA512:
+  metadata.gz: 3d92ba086bb4f520f6b8e97143c7c82dbc69d7c8c1dd03fd27de96faa5d773c6cbc7a85d4f8e3db002422a8682ee6bf5d5202c4a078e2d3a7d79eb835882e5b5
+  data.tar.gz: 0e4bd4e58a52d3eac3d1c09ecda279c0aaa547cfeaf4802135bc82958ecd188bfe9728a8b82ea890b29d4b2c61eb90f0a4f05ec9e44647786c39846f98f5b1c1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'byebug'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Basecamp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Full Request Logger
+
+Easy access to full request logs via a web UI. The recorder attaches to the existing Rails.logger instance, 
+and captures a copy of each log line into a per-thread buffer. When the request is over, the middleware makes
+the recorder flush all the log lines that were recorded for that request as a compressed batch to an expiring Redis key.
+
+Thus you no longer have to grep through log files or wrestle with logging pipelines to instantly see all the
+log lines relevant to a request you just made. This is ideal for when you're testing a feature in the wild with
+production-levels of data, which may reveal performance or other issues that you didn't catch in development.
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'full_request_logger'
+```
+
+## Configuration
+
+Add to development.rb and/or production.rb. Default time-to-live (TTL) for reach recorded request is 10 minutes,
+and the default Redis storage is assumed to live on localhost, but both can be overwritten. Only configuration needed
+is the enabled setting.
+
+```ruby
+config.full_request_logger.enabled = true
+config.full_request_logger.ttl     = 1.hour
+config.full_request_logger.redis   = { host: "127.0.0.1", port: 36379, timeout: 1 }
+```
+
+The request logs access can be protected behind http basic by adding the following credentials
+(using `./bin/rails credentials:edit --environment production`):
+
+```
+full_request_logger:
+  name: someone
+  password: something
+```
+
+## Usage
+
+Access request logs via `/rails/conductor/full_request_logger/request_logs/:id` where id is the X-Request-Id.
+
+## License
+
+Full Request Logger is released under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = FileList["test/*_test.rb"]
+  test.warning = false
+end
+
+task default: :test

data/app/controllers/rails/conductor/full_request_logger/request_logs_controller.rb

@@ -0,0 +1,20 @@
+module Rails
+  class Conductor::FullRequestLogger::RequestLogsController < ActionController::Base
+    if credentials = FullRequestLogger.credentials
+      http_basic_authenticate_with credentials
+    end
+
+    layout "rails/conductor"
+
+    def show
+      if @logs = FullRequestLogger::Recorder.instance.retrieve(params[:id])
+        respond_to do |format|
+          format.html
+          format.text { send_data @logs, disposition: :attachment, filename: "#{params[:id]}.log" }
+        end
+      else
+        head :not_found
+      end
+    end
+  end
+end

data/app/views/layouts/rails/conductor.html.erb

@@ -0,0 +1,8 @@
+<html>
+<head>
+  <title>Rails Conductor: <%= yield :title %></title>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/app/views/rails/conductor/full_request_logger/request_logs/show.html.erb

@@ -0,0 +1,5 @@
+<h1>Request: <%= params[:id] %></h1>
+
+<p><%= link_to "Download", rails_conductor_request_log_path(params[:id], format: :text) %></p>
+
+<pre><%= @logs %></pre>

data/config/routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  scope "rails/conductor/full_request_logger/", module: "rails/conductor/full_request_logger" do
+    resources :request_logs, only: :show, as: :rails_conductor_request_logs
+  end
+end

data/full_request_logger.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name     = 'full_request_logger'
+  s.version  = '0.1'
+  s.authors  = 'David Heinemeier Hansson'
+  s.email    = 'david@basecamp.com'
+  s.summary  = 'Make full request logs accessible via web UI'
+  s.homepage = 'https://github.com/basecamp/full_request_logger'
+  s.license  = 'MIT'
+
+  s.required_ruby_version = '>= 2.6.0'
+
+  s.add_dependency 'activesupport', '>= 6.0.0'
+
+  s.add_development_dependency 'bundler', '~> 1.17'
+
+  s.files      = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end

data/lib/full_request_logger.rb

@@ -0,0 +1,12 @@
+require "full_request_logger/engine"
+
+module FullRequestLogger
+  extend ActiveSupport::Autoload
+
+  autoload :Recorder
+
+  mattr_accessor :ttl
+  mattr_accessor :redis
+  mattr_accessor :enabled
+  mattr_accessor :credentials
+end

data/lib/full_request_logger/engine.rb

@@ -0,0 +1,32 @@
+require "rails/engine"
+require "full_request_logger/middleware"
+
+module FullRequestLogger
+  class Engine < Rails::Engine
+    isolate_namespace FullRequestLogger
+    config.eager_load_namespaces << FullRequestLogger
+
+    config.full_request_logger = ActiveSupport::OrderedOptions.new
+
+    initializer "full_request_logger.middleware" do
+      config.app_middleware.insert_after ::ActionDispatch::RequestId, FullRequestLogger::Middleware
+    end
+
+    initializer "full_request_logger.configs" do
+      config.after_initialize do |app|
+        FullRequestLogger.enabled     = app.config.full_request_logger.enabled || false
+        FullRequestLogger.ttl         = app.config.full_request_logger.ttl   || 10.minutes
+        FullRequestLogger.redis       = app.config.full_request_logger.redis || {}
+        FullRequestLogger.credentials = app.config.full_request_logger.credentials || app.credentials.full_request_logger
+      end
+    end
+
+    initializer "full_request_logger.recoder_attachment" do
+      config.after_initialize do |app|
+        if app.config.full_request_logger.enabled
+          FullRequestLogger::Recorder.instance.attach_to Rails.logger
+        end
+      end
+    end
+  end
+end

data/lib/full_request_logger/middleware.rb

@@ -0,0 +1,15 @@
+module FullRequestLogger
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env).tap do
+        if FullRequestLogger.enabled
+          Recorder.instance.flush ActionDispatch::Request.new(env).request_id
+        end
+      end
+    end
+  end
+end

data/lib/full_request_logger/recorder.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+class FullRequestLogger::Recorder
+  attr_reader :redis
+
+  def self.instance
+    @instance ||= new
+  end
+
+  def initialize
+    @redis = Redis.new FullRequestLogger.redis
+  end
+
+  def attach_to(logger)
+    logger.extend ActiveSupport::Logger.broadcast(
+      ActiveSupport::Logger.new(self)
+    )
+  end
+
+  def write(message)
+    messages << remove_ansi_colors(message)
+  end
+
+  def log
+    messages.join.strip
+  end
+
+  def flush(request_id)
+    if (log_to_be_flushed = log).present?
+      redis.setex \
+        request_key(request_id),
+        FullRequestLogger.ttl,
+        compress(log_to_be_flushed)
+    end
+  ensure
+    messages.clear
+  end
+
+  def retrieve(request_id)
+    if log = redis.get(request_key(request_id))
+      uncompress(log).force_encoding("utf-8")
+    end
+  end
+
+  # no-op needed for Logger to treat this as a valid log device
+  def close
+    redis.disconnect!
+  end
+
+  private
+    def messages
+      Thread.current[:full_request_logger_messages] ||= []
+    end
+
+    def remove_ansi_colors(message)
+      message.remove(/\e\[\d+m/)
+    end
+
+    def request_key(id)
+      "full_request_logger/requests/#{id}"
+    end
+
+    def compress(text)
+      Zlib::Deflate.deflate(text)
+    end
+
+    def uncompress(text)
+      Zlib::Inflate.inflate(text)
+    end
+end

data/test/recorder_test.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'active_support/testing/autorun'
+
+require 'full_request_logger/record'
+
+class RecorderTest < ActiveSupport::TestCase
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: full_request_logger
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: 
+email: david@basecamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/rails/conductor/full_request_logger/request_logs_controller.rb
+- app/views/layouts/rails/conductor.html.erb
+- app/views/rails/conductor/full_request_logger/request_logs/show.html.erb
+- config/routes.rb
+- full_request_logger.gemspec
+- lib/full_request_logger.rb
+- lib/full_request_logger/engine.rb
+- lib/full_request_logger/middleware.rb
+- lib/full_request_logger/recorder.rb
+- test/recorder_test.rb
+homepage: https://github.com/basecamp/full_request_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Make full request logs accessible via web UI
+test_files:
+- test/recorder_test.rb