cloudwatch-metrics 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aae5940338cdbe6a8908f6330531daa21de3bebe3c63a84e5c8c30fbace3413e
-  data.tar.gz: 15cf0039191265a80066547276459f60f584bfd70924574b0719d65838b13bc3
+  metadata.gz: 9f09863337a7fd11e3f2f549b23b27c574a008662ecf66283ffd614e82a95922
+  data.tar.gz: 72362a407b63b87d9bb68e971bcf7f02340197d8c77648aae459d4f7c9274508
 SHA512:
-  metadata.gz: 7c0a974cd1dd8a00473fabefa3be9721f0ce08ca832791c0e7fc764baf3d3111177d64583e30e822473392f746e5afb52a2908586d8ee87b39238283d9509556
-  data.tar.gz: 021f06249687423051df6bc8f0adf113be020666fa0b3184b16e36bb4c174d1333c4eb90043e2b9318b626f994b4fcb75a8514ec0715c439466ea18078fe99b6
+  metadata.gz: '08739f23905390ab206b19ca7e29ab1284ba4b4f060834bf6c1335123ba9ed5475f77c0c82d1e347630b833eac1961dfbf5a18f5a6b8a72929de83064534ce12'
+  data.tar.gz: f3792f4d86690627807c906007fed115dc595b63decda1ffffcdf0be8a5f1651baf27363ccf50188f5f21ce2faff489263d59699ed98eb2a97caf745c43938ca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudwatch-metrics (1.1.1)
+    cloudwatch-metrics (1.1.3)
       activesupport (~> 7.0)
       aws-sdk-cloudwatch (~> 1.73)
       rake (~> 13.0)
@@ -16,16 +16,16 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.781.0)
-    aws-sdk-cloudwatch (1.75.0)
-      aws-sdk-core (~> 3, >= 3.174.0)
+    aws-partitions (1.788.0)
+    aws-sdk-cloudwatch (1.78.0)
+      aws-sdk-core (~> 3, >= 3.177.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.175.0)
+    aws-sdk-core (3.178.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.651.0)
       aws-sigv4 (~> 1.5)
       jmespath (~> 1, >= 1.6.1)
-    aws-sigv4 (1.5.2)
+    aws-sigv4 (1.6.0)
       aws-eventstream (~> 1, >= 1.0.2)
     concurrent-ruby (1.2.2)
     debug (1.8.0)

data/README.md

@@ -19,46 +19,11 @@ To create the initializer:
 rails generate cloudwatch_metrics:initializer
 ```
 
-The initializer contains descriptions for all available options. The only options you must provide a value for are listed below:
-
-* **namespace**: This is the default namespace that all metrics will be published to. This should probably match the name of your application or service.
+The initializer contains descriptions for all available options. More detailed descriptions are available in the user guide, linked below. The only option you must provide a value for is `namespace`.
 
 ## Usage
 
-Available methods are in the `CloudwatchMetrics` module. For convenience this is aliased to `CW` by default. I.e `CloudwatchMetrics.record(...)` is equivalent to `CW.record(...)`.
-
-Metrics are recorded using `CW.record` for single data points, or `CW.record_all` for collections of data points. Required and optional parameters for these methods are detailed below.
-
-### CW.record Required Parameters
-
-* `name`: The name of the metric.
-* `value`: The value for the single data point being recorded.
-
-E.g. `CW.record(name: 'search_result_count', value: 25)`
-
-
-`CW.record_all` has a similar method signature, but takes an array of values, and a corresponding array indicating how many times each value occurred during the period.
-
-### CW.record_all Required Parameters
-
-* `name`: The name of the metric.
-* `values`: Array of values for the data points being recorded.
-* `counts`: Array of numbers indicating the number of times each value occurred during the period. The length of this array should match the length of the `values` array.
-
-E.g. `CW.record_all(name: 'search_result_count', values: [25, 50, 65], counts: [1, 2, 1])`
-
-This means that for the `search_result_count` metric we had one search with 25 results, two searches with 50 results, and one search with 65 results.
-
-### Optional Parameters
-
-Both recording methods accept optional parameters, which are detailed below, along with their default values
-
-* `unit`: The unit of measure for this data point. Units help provide conceptual meaning to your data, but CloudWatch attaches no significance to a unit internally. Common values are `Seconds`, `Kilobytes`, `Percent`, `Count`, `Kilobytes/Second`. Default value is `None`. A full list of available units is available at `CloudwatchMetrics::Units`.
-* `namespace`: Override the namespace set in the initializer. Default is `nil`.
-* `dimensions`: A hash of name/value pairs that form part of the identity of a metric. Dimensions allow you to group and filter data points for a particular metric. Default is `nil`.
-* `timestamp`: The time associated with the data point. The timestamp can be up to two weeks in the past and up to two hours into the future. Default is the current time.
-
-E.g. `CW.record(name: 'search_result_count', value: 25, unit: CW::COUNT, namespace: 'custom_namespace', dimensions: { group: 'A', subgroup: 'B' }, timestamp: Time.current - 1.day)`
+See [How To: Publish Custom Metrics to CloudWatch](https://www.notion.so/pathccm/How-To-Publish-Custom-Metrics-to-CloudWatch-821be6ddec404b3b827c146a2f5de792#74c9ec588d5841f5bad58b59853054b9) for the user guide.
 
 ### Local development
 
@@ -82,11 +47,14 @@ region = us-west-2
 output = json
 ```
 
-## Cloudwatch Concepts
+## Changing this gem
+
+### Development
 
-Refer to the [Cloudwatch Documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) for a general overview of custom metrics in CloudWatch.
+Run `bundle install` to update gemlock file
+Run `rake` to run tests
 
-## Changing this gem
+### Deploy new gem
 
 If you make changes to this gem you need to do a few things to make those updates available to clients.
 

data/lib/cloudwatch_metrics/configuration.rb

@@ -18,7 +18,7 @@ module CloudwatchMetrics
     end
 
     def non_production_prefix
-      @non_production_prefix ||= 'test-'
+      @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.1.1'
+  VERSION = '1.1.3'
 end

data/lib/cloudwatch_metrics.rb

@@ -92,20 +92,19 @@ module CloudwatchMetrics
     end
 
     # convert key/value hash to format expected by AWS SDK
+    # ignore any keys with blank values
     def map_dimensions(dimensions)
       combined_dimensions = (configuration.default_dimensions || {}).merge(dimensions || {})
 
       mapped_values = []
       combined_dimensions.keys.each do |key|
-        mapped_values << {
-          name: key.to_s,
-          value: combined_dimensions[key]
-        }
+        mapped_values << {name: key.to_s, value: combined_dimensions[key]} if combined_dimensions[key].present?
       end
 
       mapped_values
     end
 
+    # handle error by calling configured error handler or logging and raising
     def handle_error(error)
       if !configuration.error_handler.nil?
         configuration.error_handler.call(error)
@@ -116,6 +115,7 @@ module CloudwatchMetrics
       raise CloudwatchMetrics::Error, error.message
     end
 
+    # get namespace from configuration or use provided value and apply non-production prefix if applicable
     def full_namespace(provided_namespace)
       constructed_namespace = provided_namespace || configuration.namespace
       raise CloudwatchMetrics::Error, 'Namespace must be provided' if constructed_namespace.blank?

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

@@ -35,8 +35,8 @@ CloudwatchMetrics.configure do |config|
 
   # 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-'
+  # 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

metadata

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