puma-log_stats-codeur 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2449156394b5c86c2bee695565450e4c49a0b2bb87b15d3e7cb03e21ac47b322
+  data.tar.gz: 91887bd1d2f23c594889504063268d5dfeadcebd2a1539bbd4300aec14625eb4
+SHA512:
+  metadata.gz: 3084f6e89321b110e7bec943ff66435dbc3446a84257929e937a073bc80e8ca21209661050dbc9c4b2bf7a6d3f14dd291b31221eeafe937b8e737974c1bda630
+  data.tar.gz: 6b6f9f8f4fe2925f4dccdd89b503516d350932e0875fb3d50e42eb2c21f4b8f5ad10c53108564fe8ec721a47a9d1add5bc464076ac4affc8a873f08692002b59

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Brice TEXIER
+
+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,40 @@
+# PumaLogStats
+
+Puma plugin to log server stats whenever the number of concurrent requests exceeds a configured threshold.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puma-log_stats'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install puma-log_stats
+
+## Usage
+
+This plugin is loaded using Puma's plugin API. To enable, add a `plugin :log_stats` directive to your Puma config DSL, then configure the `LogStats` object with any additional configuration:
+
+```ruby
+# config/puma.rb
+
+plugin :log_stats
+LogStats.threshold = 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/codeur/puma-log_stats.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/puma/log_stats/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Puma
+  module LogStats
+    VERSION = "0.1.1"
+  end
+end

data/lib/puma/log_stats.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# require "puma/log_stats/version"

data/lib/puma/plugin/log_stats.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+require "puma/plugin"
+
+module LogStats
+  class << self
+    # Interval between logging attempts in seconds.
+    attr_accessor :interval
+    LogStats.interval = 10
+
+    attr_accessor :alarm_on_sentry
+    LogStats.alarm_on_sentry = true
+
+    attr_accessor :alarm_notification_interval
+    LogStats.alarm_notification_interval = 60
+
+    attr_accessor :warning_threshold
+    LogStats.warning_threshold = 0.7
+
+    attr_accessor :critical_threshold
+    LogStats.critical_threshold = 0.85
+  end
+
+  def start(launcher)
+    @launcher = launcher
+    launcher.events.register(:state) do |state|
+      if %i[halt restart stop].include?(state)
+        @running = false
+      end
+    end
+
+    in_background do
+      @running = true
+      @load_level = :normal
+      while @running
+        sleep LogStats.interval
+        @stats = Puma.stats_hash
+        log(status)
+        check_alarms
+      end
+    end
+  end
+
+  def check_alarms
+    threshold_reached(:critical, LogStats.critical_threshold) ||
+      threshold_reached(:warning, LogStats.warning_threshold) ||
+      normal_load
+  end
+
+  def threshold_reached(level, threshold)
+    return false if threads_load < threshold
+
+    notify_alarm("#{level.to_s.upcase}: Puma threads load is more than #{threshold * 100}% (#{max_threads - pool_capacity}/#{max_threads})")
+    @load_level = level if @load_level != level
+    true
+  end
+
+  def normal_load
+    return if @load_level == :normal
+
+    log("INFO: Puma threads load is back to normal values")
+    @load_level = :normal
+  end
+
+  def notify_alarm(message)
+    if @notified_at.nil? || (Time.now - @notified_at) < LogStats.alarm_notification_interval
+      log(message)
+      Sentry.capture_message(message) if LogStats.alarm_on_sentry && defined?(Sentry)
+      @notified_at = Time.now
+    end
+  end
+
+  def status
+    if clustered?
+      "cluster: #{booted_workers}/#{workers} workers: #{running}/#{max_threads} threads, #{pool_capacity} available, #{backlog} backlog"
+    else
+      "single: #{running}/#{max_threads} threads, #{pool_capacity} available, #{backlog} backlog"
+    end
+  end
+
+  def log(str)
+    @launcher.log_writer.log("[#{Time.now}][puma #{Puma::Const::VERSION}] #{str}")
+  end
+
+  def threads_load
+    1.0 - pool_capacity.to_f / max_threads.to_f
+  end
+
+  def clustered?
+    @stats.key?(:workers)
+  end
+
+  def workers
+    @stats.fetch(:workers, 1)
+  end
+
+  def booted_workers
+    @stats.fetch(:booted_workers, 1)
+  end
+
+  def running
+    if clustered?
+      @stats[:worker_status].sum { |s| s[:last_status].fetch(:running, 0) }
+    else
+      @stats.fetch(:running, 0)
+    end
+  end
+
+  def backlog
+    if clustered?
+      @stats[:worker_status].sum { |s| s[:last_status].fetch(:backlog, 0) }
+    else
+      @stats.fetch(:backlog, 0)
+    end
+  end
+
+  def pool_capacity
+    if clustered?
+      @stats[:worker_status].sum { |s| s[:last_status].fetch(:pool_capacity, 0) }
+    else
+      @stats.fetch(:pool_capacity, 0)
+    end
+  end
+
+  def max_threads
+    if clustered?
+      @stats[:worker_status].sum { |s| s[:last_status].fetch(:max_threads, 0) }
+    else
+      @stats.fetch(:max_threads, 0)
+    end
+  end
+end
+
+Puma::Plugin.create do
+  include LogStats
+end
+
+# require "puma"
+# require "puma/plugin"
+# require "json"
+
+# # Puma plugin to log server stats whenever the number of
+# # concurrent requests exceeds a configured threshold.
+# module LogStats
+#   STAT_METHODS = %i[backlog running pool_capacity max_threads requests_count].freeze
+
+#   class << self
+#     # Minimum concurrent requests per process that will trigger logging server
+#     # stats, or nil to disable logging.
+#     # Default is the max number of threads in the server's thread pool.
+#     # If this attribute is a Proc, it will be re-evaluated each interval.
+#     attr_accessor :threshold
+#     LogStats.threshold = :max
+
+#     # Interval between logging attempts in seconds.
+#     attr_accessor :interval
+#     LogStats.interval = 1
+
+#     # Proc to filter backtraces.
+#     attr_accessor :backtrace_filter
+#     LogStats.backtrace_filter = ->(bt) { bt }
+#   end
+
+#   Puma::Plugin.create do
+#     attr_reader :launcher
+
+#     def start(launcher)
+#       @launcher = launcher
+#       launcher.events.register(:state) do |state|
+#         @state = state
+#         stats_logger_thread if state == :running
+#       end
+
+#       in_background { start }
+#     end
+
+#     private
+
+#     def stats_logger_thread
+#       Thread.new do
+#         if Thread.current.respond_to?(:name=)
+#           Thread.current.name = "puma stats logger"
+#         end
+#         start while @state == :running
+#       end
+#     end
+
+#     def start
+#       sleep LogStats.interval
+#       return unless server
+
+#       if should_log?
+#         stats = server_stats
+#         stats[:threads] = thread_backtraces
+#         stats[:gc] = GC.stat
+#         log stats.to_json
+#       end
+#     rescue => e
+#       log "LogStats failed: #{e}\n  #{e.backtrace.join("\n    ")}"
+#     end
+
+#     def log(str)
+#       launcher.log_writer.log str
+#     end
+
+#     # Save reference to Server object from the thread-local key.
+#     def server
+#       @server ||= Thread.list.map { |t| t[Puma::Server::ThreadLocalKey] }.compact.first
+#     end
+
+#     def server_stats
+#       STAT_METHODS.select(&server.method(:respond_to?))
+#         .map { |name| [name, server.send(name) || 0] }.to_h
+#     end
+
+#     # True if current server load meets configured threshold.
+#     def should_log?
+#       threshold = LogStats.threshold
+#       threshold = threshold.call if threshold.is_a?(Proc)
+#       threshold = server.max_threads if threshold == :max
+#       threshold && (server.max_threads - server.pool_capacity) >= threshold
+#     end
+
+#     def thread_backtraces
+#       worker_threads.map do |t|
+#         name = t.respond_to?(:name) ? t.name : thread.object_id.to_s(36)
+#         [name, LogStats.backtrace_filter.call(t.backtrace)]
+#       end.sort.to_h
+#     end
+
+#     # List all non-idle worker threads in the thread pool.
+#     def worker_threads
+#       server.instance_variable_get(:@thread_pool)
+#         .instance_variable_get(:@workers)
+#         .reject { |t| t.backtrace.first.match?(/thread_pool\.rb.*sleep/) }
+#     end
+#   end
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: puma-log_stats-codeur
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Will Jordan
+- Codeur SAS
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Puma plugin to log server stats whenever the number of concurrent requests
+  exceeds a configured threshold.
+email:
+- will@code.org
+- dev@codeur.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puma/log_stats.rb
+- lib/puma/log_stats/version.rb
+- lib/puma/plugin/log_stats.rb
+homepage: https://github.com/codeur/puma-log_stats
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/codeur/puma-log_stats
+  source_code_uri: https://github.com/codeur/puma-log_stats
+  changelog_uri: https://github.com/codeur/puma-log_stats/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Logs Puma stats when concurrent requests are high.
+test_files: []