log_sanity 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf587be669e717c152dbdcc863726d68fc0a0de5cb56e07f53f61aa707059626
+  data.tar.gz: 75fd9003f9812d20f5c73476368cff9388d9875e5a67865c4156ea948c62bf53
+SHA512:
+  metadata.gz: fcd3e322168ebd60856cccba40ac63d90152192323b25679c8c6dbca3f05e5b6d3a66ace7025ac817cdb21b008cf56aa04bf66a26dab7e9b579c48948066e030
+  data.tar.gz: 0b7c2309c55819217d2424541d38da82b8138b0432e7b022b78f9e19476688c929cc5dfde4bdbd25114c674e2054c2fb665834d240544c7eab353b516a1ef376

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in log_sanity.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    log_sanity (0.2.5)
+      rails (>= 5, < 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activestorage (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.1)
+      actioncable (= 6.0.2.1)
+      actionmailbox (= 6.0.2.1)
+      actionmailer (= 6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actiontext (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  log_sanity!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017-2020 thomas morgan
+
+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,180 @@
+# LogSanity
+
+LogSanity is another attempt at taming Rails logging and making logs more viable in production.
+
+It's quite opinionated (partly intentional, partly a byproduct of being a young project) and yet strives for sane defaults and to play nicely within the natural order of Rails.
+
+At its core, it aggregates various logging variables and then outputs one JSON-formatted, primary request log line. It's quite easy to add extra variables to this output, great for appending info about the authenticated user, active account, etc.
+
+However, just because the primary output is a single line doesn't make it a one-line logging system. Taking inspiration from elsewhere[^1], the intent is for each conceptual event to have its own log entry. The default request line is just an http(s) request event. If the user takes other actions and those should be logged, do so--and give them their own entry. To this end, a small number of default Rails events are logged individually, such as sending an email, some ActiveJob processing, and a few others.
+
+Example output: (Multi-line and extra whitespace added for readability; normally all one line.)
+
+```
+{ "at" : "2017-01-18T00:27:50.947Z",
+  "event" : "https_get",
+  "ip" : "127.0.0.1",
+  "rq" : "ec337729-dbf3-4c6f-86b9-8d1a06c2277e",
+  "route" : "ArticlesController#index",
+  "format" : "html",
+  "params" : {"id":"123456"},
+  "duration" : {"total":20, "views":9, "activerecord":1},
+  "status" : 200
+}
+```
+
+
+
+### Installation
+
+Install the usual way:
+```
+gem 'log_sanity'
+```
+
+By default, LogSanity does not enable itself. To do so, in `config/environments/production.rb` add:
+```
+config.logsanity.enabled = true
+config.log_level = :info
+```
+
+You can go less verbose than `:info` (say, `:warn`), but more verbose (ie: `:debug`) is not recommended.
+
+
+### Usage
+
+Basic usage may require nothing more than enable LogSanity as outlined above. Some common configuration settings include silencing logging for certain paths (like health checks) or adding information about the currently authenticated user.
+
+##### Adding attributes
+
+The most common way to add attributes is via controllers. Helper methods are provided for this. For example, to log the current user's ID, you might add the following to `application_controller.rb`:
+
+```
+after_filter do
+  if current_user
+    log_field 'user', current_user.id
+  end
+end
+```
+
+The syntax is simply `log_field(key, value)`. Since the output is JSON, `value` can even be a hash or array:
+```
+log_field 'user', {id: current_user.id, name: current_user.name}
+```
+
+You can log multiple fields by calling `log_field` multiple times.
+
+If you must, you can get to the full fields hash:
+```
+LogSanity.fields['user'] ||= {}
+LogSanity.fields['user']['id'] = current_user.id
+```
+
+It's also possible to add attributes via Rails existing `log_tags` facility, which is documented more below.
+
+
+##### Logging complete entries
+
+To log a complete event (a complete log entry), try something like:
+```
+logger.info 'event'=>'user_signup', 'source'=>'ppc', 'campaign'=>'awesomeness', 'rq'=>request.uuid, 'user'=>current_user.id
+```
+
+If you pass in a hash to any `logger` method, it automatically becomes JSON output. The timestamp will be automatically added.
+
+
+
+### Configuration options
+
+While the above cover most of it, there are a handful of other potentially useful settings.
+
+##### Silence logging for certain paths
+
+This is particularly useful if you have any kind of health check path, as there's no need to fill up log files with that stuff.
+
+```
+config.logsanity.silence_paths += ["/health", %r{^/healthcheck}]
+```
+
+Both exact path matches (Strings) and Regex's are supported.
+
+
+##### Logging of strings
+
+By default, strings are logged as-is and not stuck inside a JSON object. If you prefer the opposite:
+
+```
+config.logsanity.json_strings = true
+```
+
+With `json_strings` as `false` (default), `logger.info "This is fantastic!"` would normally just output:
+```
+This is fantastic!
+```
+However, if `true`, you'll see:
+```
+{"at":"2017-01-18T00:27:50.947Z","message":"This is fantastic!"}
+```
+
+
+##### String formatting
+
+When LogSanity initializes, it replaces the Rails log formatter with its own, but saves the old one for outputting strings (assuming `json_strings` is `false`). This means you can still configure the formatting of those. For example, to use Logger's default formatting (instead of Rails' default):
+
+```
+config.log_formatter = ::Logger::Formatter.new
+```
+
+
+##### Tagged logging
+
+As noted above, you can either add extra attributes directly or via `log_tags`. We discussed direct already. Now let's take a look at tagged logging, which is a bit different in a JSON world.
+
+```
+config.log_tags = [ :subdomain ]
+```
+
+Just like Rails' support for text-style logs, you may use symbols (which call the named method on the `request` object), strings (logged literally), and Procs (which are passed `request` as a parameter).
+
+LogSanity takes these and adds them to the default request log entry (but _not_ other log entries). If a tagged method (via symbol or Proc) returns a hash, it's merged directly into the output. Otherwise the return value is used as a string and given a key in the form `tag#` where # is automatically calculated.
+
+
+### Additional notes
+
+LogSanity is intended for production use at log_level info. At level debug, some logs are simply turned off. Others may continue to output as normal strings (such as ActiveRecord).
+
+There is no need to use ActiveSupport::TaggedLogging with your logger. Just set the logger directly (if not using the default):
+```
+config.logger = ActiveSupport::Logger.new(STDOUT)
+```
+
+All default output includes the :uuid/:request_id using the key "rq". There is no need to add \[:uuid] to `config.log_tags`.
+
+`ActionController::RoutingError` exceptions are always silenced and turned into a simple 404 log entry.
+
+The request path is not included, as it mostly just duplicates `route` and `params`. If you need it, you could add it using `config.log_tags = [:filtered_path]`. Alternatively, consider adding X-Request-Id to your `nginx` (or other webserver) logs and correlating to those logs instead.
+
+The `total` duration may be longer than you're used to seeing. By default, Rails only counts the time inside the application controller. In contrast, LogSanity also includes all the middleware between itself and the application controller. While this isn't the entire picture, it is closer to the actual real time elapsed.
+
+
+### What does it do behind the scenes?
+
+In short:
+* Removes all default Rails logging, replacing it with its own
+* Replaces Rails::Rack::Logger middleware with its own
+* Adds middleware to intercept routing errors
+* Replaces the current logger's formatter
+
+
+### Final notes
+
+There are still some things that could be handled better (such as multi-line strings in json_strings mode).
+
+Pull requests are welcomed and encouraged. The only goal is to avoid making things unnecessarily complex.
+
+Tested on Rails 5.2 and up. Anything older is untested. Small patches for older compatibility will be considered.
+
+License: MIT
+
+
+[^1]: Parts [one](https://medium.com/@jlsuttles/structured-logging-part-1-what-s-the-big-deal-b7c6011e2504), [two](https://medium.com/@jlsuttles/structured-logging-part-2-usage-7754db10b6c), and [three](https://medium.com/@jlsuttles/structured-logging-part-3-practical-application-for-ruby-b5023f29f0af).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LogSanity'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/log_sanity.rb

@@ -0,0 +1,36 @@
+%w( formatter
+    railtie
+    log_subscribers/base
+    log_subscribers/action_controller
+    log_subscribers/action_dispatch
+    log_subscribers/action_mailer
+    log_subscribers/active_job
+    middleware/request_logger
+    middleware/routing_error_catcher
+    extensions/action_controller_helper 
+    extensions/active_support_subscriber
+  ).each do |fn|
+  require_relative "log_sanity/#{fn}"
+end
+
+ActionController::Base.include LogSanity::Extensions::ActionControllerHelper
+ActionController::API.include  LogSanity::Extensions::ActionControllerHelper if defined?(ActionController::API)
+if Rails.version < '6'
+  ActiveSupport::Subscriber.include LogSanity::Extensions::ActiveSupportSubscriber
+end
+
+module LogSanity
+  module_function
+
+  def fields
+    Thread.current[:logsanity_fields] || reset_fields
+  end
+
+  def reset_fields
+    Thread.current[:logsanity_fields] = {}.with_indifferent_access
+  end
+
+  def log(key, val)
+    fields[key.to_s] = val
+  end
+end