puma_backlog_detector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 390c6ae8719583ea636bb11da329356bdeba00ee
+  data.tar.gz: dcaafcf2a062c9851883076cac95061dedb15903
+SHA512:
+  metadata.gz: c3f9992807274b5ffd9b06c7f43801c548342d9b6a06981b71cfc05670c8ea2af0a9ffd64097e8d23331974995a39b28b64209fff6eedc6861736e933c816087
+  data.tar.gz: 192b569443c39911f844a97b79af605c93e3f3cf0c2d4f10519a777177a1cd3edb011136b0590832a9f99c2a63088ee0baf8b49d7d74ccff913001805a824600

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puma_backlog_detector.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# PumaBacklogDetector
+
+Periodically checks Puma backlog and creates a flag file if too high.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puma_backlog_detector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puma_backlog_detector
+
+## Usage
+
+In rails config:
+
+```ruby
+  config.puma_backlog_detector.flag_path = '/run/app/congested.flag'
+  config.puma_backlog_detector.max_backlog = 16
+  config.puma_backlog_detector.check_interval = 0.01 # seconds
+```
+
+In nginx config:
+
+```
+  location / {
+    proxy_pass http://localhost:300;
+
+    if (-f /run/app/congested.flag) {
+      return 503;
+    }
+  }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/dividedmind/puma_backlog_detector.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "puma_backlog_detector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/puma_backlog_detector.rb

@@ -0,0 +1,49 @@
+require "puma_backlog_detector/version"
+require "puma_backlog_detector/railtie" if defined? Rails
+
+class PumaBacklogDetector
+  def initialize flag_path, max_backlog = 16
+    @flag = FlagFile.new flag_path
+    @max_backlog = max_backlog
+  end
+
+  def check
+    if server = Puma::Server.current
+      @flag.set server.backlog > @max_backlog
+    end
+  end
+
+  def check_periodically interval_s = 0.01
+    while true
+      check
+      sleep interval_s
+    end
+  end
+
+  def check_in_background interval_s = 0.01
+    @thread = Thread.new { check_periodically interval_s }
+  end
+
+  def stop
+    if @thread
+      @thread.exit
+      @thread.join
+      @thread = nil
+    end
+  end
+
+  class FlagFile
+    def initialize path
+      @path = path
+      @exists = File.exists? path
+      set false
+    end
+
+    def set value
+      if @exists != value
+        FileUtils.send((value ? :touch : :rm_f), @path)
+        @exists = value
+      end
+    end
+  end
+end

data/lib/puma_backlog_detector/railtie.rb

@@ -0,0 +1,16 @@
+class PumaBacklogDetector
+  class Railtie < Rails::Railtie
+    config.puma_backlog_detector = ActiveSupport::OrderedOptions.new
+    config.puma_backlog_detector.max_backlog = 16
+    config.puma_backlog_detector.check_interval = 0.01
+    config.puma_backlog_detector.flag_path = nil
+
+    initializer "puma_backlog_detector.run" do
+      conf = config.puma_backlog_detector
+      if conf.flag_path
+        @puma_backlog_detector = PumaBacklogDetector.new conf.flag_path, conf.max_backlog
+        @puma_backlog_detector.check_in_background conf.check_interval
+      end
+    end
+  end
+end

data/lib/puma_backlog_detector/version.rb

@@ -0,0 +1,3 @@
+class PumaBacklogDetector
+  VERSION = "0.1.0"
+end

data/puma_backlog_detector.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puma_backlog_detector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puma_backlog_detector"
+  spec.version       = PumaBacklogDetector::VERSION
+  spec.authors       = ["Rafał Rzepecki"]
+  spec.email         = ["rafal@conjur.net"]
+
+  spec.summary       = %q{Periodically check Puma backlog and write a flag file}
+  spec.homepage      = "https://github.com/dividedmind/puma_backlog_detector"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "puma", "~> 3.6"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: puma_backlog_detector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafał Rzepecki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- rafal@conjur.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puma_backlog_detector.rb
+- lib/puma_backlog_detector/railtie.rb
+- lib/puma_backlog_detector/version.rb
+- puma_backlog_detector.gemspec
+homepage: https://github.com/dividedmind/puma_backlog_detector
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Periodically check Puma backlog and write a flag file
+test_files: []