cloudwatch-metrics 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e76f596fe51773a068e074190d2b73a050772e565f57a9728d7e05e8d0dc426
-  data.tar.gz: 1be98427ad0a9f15b9090bf0275d53d929d47d461c873fe574960895a3d47fb1
+  metadata.gz: aae5940338cdbe6a8908f6330531daa21de3bebe3c63a84e5c8c30fbace3413e
+  data.tar.gz: 15cf0039191265a80066547276459f60f584bfd70924574b0719d65838b13bc3
 SHA512:
-  metadata.gz: 33bcd4130b0fc125d24fae7827ffa16005d2b43217e457a817ac419f4560885d9a7410249e22a8aca85ab8358e3e012a2a9d86d38f58c8ace23265449db76fa5
-  data.tar.gz: 1bd146a97750aa9be1b00f10491087a5b69933eda91f97821a467bcd2caf5415971641707bab97a9874843219ed9ddc51a6fefc0a3edce75f6754fab02667d7e
+  metadata.gz: 7c0a974cd1dd8a00473fabefa3be9721f0ce08ca832791c0e7fc764baf3d3111177d64583e30e822473392f746e5afb52a2908586d8ee87b39238283d9509556
+  data.tar.gz: 021f06249687423051df6bc8f0adf113be020666fa0b3184b16e36bb4c174d1333c4eb90043e2b9318b626f994b4fcb75a8514ec0715c439466ea18078fe99b6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudwatch-metrics (1.0.0)
+    cloudwatch-metrics (1.1.1)
       activesupport (~> 7.0)
       aws-sdk-cloudwatch (~> 1.73)
       rake (~> 13.0)
@@ -16,7 +16,7 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.780.0)
+    aws-partitions (1.781.0)
     aws-sdk-cloudwatch (1.75.0)
       aws-sdk-core (~> 3, >= 3.174.0)
       aws-sigv4 (~> 1.1)

data/lib/cloudwatch_metrics/configuration.rb

@@ -2,8 +2,8 @@
 
 module CloudwatchMetrics
   class Configuration
-    attr_accessor :namespace, :region, :environment
-    attr_writer :no_cw_alias, :publish_environments, :logger
+    attr_accessor :namespace, :region, :environment, :error_handler, :default_dimensions
+    attr_writer :no_cw_alias, :publish_environments, :logger, :non_production_prefix
 
     def no_cw_alias
       @no_cw_alias ||= false
@@ -16,5 +16,9 @@ module CloudwatchMetrics
     def logger
       @logger ||= Logger.new($stdout)
     end
+
+    def non_production_prefix
+      @non_production_prefix ||= 'test-'
+    end
   end
 end

data/lib/cloudwatch_metrics/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloudwatchMetrics
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

data/lib/cloudwatch_metrics.rb

@@ -35,7 +35,7 @@ module CloudwatchMetrics
     end
 
     def record(
-      name:, value:, unit: nil, namespace: configuration.namespace, dimensions: nil, timestamp: nil
+      name:, value:, unit: nil, namespace: nil, dimensions: nil, timestamp: nil
     )
       metric_data = [{
         metric_name: name,
@@ -44,11 +44,13 @@ module CloudwatchMetrics
         dimensions: map_dimensions(dimensions),
         timestamp: timestamp
       }]
-      put_data(namespace: namespace, metric_data: metric_data)
+      put_data(namespace: full_namespace(namespace), metric_data: metric_data)
+    rescue StandardError => e
+      handle_error(e)
     end
 
     def record_all(
-      name:, values:, counts:, unit: nil, namespace: configuration.namespace, dimensions: nil, timestamp: nil
+      name:, values:, counts:, unit: nil, namespace: nil, dimensions: nil, timestamp: nil
     )
       metric_data = [{
         metric_name: name,
@@ -58,7 +60,9 @@ module CloudwatchMetrics
         dimensions: map_dimensions(dimensions),
         timestamp: timestamp
       }]
-      put_data(namespace: namespace, metric_data: metric_data)
+      put_data(namespace: full_namespace(namespace), metric_data: metric_data)
+    rescue StandardError => e
+      handle_error(e)
     end
 
     private
@@ -71,9 +75,6 @@ module CloudwatchMetrics
       end
 
       nil
-    rescue StandardError => e
-      configuration.logger.error("CloudwatchMetrics error: #{e.message}")
-      raise CloudwatchMetrics::Error, e.message
     end
 
     def cloudwatch_client
@@ -92,17 +93,38 @@ module CloudwatchMetrics
 
     # convert key/value hash to format expected by AWS SDK
     def map_dimensions(dimensions)
-      return [] if dimensions.nil?
+      combined_dimensions = (configuration.default_dimensions || {}).merge(dimensions || {})
 
       mapped_values = []
-      dimensions.keys.each do |key|
+      combined_dimensions.keys.each do |key|
         mapped_values << {
           name: key.to_s,
-          value: dimensions[key]
+          value: combined_dimensions[key]
         }
       end
 
       mapped_values
     end
+
+    def handle_error(error)
+      if !configuration.error_handler.nil?
+        configuration.error_handler.call(error)
+        return
+      end
+
+      configuration.logger.error("CloudwatchMetrics error: #{error.message}")
+      raise CloudwatchMetrics::Error, error.message
+    end
+
+    def full_namespace(provided_namespace)
+      constructed_namespace = provided_namespace || configuration.namespace
+      raise CloudwatchMetrics::Error, 'Namespace must be provided' if constructed_namespace.blank?
+
+      if environment != 'production' && configuration.non_production_prefix.present?
+        constructed_namespace = configuration.non_production_prefix + constructed_namespace
+      end
+
+      constructed_namespace
+    end
   end
 end

data/lib/generators/cloudwatch_metrics/templates/cloudwatch_metrics.rb

@@ -32,4 +32,21 @@ CloudwatchMetrics.configure do |config|
   # This is useful if the gem is being used in a non-rails application.
   # Defaults to ENV['RAILS_ENV'] if present or 'development'` otherwise.
   # config.environment = 'production'
+
+  # This is an optional configuration to set the namespace prefix for non-production
+  # environments. This is useful if you want to avoid polluting your production
+  # metrics with test data. If empty or nil no prefix will be applied. Defaults to 'test-'.
+  # config.non_production_prefix = 'test-'
+
+  # This is an optional configuration to set an error handler proc.
+  # If not set the default error handler will log the error
+  # and raise a CloudwatchMetrics::Error
+  # config.error_handler = proc do |exception|
+  #   Rails.logger.error(exception)
+  #   Sentry.capture_exception(exception)
+  # end
+
+  # This is an optional configuration to set default dimensions for all metrics.
+  # Dimensions passed to the `record` or `record_all` methods will be merged with these.
+  # config.default_dimensions = {name: 'value'}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudwatch-metrics
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Seth Puckett
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-16 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport