lograge_waittime 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77d84f316c43785cdea187ce0ee10ba3624c41492eeefdada55331ef3838cbef
+  data.tar.gz: 05be60d05146942b59b0b7db57dfa3d9ed876707d7d0f6ba173bdaa5f9a07109
+SHA512:
+  metadata.gz: a7bf14b0ac00095c9a736351e50144d3a27874352c2eedb0d26cc0d8357a39ce7b0eebbf74cb4d8e45eb71c38db1f9fa1bdb9c583bbc4fb5dca676cfac1d1355
+  data.tar.gz: c29cca3a40d464a7fa8f278eb4586a411f4db1a81201ee41b7e4e66df80c24ce7c0d0067ee449218b1f796600d6f8d70e6f67334c06147ec24da3a7eb1b94679

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+
+## 0.4.0 - 2022-11-18
+
+* Zeitwerk did not work seamlessly with the previous gem name, switching to `lograge_waittime`.
+* Code simplified further.
+
+## 0.3.1 - 2022-11-18
+
+- Actually bumping version.rb to match
+
+## 0.3.0 - 2022-11-18
+
+- BREAKING: Rename this gem to "lograge-waittime". The old name was unwieldy and even had a typo to prove it.
+- BREAKING: Removed exception silencing to focus the code more narrowly.
+- Removing explicit testing of Rails before 5.2. 
+- Added CI testing of Rails version up to and including Rails 6.1.x with Ruby 3.0.x
+
+## 0.2.1 - 2018-07-01
+
+- Loosening Rails version dependency, previously only allowed Rails 5.2+, now tested with Rails 4.2+
+
+## 0.2.0 - 2018-06-29
+
+### New features
+
+- New gem, new project.
+- Added `LogrageRailsRequestQueuing::SilenceExceptionLogging` to optionally quiet down exception logging.
+- Added `LogrageRailsRequestQueuing::ExceptionDetails` to compactly report exception details in the log.
+- Added support for Heroku request started timestamps that are given in ms not seconds.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at laust@object.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Laust Rud Jacobsen
+
+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,141 @@
+# `lograge_waittime`
+
+[![Ruby](https://github.com/rud/lograge_waittime/actions/workflows/ruby.yml/badge.svg)](https://github.com/rud/lograge_waittime/actions/workflows/ruby.yml)
+
+[Lograge](https://github.com/roidrage/lograge) makes Rails logging output a lot more more useful.
+
+The log output for a request looks something like this:
+
+```
+status=200 duration=58.33 view=40.43 db=15.26 controller=WelcomeController action=show
+```
+
+This gem adds another field with how long the request waited to be processed, since arriving in the request queue in NGINX.
+The unit is milliseconds, and represented as the `wait` value:
+
+```
+status=200 duration=58.33 view=40.43 db=15.26 wait=3.14 controller=WelcomeController action=show
+```
+
+Wait time or request queueing time is the time that passes between a request is received in the webserver (typically NGINX), and until it hits the Rails stack in a web worker.
+
+Under normal load in production this value will be in the order of a few milliseconds.
+However, if all Rails web-processes are busy, the number will quickly climb as individual requests are queued and waiting to be served.
+
+It's one of the key numbers that are good to keep an eye on in monitoring and is very helpful to include when graphing response times over time.
+Long wait times will feel like a sluggish site for end users, and even though you may be seeing short durations to process requests, if the wait-time is large, then the end-user experience will still be bad.
+
+## Docker demo setup
+
+To quickly get a feel for the parts of the setup, a `docker-compose` sample configuration is included.
+The setup is fairly simple: requests first hit an NGINX instance, then they are forwarded to the Rails app.
+By looking at the log-output you can observe the request queueing time for each request as `wait`.
+
+Try it out by running:
+
+```
+docker-compose up
+```
+
+Then you can visit [http://localhost:3030/echo](http://localhost:3030/echo) and you will now see the live `wait=` output in the Rails log, like this:
+
+```
+method=GET path=/echo format=html controller=EchosController action=index status=200 duration=1.67 view=0.37 wait=1067.24
+```
+
+This particular example was the first request to a backend not yet fully started.
+This next request was through a warmed up stack:
+
+```
+method=GET path=/echo format=html controller=EchosController action=index status=200 duration=0.60 view=0.28 wait=14.37
+```
+
+## Installation
+
+### NGINX change
+
+In your NGINX config, add:
+```
+proxy_set_header X-Request-Start "t=${msec}";
+```
+to the relevant part of your server setup. According to [NGINX docs](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_set_header), it can go in one of `http`, `server`, or `location`.
+
+This adds a new header to all incoming requests, with current time in milliseconds as the value.
+`msec` is supported from NGINX releases 1.2.6 and 1.3.9.
+
+### Rails app changes:
+
+Execute:
+
+``` shell
+bundle add lograge_waittime
+```
+
+Then add it to your existing lograge initializer, typically in `config/initializers/lograge.rb`.
+If you are just setting up lograge, please check that projects documentation for up to date information.
+
+``` ruby
+Rails.application.configure do
+  config.lograge.enabled = true
+
+  # Keep emitting the verbose logging for easier debug
+  config.lograge.keep_original_rails_log = !Rails.env.production?
+
+  config.lograge.custom_options = lambda do |event|
+    custom_options = {}
+
+    # lograge_waittime setup:
+    queued_ms = RequestStore[:lograge_waittime].queued_ms
+    custom_options[:wait] = queued_ms.round(2) if queued_ms
+
+    custom_options
+  end
+end
+```
+
+After this is deployed, you now get the `"wait=.."` value added to the output when the value is available.
+If you do not see the `"wait=.."` value in logging out, please double check you have added the new header in your NGINX config and deployed it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+If you want to test using a specific Rails version locally, use this method:
+
+``` shell-interaction
+export RAILS_VERSION="~> 5.1" 
+bundle update
+bundle exec rake
+```
+
+If you prefer a oneliner for testing a combination, try this:
+```
+(asdf shell ruby 2.7.6; export RAILS_VERSION="~> 5.1.0"; rm Gemfile.lock; bundle install; bundle exec rake ci)
+(asdf shell ruby 2.7.6; export RAILS_VERSION="~> 6.0.0"; rm Gemfile.lock; bundle install; bundle exec rake ci)
+(asdf shell ruby 2.7.6; export RAILS_VERSION="~> 6.1.0"; rm Gemfile.lock; bundle install; bundle exec rake ci)
+(asdf shell ruby 3.0.4; export RAILS_VERSION="~> 6.1.0"; rm Gemfile.lock; bundle install; bundle exec rake ci)
+(asdf shell ruby 3.0.4; export RAILS_VERSION="~> 7.0.0"; rm Gemfile.lock; bundle install; bundle exec rake ci)
+(asdf shell ruby 3.1.2; export RAILS_VERSION="~> 7.0.0"; rm Gemfile.lock; bundle install; bundle exec rake ci)
+```
+
+It assumes you have [`asdf`](https://asdf-vm.com/) installed to manage your ruby versions, which is very convenient.
+
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rud/lograge_rails_request_queuing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LogrageRailsRequestQueuing project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rud/lograge_rails_request_queuing/blob/master/CODE_OF_CONDUCT.md).
+
+## Historical note
+
+Until 2022-11 this gem was called [lograge_rails_request_queuing](https://rubygems.org/gems/lograge_rails_request_queuing).
+It was renamed to make it easier to talk about.

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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 = "LogrageRailsRequestQueuing"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc "Run all tests"
+task ci: :test
+
+task default: :test

data/lib/lograge_waittime/engine.rb

@@ -0,0 +1,13 @@
+module LogrageWaittime
+  # Hook into Rails loading
+  class Engine < ::Rails::Engine
+    isolate_namespace LogrageWaittime
+
+    config.autoload_once_paths << File.expand_path("lib", __dir__)
+
+    initializer "lograge_waittime.add_waittime_middleware" do |app|
+      # As we use RequestStore, setup our middleware after that one
+      app.middleware.insert_after RequestStore::Middleware, LogrageWaittime::RequestStartedMiddleware
+    end
+  end
+end

data/lib/lograge_waittime/request_queuing.rb

@@ -0,0 +1,52 @@
+module LogrageWaittime
+  class RequestQueuing
+    # How long was the request queued for, in milliseconds
+    attr_reader :queued_ms
+    attr_reader :request_started_at, :request_queued_raw
+
+    REQUEST_START_HEADER = "HTTP_X_REQUEST_START"
+    EARLIEST_REQUEST_DATE = Time.new(2000)
+
+    def initialize(env, request_started_at = Time.zone.now.to_f)
+      @request_queued_raw = request_start_header(env)
+      @request_started_at = request_started_at
+      @queued_ms = calculate_queued_ms
+    end
+
+    def request_queued_at
+      return if request_queued_float.blank?
+      @request_queued_at ||= [1000, 1].each do |divisor|
+        adjusted = Time.zone.at(request_queued_float / divisor)
+        return adjusted if adjusted > EARLIEST_REQUEST_DATE
+      end
+    end
+
+    private
+
+    def calculate_queued_ms
+      return if request_queued_at.blank?
+
+      waiting_interval_secs = request_started_at - request_queued_at.to_f
+      return if waiting_interval_secs < 0 # clocks out of alignment
+
+      waiting_interval_secs * 1000
+    end
+
+    def request_queued_float
+      return nil if request_queued_raw.blank?
+
+      # convert values of the form:
+      #   "t=1529578997.145"
+      #     "1529578997145"
+      # to a Float:
+
+      if request_queued_raw =~ /(t=)?([.\d+]+)/
+        Float(Regexp.last_match(2))
+      end
+    end
+
+    def request_start_header(env)
+      env[REQUEST_START_HEADER]
+    end
+  end
+end

data/lib/lograge_waittime/request_started_middleware.rb

@@ -0,0 +1,13 @@
+module LogrageWaittime
+  # Track at what time the request handling starts
+  class RequestStartedMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      ::RequestStore[:lograge_waittime] = ::LogrageWaittime::RequestQueuing.new(env)
+      @app.call env
+    end
+  end
+end

data/lib/lograge_waittime/version.rb

@@ -0,0 +1,3 @@
+module LogrageWaittime
+  VERSION = "0.4.0"
+end

data/lib/lograge_waittime.rb

@@ -0,0 +1,8 @@
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
+
+module LogrageWaittime
+end
+
+loader.eager_load

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: lograge_waittime
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Laust Rud Jacobsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- laust@valuestream.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/lograge_waittime.rb
+- lib/lograge_waittime/engine.rb
+- lib/lograge_waittime/request_queuing.rb
+- lib/lograge_waittime/request_started_middleware.rb
+- lib/lograge_waittime/version.rb
+homepage: https://github.com/rud/lograge_waittime
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Add webserver request queueing time to lograge output.
+test_files: []