puma-cloudwatch 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f5f9757f6fd2ca0da318c57d6e16f05072b2f7e004b7c67e863567e6a21feb
-  data.tar.gz: 354658460c267d9a730fd297f3b42e1d5d19b162a9503679d9f5f0ed40776138
+  metadata.gz: 310c3534fa2d00a6da76f26f6cbe908ac842ced68f02d49fb0ff4f7d0922e95b
+  data.tar.gz: 0ef2173e64a9517866be68af190256529184f40aacb6830c0f93960203dc2919
 SHA512:
-  metadata.gz: 28412c44a0d354767ef34d855f86560cb6f467d72ac1721897e4302a393f4d05fc3b5d681490008435c105c84c77b4d236662485282cffbb36df7e53fa662d85
-  data.tar.gz: 20437ec6faed3244a69f6ff90ba5cd6e4c1da64990509c222275133e588c718bd31dda8accb6c725946b486df474376ca78740bc5ba00cedd39d56c4258532f2
+  metadata.gz: 44a1e9b69e28968779ed60237c102a21e8d1bb3729a6ee5f013932efab906f00f723694b004e585f6b285db6ffadd2f1c1c935ba4d2a0eaff78fbf434ef52604
+  data.tar.gz: 21f44b53b79331912008bec96ac4c27b3903d16d21f79ae22ee4259ae8a8ba25fa16d79b5d4724ac9be2818097743ccc9abb65a209a344b502c32747626ef019

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.5.0] - 2023-07-11
+- [#11](https://github.com/tongueroo/puma-cloudwatch/pull/11) Added support for PUMA_CLOUDWATCH_AWS_ACCESS_KEY_ID and PUMA_CLOUDWATCH_AWS_SECRET_ACCESS_KEY env vars to configure an AWS access key
+- [#12](https://github.com/tongueroo/puma-cloudwatch/pull/12) http tcp port support also
+
 ## [0.4.8] - 2023-02-24
 - [#10](https://github.com/tongueroo/puma-cloudwatch/pull/10) fix region if check
 - loosen development dependencies

data/README.md

@@ -38,6 +38,8 @@ PUMA\_CLOUDWATCH\_ENABLED | Enables sending of the data to CloudWatch. | (unset)
 PUMA\_CLOUDWATCH\_FREQUENCY | How often to send data to CloudWatch in seconds. | 60
 PUMA\_CLOUDWATCH\_NAMESPACE | CloudWatch metric namespace | WebServer
 PUMA\_CLOUDWATCH\_AWS\_REGION | CloudWatch metric AWS region | (unset)
+PUMA\_CLOUDWATCH\_AWS\_ACCESS_KEY_ID | AWS access key ID | (unset)
+PUMA\_CLOUDWATCH\_AWS\_SECRET_ACCESS_KEY | AWS secret access key | (unset)
 PUMA\_CLOUDWATCH\_MUTE\_START\_MESSAGE | Mutes the "puma-cloudwatch plugin" startup message | (unset)
 
 ### Sum and Frequency Normalization
@@ -60,10 +62,10 @@ And then execute:
 
     $ bundle
 
-In your `config/puma.rb`
-
 Add these 2 lines your `config/puma.rb`:
 
+config/puma.rb
+
 ```ruby
 activate_control_app
 plugin :cloudwatch
@@ -75,10 +77,88 @@ It activates the puma control rack application, and enables the puma-cloudwatch
 
 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.
 
+Alternatively, you may configure an AWS Access Key ID and Secret Key with the `PUMA_CLOUDWATCH_AWS_ACCESS_KEY_ID` and `PUMA_CLOUDWATCH_AWS_SECRET_ACCESS_KEY` env variables.
+
 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.
 
+## How It Works: Internal Puma Stats Server
+
+Puma has an internal server that has a stats endpoint. It runs on a unix socket by default. The puma-cloudwatch works by running continuous loop that polls this puma socket.
+
+### Debug Internal Puma Server: Socket
+
+By default, the socket file is a random path and token. You can use `PUMA_CLOUDWATCH_DEBUG` to see the puma `control_url` and `control_auth_token`.
+
+You'll see something like this:
+
+    $ PUMA_CLOUDWATCH_DEBUG=1 rail server
+    * Starting control server on unix:///tmp/puma-status-1689096041362-18083
+    Use Ctrl-C to stop
+    puma control_url unix:///tmp/puma-status-1689096041362-18083
+    puma control_auth_token 609a3fe77de470ad87eaaf0a28a4d22d
+
+To test the socket
+
+    echo -e "GET /stats?token=62a21462ce921590337cfe8a2bf53505 HTTP/1.1\r\nHost: localhost\r\n\r\n"  | socat - UNIX-CONNECT:/tmp/puma-status-1689095966545-17509
+
+You can specify the path and disable the token to make it easier:
+
+config/puma.rb
+
+```ruby
+activate_control_app "unix://tmp/pumactl.sock", { no_token: true }
+# another example with full path, note the additinal beginning /
+# activate_control_app "unix:///full/path/tmp/pumactl.sock", { no_token: true }
+plugin :cloudwatch
+```
+
+Send a stats request to the socket with `socat`
+
+    $ echo -e "GET /stats HTTP/1.1\r\nHost: localhost\r\n\r\n"  | socat - UNIX-CONNECT:tmp/pumactl.sock
+    HTTP/1.1 200 OK
+    Content-Type: application/json
+    Connection: close
+    Content-Length: 114
+
+    {"started_at":"2023-07-11T16:32:37Z","backlog":0,"running":5,"pool_capacity":5,"max_threads":5,"requests_count":0}
+
+### Debug Internal Puma Server: TCP Port
+
+You can also use a tcp port instead.
+
+config/puma.rb
+
+```ruby
+activate_control_app "tcp://127.0.0.1:9293", { no_token: true }
+plugin :cloudwatch
+```
+
+You can see the stats with `curl`.
+
+    $ curl "localhost:9293/stats"
+    {"started_at":"2023-07-11T17:17:31Z","backlog":0,"running":5,"pool_capacity":5,"max_threads":5,"requests_count":0}
+
+### puma control-url option note
+
+If you're calling puma directly, there's an option to specify the control url and token, example:
+
+    $ puma --control-url tcp://127.0.0.1:9293 --control-token foo
+    * Listening on http://0.0.0.0:3000
+    * Starting control server on http://127.0.0.1:9293
+
+This conflicts with activate the control app in the puma.rb
+
+config/puma.rb
+
+```ruby
+activate_control_app
+plugin :cloudwatch
+```
+
+So do not use those options when using this puma plugin.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/puma-cloudwatch

data/lib/puma_cloudwatch/metrics/fetcher.rb

@@ -1,21 +1,43 @@
 require "json"
 require "socket"
+require "net/http"
+require "uri"
 
 class PumaCloudwatch::Metrics
   class Fetcher
     def initialize(options={})
       @control_url = options[:control_url]
       @control_auth_token = options[:control_auth_token]
+      if ENV['PUMA_CLOUDWATCH_DEBUG']
+        puts "puma control_url #{@control_url}"
+        puts "puma control_auth_token #{@control_auth_token}"
+      end
     end
 
     def call
       body = with_retries do
-        read_socket
+        read_data
       end
       JSON.parse(body.split("\n").last) # stats
     end
 
   private
+    def read_data
+      if @control_url.start_with?("unix://")
+        read_socket
+      else # starts with tcp://
+        read_http
+      end
+    end
+
+    def read_http
+      http_url = @control_url.sub('tcp://', 'http://')
+      url = "#{http_url}/stats?token=#{@control_auth_token}"
+      uri = URI.parse(url)
+      resp = Net::HTTP.get_response(uri)
+      resp.body
+    end
+
     def read_socket
       Socket.unix(@control_url.gsub('unix://', '')) do |socket|
         socket.print("GET /stats?token=#{@control_auth_token} HTTP/1.0\r\n\r\n")

data/lib/puma_cloudwatch/metrics/sender.rb

@@ -19,6 +19,8 @@ class PumaCloudwatch::Metrics
       @frequency = Integer(ENV['PUMA_CLOUDWATCH_FREQUENCY'] || 60)
       @enabled = ENV['PUMA_CLOUDWATCH_ENABLED'] || false
       @region = ENV['PUMA_CLOUDWATCH_AWS_REGION']
+      @access_key_id = ENV['PUMA_CLOUDWATCH_AWS_ACCESS_KEY_ID']
+      @secret_access_key = ENV['PUMA_CLOUDWATCH_AWS_SECRET_ACCESS_KEY']
     end
 
     def call
@@ -103,13 +105,20 @@ class PumaCloudwatch::Metrics
       !!@enabled
     end
 
-    def cloudwatch
-      @cloudwatch ||= if @region.nil? || @region.empty?
-                        Aws::CloudWatch::Client.new
-                      else
-                        Aws::CloudWatch::Client.new(region: @region)
-                      end
+    def aws_credentials
+      return nil if @access_key_id.nil? || @access_key_id.empty? || @secret_access_key.nil? || @secret_access_key.empty?
 
+      @aws_credentials ||= Aws::Credentials.new(
+        @access_key_id,
+        @secret_access_key
+      )
+    end
+
+    def cloudwatch
+      @cloudwatch ||= Aws::CloudWatch::Client.new({
+        region: @region,
+        credentials: aws_credentials
+      }.compact)
     rescue Aws::Errors::MissingRegionError => e
       # Happens when:
       #   1. ~/.aws/config is not also setup locally

data/lib/puma_cloudwatch/version.rb

@@ -1,3 +1,3 @@
 module PumaCloudwatch
-  VERSION = "0.4.8"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors:
 - Tung Nguyen
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatch
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - tongueroo@gmail.com
 executables: []
@@ -99,7 +99,7 @@ homepage: https://github.com/boltops-tools/puma-cloudwatch
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Puma plugin sends puma stats to CloudWatch
 test_files: []