puma-newrelic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5769a5858c17962efa9a1a6ea526af1fc137fa694a1b3fc5e3a4fbc65d8108c8
+  data.tar.gz: 13a875db19065aafe345e047aef97365c19fc4fc16c57b4dd025929f94a87adf
+SHA512:
+  metadata.gz: 377bbdafe5959ff321de9953aed0d880c6047d6fb1e46de978f825b52cf931736a73c192416218e23b4d47314ab5acb1db320f7097d2db98eebb8d86a6003e26
+  data.tar.gz: 6f4e9144aad5b4763dbb04006b60869a99f7f7ed6427471acfb0681072a9ead28b7a43f4a3c9a95ccba5867c26f575d2922e37c9636754d2dfe9c5731244dadb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at benoist.claassen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in puma-newrelic.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,43 @@
+# 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 'new-relic-stats'` to your puma.rb
+* Create a dashboard on the NewRelic insights or NewRelic One
+
+## 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/[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).
+
+
+## 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/[USERNAME]/puma-newrelic/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "puma/newrelic"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/puma/new_relic/sampler.rb

@@ -0,0 +1,59 @@
+module Puma
+  module NewRelic
+    class Sampler
+      KEYS = %w(backlog running pool_capacity max_threads)
+
+      def initialize(launcher, sample_rate)
+        @launcher       = launcher
+        @sample_rate    = sample_rate
+        @last_sample_at = Time.now
+      end
+
+      def start
+        @running = true
+        while @running
+          sleep 1
+          begin
+            if should_sample?
+              @last_sample_at = Time.now
+
+              parse JSON.parse(@launcher.stats)
+            end
+          rescue Exception => e
+            ::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 }
+        sum     = ->(key, value) { metrics[key] += value if KEYS.include?(key) }
+
+        if stats["workers"]
+          metrics["workers"] = stats["workers"]
+          stats["worker_status"].each do |worker|
+            worker["last_status"].each(&sum)
+          end
+        else
+          stats.each(&sum)
+        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/new_relic/version.rb

@@ -0,0 +1,5 @@
+module Puma
+  module NewRelic
+    VERSION = "0.1.0"
+  end
+end

data/lib/puma/plugin/new_relic_stats.rb

@@ -0,0 +1,16 @@
+require 'puma/new_relic/sampler'
+
+Puma::Plugin.create do
+  def start(launcher)
+    sampler = Puma::NewRelic::Sampler.new(launcher, 15)
+    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

data/puma-newrelic.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/puma/new_relic/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = "puma-newrelic"
+  spec.version = Puma::NewRelic::VERSION
+  spec.authors = ["Benoist Claassen"]
+  spec.email   = ["benoist.claassen@gmail.com"]
+
+  spec.summary               = %q{New Relic Puma Stats sampler}
+  spec.description           = %q{Samples the puma stats and creates a custom metric for NewRelic}
+  spec.homepage              = "https://github.com/benoist/puma-newrelic"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.add_runtime_dependency 'puma', '>= 3.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: puma-newrelic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benoist Claassen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-14 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'
+description: Samples the puma stats and creates a custom metric for NewRelic
+email:
+- benoist.claassen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puma/new_relic/sampler.rb
+- lib/puma/new_relic/version.rb
+- lib/puma/plugin/new_relic_stats.rb
+- puma-newrelic.gemspec
+homepage: https://github.com/benoist/puma-newrelic
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: New Relic Puma Stats sampler
+test_files: []