puma-cloudwatch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd707d05af913eccd60a30e1a17fde3c458c4fe89edb102ff7a29b483d65ac9d
-  data.tar.gz: 58f7896483eec60cde81ea9615d80fccf3dd63e001f80c63968f016fb0c10081
+  metadata.gz: a921bab00785245aefb2570d27d05402679d20fc8a7e27d37c4d2d3f201bf487
+  data.tar.gz: 22659775c4c299d935a76e9d1ba9f770d973d359e85f68bf0c813663157a9693
 SHA512:
-  metadata.gz: '08add2c6446a55ce039e8dfe8d0e86f01fd05b61b63cbc3e71830757034fd9ae220ad79a6a79536b416137c48adf92eafb74eb0c455e81f1f286830c1dc1c24a'
-  data.tar.gz: d30b0f1d6e88f6923aec9067c3731ff7610d48a51d450320195612998dc476456119e5be861de4d58c1e6522f1f0bc6459616810d1f2af90d03b79818eac2fcd
+  metadata.gz: 5f4dd10d03c089fb82417b6bbc883eef15042f07f58b714fc651cf3a4495a5c4afc86275bed3e480487d66c980a41487c7bb80fec12404e760ba2a5f45886f68
+  data.tar.gz: e1b87394b4f173ccabed12fffeddac6c4296aa56117181ff1297f4ded6d3e4374c9e3dd1d1b45f4ffed1a8fc1cf0cd99c3ca1b941d1bab173d1f684c4edc13ef

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0]
+- add PUMA\_CLOUDWATCH\_DEBUG flag
+- fixes for ruby 2.3
+- Update looper.rb puts
+
+## [0.1.0]
+- Initial release

data/README.md

@@ -1,4 +1,4 @@
-# Puma Cloudwatch Puma
+# Puma Cloudwatch Plugin
 
 A [puma](https://puma.io) plugin that sends puma stats to CloudWatch.
 
@@ -36,7 +36,7 @@ If you leave the `PUMA_CLOUDWATCH_FREQUENCY` at its default of 60 seconds and gr
 
 **Important**: If you change the CloudWatch send frequency, then Sum statistic must be normalized.  For example, let's say you use `PUMA_CLOUDWATCH_FREQUENCY=30`. Then puma-cloudwatch will send data every 30s. However, if the chart is still using a 1-minute period, then the Sum statistic would "double".  Capacity has not doubled, puma-cloudwatch is just sending twice as much data.  To normalize the Sum, set the time period resolution to match the frequency. In this case: 30 seconds.
 
-If you use the Average statistic, then you don't have to worry about normalizing. Average already inherently normalized.
+If you use the Average statistic, then you don't have to worry about normalizing. Average is inherently normalized.
 
 ## Installation
 
@@ -61,6 +61,14 @@ plugin :cloudwatch
 
 It activates the puma control rack application, and enables the puma-cloudwatch plugin to send metrics.
 
+### More Setup Notes
+
+Make sure that EC2 instance running the puma server has IAM permission to publish to CloudWatch. If you are using ECS, the default permissions for the ECS task should work.
+
+If are you using ECS awsvpc, make sure you have the task running on private subnets with a NAT. From the AWS docs: [Task Networking with the awsvpc Network Mode](https://docs.aws.amazon.com/en_pv/AmazonECS/latest/developerguide/task-networking.html)
+
+> The awsvpc network mode does not provide task ENIs with public IP addresses for tasks that use the EC2 launch type. To access the internet, tasks that use the EC2 launch type must be launched in a private subnet that is configured to use a NAT gateway.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/puma_cloudwatch.

data/lib/puma_cloudwatch/core_ext/array.rb

@@ -0,0 +1,7 @@
+class Array
+  # Note: Array#sum only available in ruby 2.4+
+  # Thanks: http://www.viarails.net/q/How-to-sum-an-array-of-numbers-in-Ruby
+  def sum
+    inject(0) {|sum, i|  sum + i }
+  end
+end

data/lib/puma_cloudwatch/core_ext/thread.rb

@@ -0,0 +1,18 @@
+# Hack makes sure exceptions in Threads like the one in looper.rb that reports to CloudWatch gets reported
+# instead of silently being swallowed.
+# https://bugs.ruby-lang.org/issues/6647
+class << Thread
+  alias old_new new
+
+  def new(*args, &block)
+    old_new(*args) do |*bargs|
+      begin
+        block.call(*bargs)
+      rescue Exception => e
+        raise if Thread.abort_on_exception || Thread.current.abort_on_exception
+        puts "Thread for block #{block.inspect} terminated with exception: #{e.message}"
+        puts e.backtrace.reverse.map {|line| "  #{line}"}
+      end
+    end
+  end
+end

data/lib/puma_cloudwatch/core_ext.rb

@@ -0,0 +1,7 @@
+# Only apply this monkeypatches to ruby 2.3 because a specific project uses 2.3 still.
+major, minor, _ = RUBY_VERSION.split('.')
+if major == '2' && minor == '3'
+  require "puma_cloudwatch/core_ext/thread"
+  require "puma_cloudwatch/core_ext/array"
+  require "pp"
+end

data/lib/puma_cloudwatch/metrics/looper.rb

@@ -13,14 +13,13 @@ class PumaCloudwatch::Metrics
 
     def run
       raise StandardError, "Puma control app is not activated" if @control_url == nil
-      puts "Sending metrics to CloudWatch..."
+      puts "puma-cloudwatch plugin: Will send data every #{@frequency} seconds."
       Thread.new do
         perform
       end
     end
 
     def perform
-      puts "puma-cloudwatch plugin: Will send data every #{@frequency} seconds."
       loop do
         stats = Fetcher.new(@options).call
         results = Parser.new(stats).call

data/lib/puma_cloudwatch/metrics/sender.rb

@@ -75,10 +75,14 @@ class PumaCloudwatch::Metrics
 
   private
     def put_metric_data(params)
-      if noop?
-        puts "NOOP: sending data to cloudwatch:"
+      if noop? or ENV['PUMA_CLOUDWATCH_DEBUG']
+        message = "sending data to cloudwatch:"
+        message = "NOOP: #{message}" if noop?
+        puts message
         pp params
-      else
+      end
+
+      unless noop?
         cloudwatch.put_metric_data(params)
       end
     end

data/lib/puma_cloudwatch/version.rb

@@ -1,3 +1,3 @@
 module PumaCloudwatch
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/puma_cloudwatch.rb

@@ -1,4 +1,5 @@
 require "puma_cloudwatch/version"
+require "puma_cloudwatch/core_ext"
 
 module PumaCloudwatch
   class Error < StandardError; end

data/puma-cloudwatch.gemspec

@@ -12,8 +12,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/tongueroo/puma-cloudwatch"
   spec.license       = "MIT"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-
   # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tung Nguyen
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -85,6 +86,9 @@ files:
 - lib/puma-cloudwatch.rb
 - lib/puma/plugin/cloudwatch.rb
 - lib/puma_cloudwatch.rb
+- lib/puma_cloudwatch/core_ext.rb
+- lib/puma_cloudwatch/core_ext/array.rb
+- lib/puma_cloudwatch/core_ext/thread.rb
 - lib/puma_cloudwatch/metrics.rb
 - lib/puma_cloudwatch/metrics/fetcher.rb
 - lib/puma_cloudwatch/metrics/looper.rb
@@ -95,8 +99,7 @@ files:
 homepage: https://github.com/tongueroo/puma-cloudwatch
 licenses:
 - MIT
-metadata:
-  homepage_uri: https://github.com/tongueroo/puma-cloudwatch
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths: