puma_newrelic_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e94cac33010d4c35c98c1522eb499b8b91e4a77733fe45219ac4564a71cf80e
+  data.tar.gz: eae2ed06c74a056ed165558f7e38c4140a5c148db53250d8aab64e908bf8b4f9
+SHA512:
+  metadata.gz: ebade4a25979c72480ed5e8eccc8c6f5d8f7cb754e8a6d4280715e6856dc78928e7e9b341540dbe626f17a8d42bcdb66dc7b711f2982e32681593fa4d9503d42
+  data.tar.gz: 6ac4cd9fc4d80825349a24c44355f71b95071d2011577686566708f424dd9b927f2ad4d9cacaa3dad77b44e69b4f22a74dc93150685c0f6550c93e3c699bf8a3

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-10
+
+- Initial release
+- Support for collecting Puma stats in single and cluster mode
+- NewRelic integration for metrics reporting
+- Configurable collection interval and control settings

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 Kevin Berthier
+
+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,66 @@
+# PumaNewrelicStats
+
+A Ruby gem that collects Puma server statistics and reports them to New Relic. It works with both single and cluster mode Puma servers, providing metrics about backlog, running threads, pool capacity, and request counts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puma_newrelic_stats'
+```
+
+Add this line to `config/puma.rb`:
+
+```ruby
+activate_control_app
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Configure the gem in an initializer:
+
+```ruby
+# filepath: config/initializers/puma_newrelic_stats.rb
+PumaNewrelicStats.configure do |config|
+  config.interval = 15      # Stats collection interval in seconds (default: 15)
+  config.control_port = 9293  # Puma control port (default: 9293)
+  config.control_url = "http://127.0.0.1:9293/puma/stats"  # Custom stats URL if needed
+end
+
+PumaNewrelicStats.start
+```
+
+### Metrics Collected
+
+The following metrics are reported to New Relic:
+
+- `Custom/Puma/Total/Backlog` - Total number of backlog requests
+- `Custom/Puma/Total/RunningThreads` - Total number of running threads
+- `Custom/Puma/Total/PoolCapacity` - Total thread pool capacity
+- `Custom/Puma/Total/MaxThreads` - Total maximum threads
+- `Custom/Puma/Total/RequestsCount` - Total number of requests processed
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/codeur/puma-newrelic-stats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/codeur/puma-newrelic-stats/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 PumaNewrelicStats project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codeur/puma-newrelic-stats/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/puma_newrelic_stats/collector.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PumaNewrelicStats
+  class Collector
+    def start
+      Thread.new do
+        loop do
+          collect_metrics
+          sleep PumaNewrelicStats.configuration.interval
+        end
+      end
+    end
+
+    private
+
+    def fetch_puma_stats
+      url = URI(PumaNewrelicStats.configuration.control_url)
+      response = Net::HTTP.get(url)
+      JSON.parse(response)
+    rescue StandardError => e
+      NewRelic::Agent.logger.error("Error fetching Puma stats: #{e.message}")
+    end
+
+    def collect_metrics
+      stats = fetch_puma_stats
+      return unless stats
+
+      totals = calculate_totals(stats)
+      record_metrics(totals)
+    rescue StandardError => e
+      NewRelic::Agent.logger.error("Error recording Puma stats: #{e.message}")
+    end
+
+    def calculate_totals(stats)
+      totals = { backlog: 0, running: 0, pool_capacity: 0, max_threads: 0, requests_count: 0 }
+
+      if stats['worker_status'] # Cluster mode
+        stats['worker_status'].each do |worker|
+          last_status = worker['last_status'] || {}
+          update_totals(totals, last_status)
+        end
+      else # Single mode
+        update_totals(totals, stats)
+      end
+
+      totals
+    end
+
+    def update_totals(totals, status)
+      totals[:backlog] += status['backlog'].to_i
+      totals[:running] += status['running'].to_i
+      totals[:pool_capacity] += status['pool_capacity'].to_i
+      totals[:max_threads] += status['max_threads'].to_i
+      totals[:requests_count] += status['requests_count'].to_i
+    end
+
+    def record_metrics(totals)
+      NewRelic::Agent.record_metric('Custom/Puma/Total/Backlog', totals[:backlog])
+      NewRelic::Agent.record_metric('Custom/Puma/Total/RunningThreads', totals[:running])
+      NewRelic::Agent.record_metric('Custom/Puma/Total/PoolCapacity', totals[:pool_capacity])
+      NewRelic::Agent.record_metric('Custom/Puma/Total/MaxThreads', totals[:max_threads])
+      NewRelic::Agent.record_metric('Custom/Puma/Total/RequestsCount', totals[:requests_count])
+    end
+  end
+end

data/lib/puma_newrelic_stats/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PumaNewrelicStats
+  class Configuration
+    attr_accessor :control_url, :interval, :control_port
+
+    def initialize
+      @interval = 15
+      @control_port = 9293
+      @control_url = "http://127.0.0.1:#{@control_port}/puma/stats"
+    end
+  end
+end

data/lib/puma_newrelic_stats/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PumaNewrelicStats
+  VERSION = '0.1.0'
+end

data/lib/puma_newrelic_stats.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'puma_newrelic_stats/version'
+require 'puma_newrelic_stats/configuration'
+require 'puma_newrelic_stats/collector'
+
+module PumaNewrelicStats
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def start
+      return if defined?(Puma) && Puma.respond_to?(:worker_index) && !Puma.worker_index.nil?
+
+      Collector.new.start
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: puma_newrelic_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Codeur SAS
+bindir: exe
+cert_chain: []
+date: 2025-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  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'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Collect Puma stats and send them to NewRelic via control app
+email:
+- dev@codeur.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puma_newrelic_stats.rb
+- lib/puma_newrelic_stats/collector.rb
+- lib/puma_newrelic_stats/configuration.rb
+- lib/puma_newrelic_stats/version.rb
+homepage: https://github.com/codeur/puma-newrelic-stats
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/codeur/puma-newrelic-stats
+  source_code_uri: https://github.com/codeur/puma-newrelic-stats
+  changelog_uri: https://github.com/codeur/puma-newrelic-stats/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Collect Puma stats and send them to NewRelic via control app
+test_files: []