├── .gitignore ├── .rspec ├── .ruby-version ├── .travis.yml ├── CODE_OF_CONDUCT.md ├── Gemfile ├── Gemfile.lock ├── README.md ├── RELEASE_NOTES.md ├── Rakefile ├── bin ├── console └── setup ├── config.ru ├── lib └── puma │ ├── new_relic │ ├── sampler.rb │ └── version.rb │ └── plugin │ └── new_relic_stats.rb ├── puma-newrelic.gemspec ├── puma.rb └── spec ├── puma └── newrelic_spec.rb └── spec_helper.rb /.gitignore: -------------------------------------------------------------------------------- 1 | /.bundle/ 2 | /.idea/ 3 | /.yardoc 4 | /_yardoc/ 5 | /coverage/ 6 | /doc/ 7 | /pkg/ 8 | /spec/reports/ 9 | /tmp/ 10 | 11 | # rspec failure tracking 12 | .rspec_status 13 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --format documentation 2 | --color 3 | --require spec_helper 4 | -------------------------------------------------------------------------------- /.ruby-version: -------------------------------------------------------------------------------- 1 | 3.1.1 2 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | language: ruby 3 | cache: bundler 4 | rvm: 5 | - 2.6.4 6 | before_install: gem install bundler -v 2.1.4 7 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at benoist.claassen@gmail.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [https://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: https://contributor-covenant.org 74 | [version]: https://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Specify your gem's dependencies in puma-newrelic.gemspec 4 | gemspec 5 | 6 | gem "rake", "~> 12.0" 7 | gem "rspec", "~> 3.0" 8 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | puma-newrelic (0.1.5) 5 | newrelic_rpm 6 | puma (>= 3.0) 7 | 8 | GEM 9 | remote: https://rubygems.org/ 10 | specs: 11 | diff-lcs (1.4.4) 12 | newrelic_rpm (8.6.0) 13 | nio4r (2.5.8) 14 | puma (5.6.4) 15 | nio4r (~> 2.0) 16 | rake (12.3.3) 17 | rspec (3.10.0) 18 | rspec-core (~> 3.10.0) 19 | rspec-expectations (~> 3.10.0) 20 | rspec-mocks (~> 3.10.0) 21 | rspec-core (3.10.1) 22 | rspec-support (~> 3.10.0) 23 | rspec-expectations (3.10.1) 24 | diff-lcs (>= 1.2.0, < 2.0) 25 | rspec-support (~> 3.10.0) 26 | rspec-mocks (3.10.2) 27 | diff-lcs (>= 1.2.0, < 2.0) 28 | rspec-support (~> 3.10.0) 29 | rspec-support (3.10.2) 30 | 31 | PLATFORMS 32 | ruby 33 | 34 | DEPENDENCIES 35 | puma-newrelic! 36 | rake (~> 12.0) 37 | rspec (~> 3.0) 38 | 39 | BUNDLED WITH 40 | 2.1.4 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Puma::NewRelic 2 | 3 | This is a Puma plugin for NewRelic custom metrics. 4 | It will sample the Puma stats and create a custom metric for NewRelic. 5 | You can view the information in the NewRelic insights or in NewRelic One. 6 | 7 | 8 | ## Installation 9 | 10 | Add this line to your application's Gemfile: 11 | 12 | ```ruby 13 | gem 'puma-newrelic' 14 | ``` 15 | 16 | And then execute: 17 | 18 | $ bundle install 19 | 20 | Or install it yourself as: 21 | 22 | $ gem install puma-newrelic 23 | 24 | ## Usage 25 | 26 | * Install the gem 27 | * Add `plugin 'new_relic_stats'` to your puma.rb 28 | * Create a dashboard on the NewRelic insights or NewRelic One 29 | 30 | NQRL example: 31 | ```SQL 32 | SELECT rate(average(newrelic.timeslice.value), 1 minute) 33 | FROM Metric 34 | WHERE appName ='My App Name' 35 | WITH METRIC_FORMAT 'Custom/Puma/pool_capacity' 36 | TIMESERIES FACET `host` LIMIT 10 SINCE 1800 seconds ago 37 | ``` 38 | 39 | ## Extra config in newrelic.yml 40 | ```yaml 41 | common: &default_settings 42 | puma: 43 | sample_rate: 15 44 | keys: 45 | - backlog 46 | - running 47 | - pool_capacity 48 | - max_threads 49 | ``` 50 | 51 | ## Development 52 | 53 | 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. 54 | 55 | 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). 56 | 57 | ## Contributing 58 | 59 | Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/[USERNAME]/puma-newrelic/blob/master/CODE_OF_CONDUCT.md). 60 | 61 | 62 | ## Code of Conduct 63 | 64 | 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/[USERNAME]/puma-newrelic/blob/master/CODE_OF_CONDUCT.md). 65 | -------------------------------------------------------------------------------- /RELEASE_NOTES.md: -------------------------------------------------------------------------------- 1 | # 0.1.2 2 | - Added config options 3 | 4 | # 0.1.1 5 | - Use hash stats for new version of puma (Thanks @mic-kul) 6 | 7 | # O.1.0 8 | - Initial version 9 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | require "rspec/core/rake_task" 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | 6 | task :default => :spec 7 | -------------------------------------------------------------------------------- /bin/console: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require "bundler/setup" 4 | require "puma/newrelic" 5 | 6 | # You can add fixtures and/or initialization code here to make experimenting 7 | # with your gem easier. You can also use a different console, if you like. 8 | 9 | # (If you use this, don't forget to add pry to your Gemfile!) 10 | # require "pry" 11 | # Pry.start 12 | 13 | require "irb" 14 | IRB.start(__FILE__) 15 | -------------------------------------------------------------------------------- /bin/setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | set -vx 5 | 6 | bundle install 7 | 8 | # Do any other automated setup that you need to do here 9 | -------------------------------------------------------------------------------- /config.ru: -------------------------------------------------------------------------------- 1 | # config.ru 2 | run ->(env) do 3 | 4 | end 5 | -------------------------------------------------------------------------------- /lib/puma/new_relic/sampler.rb: -------------------------------------------------------------------------------- 1 | module Puma 2 | module NewRelic 3 | class Sampler 4 | def initialize(launcher) 5 | config = ::NewRelic::Agent.config[:puma] || {} 6 | @launcher = launcher 7 | @sample_rate = config.fetch("sample_rate", 15) 8 | @keys = config.fetch("keys", %w(backlog running pool_capacity max_threads)).map(&:to_s) 9 | @last_sample_at = Time.now 10 | end 11 | 12 | def start 13 | @running = true 14 | while @running 15 | sleep 1 16 | begin 17 | if should_sample? 18 | @last_sample_at = Time.now 19 | puma_stats = @launcher.stats 20 | if puma_stats.is_a?(Hash) 21 | parse puma_stats 22 | else 23 | parse JSON.parse(puma_stats, symbolize_names: true) 24 | end 25 | end 26 | rescue Exception => e 27 | ::NewRelic::Agent.logger.error(e.message) 28 | end 29 | end 30 | end 31 | 32 | def should_sample? 33 | Time.now - @last_sample_at > @sample_rate 34 | end 35 | 36 | def stop 37 | @running = false 38 | end 39 | 40 | def parse(stats) 41 | metrics = Hash.new { |h, k| h[k] = 0 } 42 | 43 | if stats[:workers] 44 | metrics[:workers] = stats[:workers] 45 | stats[:worker_status].each do |worker| 46 | worker[:last_status].each { |key, value| metrics[key.to_s] += value if @keys.include?(key.to_s) } 47 | end 48 | else 49 | stats.each { |key, value| metrics[key.to_s] += value if @keys.include?(key.to_s) } 50 | end 51 | report_metrics(metrics) 52 | end 53 | 54 | def report_metrics(metrics) 55 | metrics.each do |key, value| 56 | ::NewRelic::Agent.logger.debug("Recorded metric: Custom/Puma/#{key}=#{value}") 57 | ::NewRelic::Agent.record_metric("Custom/Puma/#{key}", value) 58 | end 59 | end 60 | end 61 | end 62 | end 63 | -------------------------------------------------------------------------------- /lib/puma/new_relic/version.rb: -------------------------------------------------------------------------------- 1 | module Puma 2 | module NewRelic 3 | VERSION = "0.1.6" 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /lib/puma/plugin/new_relic_stats.rb: -------------------------------------------------------------------------------- 1 | require 'puma/new_relic/sampler' 2 | 3 | Puma::Plugin.create do 4 | def start(launcher) 5 | sampler = Puma::NewRelic::Sampler.new(launcher) 6 | launcher.events.register(:state) do |state| 7 | if %i[halt restart stop].include?(state) 8 | sampler.stop 9 | end 10 | end 11 | 12 | in_background do 13 | sampler.start 14 | end 15 | end 16 | end 17 | -------------------------------------------------------------------------------- /puma-newrelic.gemspec: -------------------------------------------------------------------------------- 1 | require_relative 'lib/puma/new_relic/version' 2 | 3 | Gem::Specification.new do |spec| 4 | spec.name = "puma-newrelic" 5 | spec.version = Puma::NewRelic::VERSION 6 | spec.authors = ["Benoist Claassen"] 7 | spec.email = ["benoist.claassen@gmail.com"] 8 | 9 | spec.summary = %q{New Relic Puma Stats sampler} 10 | spec.description = %q{Samples the puma stats and creates a custom metric for NewRelic} 11 | spec.homepage = "https://github.com/benoist/puma-newrelic" 12 | spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0") 13 | spec.add_runtime_dependency 'puma', '>= 3.0' 14 | spec.add_runtime_dependency 'newrelic_rpm' 15 | 16 | # Specify which files should be added to the gem when it is released. 17 | # The `git ls-files -z` loads the files in the RubyGem that have been added into git. 18 | spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do 19 | `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } 20 | end 21 | spec.bindir = "exe" 22 | spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } 23 | spec.require_paths = ["lib"] 24 | end 25 | -------------------------------------------------------------------------------- /puma.rb: -------------------------------------------------------------------------------- 1 | require "newrelic_rpm" 2 | require_relative "./lib/puma/plugin/new_relic_stats" 3 | plugin 'new_relic_stats' 4 | -------------------------------------------------------------------------------- /spec/puma/newrelic_spec.rb: -------------------------------------------------------------------------------- 1 | RSpec.describe Puma::Newrelic do 2 | it "has a version number" do 3 | expect(Puma::Newrelic::VERSION).not_to be nil 4 | end 5 | 6 | it "does something useful" do 7 | expect(false).to eq(true) 8 | end 9 | end 10 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | require "bundler/setup" 2 | require "puma/newrelic" 3 | 4 | RSpec.configure do |config| 5 | # Enable flags like --only-failures and --next-failure 6 | config.example_status_persistence_file_path = ".rspec_status" 7 | 8 | # Disable RSpec exposing methods globally on `Module` and `main` 9 | config.disable_monkey_patching! 10 | 11 | config.expect_with :rspec do |c| 12 | c.syntax = :expect 13 | end 14 | end 15 | --------------------------------------------------------------------------------