cloudwatch-metrics 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dff409be424bcafe2081ebe6583808b9577f957db434dcf6d0101f4e61c8eb9
-  data.tar.gz: bc45bed975955dc25846b8a427f8ed28b62f26f4910a8fef8262374ccd21eede
+  metadata.gz: dfe7fbdd2e3121c9144df74e1e620277b0d9c1d019eefcbc62592e979d575cf2
+  data.tar.gz: e4c052ef871bd758454ebbd52d931eb2af554c0cf3e13ca2aad612cf533c39e4
 SHA512:
-  metadata.gz: c63953bc1565b6aa922d8521067193d25c680667a09a1361dd5ef8dfaacdbbf31acf50ea0b11f552355372146a27dad2df59b6314f3cb70d330e538c084c8740
-  data.tar.gz: 4c93c5b6b9a38d6a570e86c271d0855bea2321b6c3474a9231119bfa3798a6e8af3a4158604738fc6e0cfc7c6cf681c1bdcd26ab7fe62494def64beeb639eea0
+  metadata.gz: 4ac092df3e27dc27438a72d8e1962fd35a5ea623074c0853f29874c31f90518090555389a9e4d63e8ea88491b40643e2f80d8e531ce9d66b8438ce0826cf90d2
+  data.tar.gz: 8fe6aa51871bef6c68df7d00c22a421834a057c722c819fb7efd58a588f3a8bc03710fb22a445906a01b16d5e7aa61edb84f647100b73aeb8415eab9c11fc220

data/README.md

@@ -31,21 +31,21 @@ Metrics are reported using `CW.report` for single data points, or `CW.report_all
 
 ### CW.report Required Parameters
 
-* `metric_name`: The name of the metric.
+* `name`: The name of the metric.
 * `value`: The value for the single data point being reported.
 
-E.g. `CW.report(metric_name: 'search_result_count', value: 25)`
+E.g. `CW.report(name: 'search_result_count', value: 25)`
 
 
 `CW.report_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.report_all Required Parameters
 
-* `metric_name`: The name of the metric.
+* `name`: The name of the metric.
 * `values`: Array of values for the data points being reported.
 * `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.report_all(metric_name: 'search_result_count', values: [25, 50, 65], counts: [1, 2, 1])`
+E.g. `CW.report_all(name: 'search_result_count', values: [25, 50, 65], counts: [1, 2, 1])`
 
 ### Optional Parameters
 
@@ -53,9 +53,11 @@ Both reporting methods accept optional parameters, which are detailed below, alo
 
 * `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`: An array of name/value pairs that form part of the identity of a metric. Dimensions allow you to group and filter data points within a particular metric. 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 within 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.report(name: 'search_result_count', value: 25, unit: CW.COUNT, namespace: 'custom_namespace', dimensions: { group: 'A', subgroup: 'B' }, timeStamp: Time.current - 1.day)`
+
 ### Local development
 
 By default, `CloudWatchMetrics` only publishes to Cloudwatch in the production environment. In other environments it will write to the configured logger. These settings can be changed in the initializer.

data/lib/cloudwatch_metrics/version.rb

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

data/lib/cloudwatch_metrics.rb

@@ -16,27 +16,27 @@ module CloudwatchMetrics
     end
 
     def record(
-      metric_name:, value:, unit: nil, namespace: configuration.namespace, dimensions: [], timestamp: nil
+      name:, value:, unit: nil, namespace: configuration.namespace, dimensions: [], timestamp: nil
     )
       metric_data = [{
-        metric_name: metric_name,
+        metric_name: name,
         value: value,
         unit: unit,
-        dimensions: dimensions,
+        dimensions: map_dimensions(dimensions),
         timestamp: timestamp
       }]
       put_data(namespace: namespace, metric_data: metric_data)
     end
 
     def record_all(
-      metric_name:, values:, counts:, unit: nil, namespace: configuration.namespace, dimensions: [], timestamp: nil
+      name:, values:, counts:, unit: nil, namespace: configuration.namespace, dimensions: [], timestamp: nil
     )
       metric_data = [{
-        metric_name: metric_name,
+        metric_name: name,
         values: values,
         counts: counts,
         unit: unit,
-        dimensions: dimensions,
+        dimensions: map_dimensions(dimensions),
         timestamp: timestamp
       }]
       put_data(namespace: namespace, metric_data: metric_data)
@@ -70,6 +70,21 @@ module CloudwatchMetrics
     def environment
       ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
     end
+
+    # convert key/value hash to format expected by AWS SDK
+    def map_dimensions(dimensions)
+      return [] if dimensions.nil?
+
+      mapped_values = []
+      dimensions.keys.each do |key|
+        mapped_values << {
+          name: key,
+          value: dimensions[key]
+        }
+      end
+
+      mapped_values
+    end
   end
 end
 

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

@@ -14,14 +14,14 @@ CloudwatchMetrics.configure do |config|
 
   # This is an optional configuration to set the region that
   # the metrics will be published to. This is useful if you want to publish
-  # to a region other than the default region for your AWS credentials.
+  # to a region other than the default region for your AWS configuration.
   # config.region = 'us-east-1'
 
   # By default metrics will only be published in the production environment.
   # In all other environments metrics will be logged.
   # You can override this behavior by specifying an array of environments
   # that you want to publish metrics in.
-  # config.publish_environments = %w[production staging]
+  # config.publish_environments = %w[production development]
 
   # This is an optional configuration to set the logger that
   # the metrics will be logged to. Defaults to `Logger.new(STDOUT)`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudwatch-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors:
 - Seth Puckett