puma-newrelic-codeur 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e195287b18055147b79b50cc78d44befa3c7b40ea72cc24cde2c69b9a67d546
+  data.tar.gz: ccdcf8d5f9f7cadd582cf8890240ed9d4d6898847bcd7287f99161646f5b6fb8
+SHA512:
+  metadata.gz: dfe22844effa9205d4e819d9b450cd35abdb57f7af1ee88a42fb04c1781f6b2b1554e19fc91b2019c192c439a1eae6bba056c69db20db6f19fc70a3fd18a6781
+  data.tar.gz: 385b990229ef0eeb227fc0f32154af04a325c34dfff661ac94494306232c9ec8fbc2c8bfd9a5c989dcff6cefce9159627079f68f70ddb610d1c1c1ed1a0b4bdf

data/.standard.yml

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

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+## 0.1.2
+- Added config options
+
+## 0.1.1
+- Use hash stats for new version of puma (Thanks @mic-kul)
+
+## O.1.0
+- Initial release

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,64 @@
+# Puma::NewRelic
+
+This is a Puma plugin for NewRelic custom metrics.
+It will sample the Puma stats and create a custom metric for NewRelic.
+You can view the information in the NewRelic insights or in NewRelic One.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puma-newrelic'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install puma-newrelic
+
+## Usage
+
+- Install the gem
+- Add `plugin 'newrelic'` to your puma.rb
+- Create a dashboard on the NewRelic insights or NewRelic One
+
+NQRL example:
+
+```SQL
+SELECT rate(average(newrelic.timeslice.value), 1 minute)
+FROM Metric
+WHERE appName ='My App Name'
+WITH METRIC_FORMAT 'Custom/Puma/pool_capacity'
+TIMESERIES FACET `host` LIMIT 10 SINCE 1800 seconds ago
+```
+
+## Extra config in newrelic.yml
+
+```yaml
+common: &default_settings
+  puma:
+    sample_rate: 15
+    keys:
+      - backlog
+      - running
+      - pool_capacity
+      - max_threads
+```
+
+## 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/codeur/puma-newrelic. 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/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Puma::NewRelic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codeur/puma-newrelic/blob/main/CODE_OF_CONDUCT.md).

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/newrelic/plugin.rb

@@ -0,0 +1,23 @@
+require_relative "sampler"
+require "puma/plugin"
+
+module Puma
+  module NewRelic
+    class Plugin < Puma::Plugin
+      def start(launcher)
+        sampler = Puma::NewRelic::Sampler.new(launcher)
+        launcher.events.register(:state) do |state|
+          if %i[halt restart stop].include?(state)
+            sampler.stop
+          end
+        end
+
+        in_background do
+          sampler.start
+        end
+      end
+    end
+
+    Puma::Plugins.register "newrelic", Plugin
+  end
+end

data/lib/puma/newrelic/sampler.rb

@@ -0,0 +1,64 @@
+require "newrelic_rpm"
+
+module Puma
+  module NewRelic
+    class Sampler
+      def initialize(launcher)
+        config = ::NewRelic::Agent.config[:puma] || {}
+        @launcher = launcher
+        @sample_rate = config.fetch("sample_rate", 15)
+        @keys = config.fetch("keys", %w[backlog running pool_capacity max_threads]).map(&:to_s)
+        @last_sample_at = Time.now
+      end
+
+      def start
+        @running = true
+        while @running
+          sleep 1
+          begin
+            if should_sample?
+              @last_sample_at = Time.now
+              puma_stats = @launcher.stats
+              if puma_stats.is_a?(Hash)
+                parse puma_stats
+              else
+                parse JSON.parse(puma_stats, symbolize_names: true)
+              end
+            end
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            ::NewRelic::Agent.logger.error(e.message)
+          end
+        end
+      end
+
+      def should_sample?
+        Time.now - @last_sample_at > @sample_rate
+      end
+
+      def stop
+        @running = false
+      end
+
+      def parse(stats)
+        metrics = Hash.new { |h, k| h[k] = 0 }
+
+        if stats[:workers]
+          metrics[:workers] = stats[:workers]
+          stats[:worker_status].each do |worker|
+            worker[:last_status].each { |key, value| metrics[key.to_s] += value if @keys.include?(key.to_s) }
+          end
+        else
+          stats.each { |key, value| metrics[key.to_s] += value if @keys.include?(key.to_s) }
+        end
+        report_metrics(metrics)
+      end
+
+      def report_metrics(metrics)
+        metrics.each do |key, value|
+          ::NewRelic::Agent.logger.debug("Recorded metric: Custom/Puma/#{key}=#{value}")
+          ::NewRelic::Agent.record_metric("Custom/Puma/#{key}", value)
+        end
+      end
+    end
+  end
+end

data/lib/puma/newrelic/version.rb

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

data/lib/puma/newrelic.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "newrelic/version"
+
+module Puma
+  module NewRelic
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end
+
+require_relative "newrelic/plugin"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: puma-newrelic-codeur
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Benoist Claassen
+- Codeur SAS
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-23 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'
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Samples the puma stats and creates a custom metric for NewRelic
+email:
+- benoist.claassen@gmail.com
+- dev@codeur.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puma/newrelic.rb
+- lib/puma/newrelic/plugin.rb
+- lib/puma/newrelic/sampler.rb
+- lib/puma/newrelic/version.rb
+homepage: https://github.com/codeur/puma-newrelic
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/codeur/puma-newrelic
+  source_code_uri: https://github.com/codeur/puma-newrelic
+  changelog_uri: https://github.com/codeur/puma-newrelic/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: New Relic Puma Stats sampler
+test_files: []