puma-stats 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f396129e8be9e85b76570d975528664a442288b
+  data.tar.gz: 9d9bd1a156559b8e13d59936c22b51928f42eb67
+SHA512:
+  metadata.gz: 7a234756a43d6b54f8edc3f547f837cef073c3ebd33590ef50d2cf8bb2c5ba9373a84de5872aac7256438ee915c1c0d67d6676627aba6bf50f47216870e075c5
+  data.tar.gz: 482236a96b8589e23404aa0367f4dcd58f89ad76e76a065f98d4bb4d3ca1bad18ceb3995b3fec57ecb1d0befa65d480cf379145ca4ba38af97c87497eadd825c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+Initial release of the `puma-stats` gem.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 harmjanblok
+
+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 @@
+# puma-stats
+
+A puma plugin to expose Puma's internal statistics.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puma-stats'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puma-stats
+
+## Usage
+
+Add following lines to your puma `config.rb` (see
+[Configuration File](https://github.com/puma/puma#configuration-file)):
+
+```ruby
+# config/puma.rb
+
+plugin 'stats'
+
+# Bind the stats server to "url". "tcp://" is the only accepted protocol.
+#
+# stats_url 'tcp://0.0.0.0:12345'
+# stats_token 'knockknock'
+```
+
+## Credits
+
+The gem is inspired by the following projects:
+* https://github.com/puma/puma-metrics
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :server do
+  require 'puma'
+  require 'puma/configuration'
+  require 'puma/events'
+  require 'puma/plugin/stats.rb'
+
+  configuration = Puma::Configuration.new do |config|
+    config.bind 'tcp://127.0.0.1:0'
+    config.stats_url 'tcp://127.0.0.1:12345'
+    config.plugin 'stats'
+    config.workers 1
+    config.app do |_env|
+      [200, {}, ['Hello World']]
+    end
+  end
+
+  events = Puma::Events.new STDOUT, STDERR
+  launcher = Puma::Launcher.new(configuration, events: events)
+  launcher.run
+end
+
+task default: :test

data/lib/puma/plugin/stats.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'puma/stats/dsl'
+
+Puma::Plugin.create do
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+  def start(launcher)
+    str = launcher.options[:stats_url] || 'tcp://0.0.0.0:51209'
+
+    require 'puma/stats/app'
+
+    app = Puma::Stats::App.new launcher
+    uri = URI.parse str
+
+    stats = Puma::Server.new app, launcher.events
+    stats.min_threads = 0
+    stats.max_threads = 1
+
+    case uri.scheme
+    when 'tcp'
+      optional_token = launcher.options[:stats_token] ? "with auth token: #{launcher.options[:stats_token]}" : '' 
+      launcher.events.log "* Starting stats server on URI: #{str} #{optional_token}"
+      stats.add_tcp_listener uri.host, uri.port
+    else
+      launcher.events.error "Invalid stats server URI: #{str}"
+    end
+
+    launcher.events.register(:state) do |state|
+      if %i[halt restart stop].include?(state)
+        stats.stop(true) unless stats.shutting_down?
+      end
+    end
+
+    stats.run
+  end
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+end

data/lib/puma/stats/app.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Puma
+  module Stats
+    class App
+      def initialize(launcher)
+        @launcher = launcher
+        @auth_token = launcher.options[:stats_token]
+      end
+
+      def call(env)
+        unless authenticate(env)
+          return rack_response(403, "Invalid stats auth token", 'text/plain')
+        end
+
+        case env['PATH_INFO']
+        when /\/puma-stats-gc$/
+          rack_response(200, GC.stat.to_json)
+
+        when /\/puma-stats$/
+          rack_response(200, @launcher.stats)
+
+        else
+          rack_response 404, "Unsupported request", 'text/plain'
+        end
+      end
+
+      private
+
+      def authenticate(env)
+        return true unless @auth_token
+        env['QUERY_STRING'].to_s.split(/&;/).include?("token=#{@auth_token}")
+      end
+
+      def rack_response(status, body, content_type='application/json')
+        headers = {
+          'Content-Type'   => content_type,
+          'Content-Length' => body.bytesize.to_s
+        }
+        [status, headers, [body]]
+      end
+    end
+  end
+end

data/lib/puma/stats/dsl.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Puma
+  class DSL
+    def stats_url(url = nil)
+      @options[:stats_url] = url
+    end
+
+    def stats_token(token = nil)
+      @options[:stats_token] = token
+    end
+  end
+end

data/lib/puma/stats/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Puma
+  module Stats
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: puma-stats
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom Kishel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A puma plugin to expose Puma's internal statistics
+email: tom.kishel@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/puma/plugin/stats.rb
+- lib/puma/stats/app.rb
+- lib/puma/stats/dsl.rb
+- lib/puma/stats/version.rb
+homepage: https://github.com/tkishel/puma-stats
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Expose Puma's internal statistics
+test_files: []