puma-cloudwatch 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310c3534fa2d00a6da76f26f6cbe908ac842ced68f02d49fb0ff4f7d0922e95b
-  data.tar.gz: 0ef2173e64a9517866be68af190256529184f40aacb6830c0f93960203dc2919
+  metadata.gz: ef9ffddc149af0d9bfbd27b26a36e81950f3744ec4111e56ff10f94d824133b0
+  data.tar.gz: a472a1792d0c98daaf40dbc58f6642d630963d5947c496fe7831056913390064
 SHA512:
-  metadata.gz: 44a1e9b69e28968779ed60237c102a21e8d1bb3729a6ee5f013932efab906f00f723694b004e585f6b285db6ffadd2f1c1c935ba4d2a0eaff78fbf434ef52604
-  data.tar.gz: 21f44b53b79331912008bec96ac4c27b3903d16d21f79ae22ee4259ae8a8ba25fa16d79b5d4724ac9be2818097743ccc9abb65a209a344b502c32747626ef019
+  metadata.gz: b083ddc6806fd2cd94c25870aa8318cced2cb62d8f8cf0fbfdf09196812221a84904b97813dd533f965a9afb1233632c18dd57c25c4a545b260a8b928c0f7278
+  data.tar.gz: 6c2af8d7dacd031777e4f75c993842cb94d5c51f1bf96190a9c7bd88de342e8bbdad417da9fb74fa28646edfa88432ef53f71acba9762f8f7c90a96bdbd54f90

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.2] - 2024-10-11
+- [#16](https://github.com/tongueroo/puma-cloudwatch/pull/16) feat: permit multiple metric dimensions
+
+## [0.5.1] - 2023-11-13
+- [#13](https://github.com/tongueroo/puma-cloudwatch/pull/13) delay error messages until first successful fetch
+
 ## [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

data/README.md

@@ -14,6 +14,10 @@ It also strongly encourage to set the `PUMA_CLOUDWATCH_DIMENSION_VALUE` env vari
 
     PUMA_CLOUDWATCH_DIMENSION_VALUE=demo-web-puma
 
+Or if you need to set multiple dimensions, you could use something like:
+
+    PUMA_CLOUDWATCH_DIMENSIONS="Service=web,Cluster=primary,Environment=production"
+
 Then you can get metrics for your `demo-web-puma` app. List of metrics:
 
 * pool_capacity: the number of requests that the server is capable of taking right now.
@@ -34,6 +38,7 @@ Env Var | Description | Default Value
 PUMA\_CLOUDWATCH\_DEBUG | When set, the plugin prints out the metrics that get sent to CloudWatch. | (unset)
 PUMA\_CLOUDWATCH\_DIMENSION\_NAME | CloudWatch metric dimension name | App
 PUMA\_CLOUDWATCH\_DIMENSION\_VALUE | CloudWatch metric dimension value | puma
+PUMA\_CLOUDWATCH\_DIMENSIONS | CloudWatch metric dimensions | (unset)
 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

data/lib/puma_cloudwatch/metrics/looper.rb

@@ -10,6 +10,7 @@ class PumaCloudwatch::Metrics
       @control_auth_token = options[:control_auth_token]
       @frequency = Integer(ENV['PUMA_CLOUDWATCH_FREQUENCY'] || 60)
       @enabled = ENV['PUMA_CLOUDWATCH_ENABLED'] || false
+      @fetched = false
     end
 
     def run
@@ -34,11 +35,17 @@ class PumaCloudwatch::Metrics
       loop do
         begin
           stats = Fetcher.new(@options).call
+          @fetched = true
           results = Parser.new(stats).call
           Sender.new(results).call unless results.empty?
           sleep @frequency
         rescue Exception => e
-          puts "Error reached top of looper: #{e.message} (#{e.class})"
+          if @fetched
+            puts "Error reached top of looper: #{e.message} (#{e.class})"
+          else
+            # sleep and don't error until we've successfully fetched
+            sleep @frequency
+          end
         end
       end
     end

data/lib/puma_cloudwatch/metrics/sender.rb

@@ -14,8 +14,7 @@ class PumaCloudwatch::Metrics
     def initialize(metrics)
       @metrics = metrics
       @namespace = ENV['PUMA_CLOUDWATCH_NAMESPACE'] || "WebServer"
-      @dimension_name = ENV['PUMA_CLOUDWATCH_DIMENSION_NAME'] || "App"
-      @dimension_value = ENV['PUMA_CLOUDWATCH_DIMENSION_VALUE'] || "puma"
+      @dimensions = calculate_dimensions
       @frequency = Integer(ENV['PUMA_CLOUDWATCH_FREQUENCY'] || 60)
       @enabled = ENV['PUMA_CLOUDWATCH_ENABLED'] || false
       @region = ENV['PUMA_CLOUDWATCH_AWS_REGION']
@@ -23,6 +22,27 @@ class PumaCloudwatch::Metrics
       @secret_access_key = ENV['PUMA_CLOUDWATCH_AWS_SECRET_ACCESS_KEY']
     end
 
+    def calculate_dimensions
+      if ENV.key?('PUMA_CLOUDWATCH_DIMENSIONS')
+        ENV['PUMA_CLOUDWATCH_DIMENSIONS'].split(',').map(&:strip).map do |dimension|
+          name, value = dimension.split('=').map(&:strip)
+
+          {
+            name: name,
+            value: value,
+          }
+        end
+      else
+        name = ENV['PUMA_CLOUDWATCH_DIMENSION_NAME'] || "App"
+        value = ENV['PUMA_CLOUDWATCH_DIMENSION_VALUE'] || "puma"
+
+        [
+          name: name,
+          value: value
+        ]
+      end
+    end
+
     def call
       put_metric_data(
         namespace: @namespace,
@@ -58,7 +78,7 @@ class PumaCloudwatch::Metrics
         metric.each do |name, values|
           data << {
             metric_name: name.to_s,
-            dimensions: dimensions,
+            dimensions: @dimensions,
             storage_resolution: @frequency < 60 ? 1 : 60,
             statistic_values: {
               sample_count: values.length,
@@ -72,13 +92,6 @@ class PumaCloudwatch::Metrics
       data
     end
 
-    def dimensions
-      [
-        name: @dimension_name,
-        value: @dimension_value
-      ]
-    end
-
   private
     def put_metric_data(params)
       if ENV['PUMA_CLOUDWATCH_DEBUG']

data/lib/puma_cloudwatch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatch
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.10
 signing_key: 
 specification_version: 4
 summary: Puma plugin sends puma stats to CloudWatch