Merge pull request #8 from lessonnine/fix-io-target-for-cloudwatch

Fix io target for cloudwatch

Author: Leszek Zalewski

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.1] - 2021-03-26
+### Changed
+- IO target replaces dots in telemetry keys with dashes for better integration with AWS CloudWatch
+
 ## [0.3.0] - 2020-12-21
 ### Added
 - Datadog Target integration tests

Gemfile.lock

@@ -1,57 +1,57 @@
 PATH
   remote: .
   specs:
-    puma-plugin-telemetry (0.3.0)
+    puma-plugin-telemetry (0.3.1)
       puma (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
     diff-lcs (1.4.4)
-    dogstatsd-ruby (4.8.2)
-    nio4r (2.5.4)
+    dogstatsd-ruby (4.8.3)
+    nio4r (2.5.7)
     parallel (1.20.1)
-    parser (2.7.2.0)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
-    puma (5.1.1)
+    puma (5.2.2)
       nio4r (~> 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    regexp_parser (2.0.0)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.5.2)
+    rspec-support (3.10.2)
+    rubocop (1.12.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.9.1)
+    rubocop-performance (1.10.2)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.0.1)
+    rubocop-rspec (2.2.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby

lib/puma/plugin/telemetry/targets/io_target.rb

@@ -12,8 +12,15 @@ class IOTarget
           # JSON formatter for IO, expects `call` method accepting telemetry hash
           #
           class JSONFormatter
+            # NOTE: Replace dots with dashes for better support of AWS CloudWatch
+            #       Log Metric filters, as they don't support dots in key names.
             def self.call(telemetry)
-              ::JSON.dump(telemetry.merge(name: "Puma::Plugin::Telemetry", message: "Publish telemetry"))
+              log = telemetry.transform_keys { |k| k.tr(".", "-") }
+
+              log["name"] = "Puma::Plugin::Telemetry"
+              log["message"] = "Publish telemetry"
+
+              ::JSON.dump(log)
             end
           end
 

lib/puma/plugin/telemetry/version.rb

@@ -3,7 +3,7 @@
 module Puma
   class Plugin
     module Telemetry
-      VERSION = "0.3.0"
+      VERSION = "0.3.1"
     end
   end
 end

spec/integration/plugin_spec.rb

@@ -62,7 +62,7 @@ class Plugin
       context "when subset of telemetry" do
         let(:config) { "puma_telemetry_subset" }
         let(:expected_telemetry) do
-          "{\"queue.backlog\":0,\"workers.spawned_threads\":2,\"workers.max_threads\":4,\"name\":\"Puma::Plugin::Telemetry\",\"message\":\"Publish telemetry\"}\n" # rubocop:disable Layout/LineLength
+          "{\"queue-backlog\":0,\"workers-spawned_threads\":2,\"workers-max_threads\":4,\"name\":\"Puma::Plugin::Telemetry\",\"message\":\"Publish telemetry\"}\n" # rubocop:disable Layout/LineLength
         end
 
         it "logs only selected telemetry" do