cloudwatch-metrics 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fea54b365db5f46b021de9a93dbe005d8c48a16a1022ad2f8ab8dc0aeb09a6d
-  data.tar.gz: 597a6420648417aa1a48184211bf034846e12700a7a2a0f0501d7766736f8a19
+  metadata.gz: 97790dd4bec2f067aeca87ba8aabaa580fbb98f793125258d4bdb53fea42da5d
+  data.tar.gz: 6ea60c0395cd756541de4c87bf81b74fd06f26f467be9bdd21d3cb2fb52381cd
 SHA512:
-  metadata.gz: 82270ea0dac105c309e03a3574e4a81774910ecee57f65f03068938e53dd5c693c3883851f40504b952053182c0d18deecba903924eca11eeeb8e648f64fc894
-  data.tar.gz: 40f2f31599f3a4882df334b176f5d78657a047344a04ef3bc994006fabc556e05258829def820ceb6e78a802ea066a14252a83c683e13e506c4a6f7d4fea1732
+  metadata.gz: 8767e36b91438b6178ebe96cac9a1a712629279afa37b20dd4624ae46319d6279544b3d63dc537fdf44272d286c790f9eb6f40b31e013391ace747e96b7c86bf
+  data.tar.gz: 16fb72d30d8f932f17e47281eee1c23d234a93fb222426c3b7423b9fb4fb30bff8746f366c619b7ac1d1a4f07e551684dfc05c1eea4d30864e04cdad0fdf3d71

data/README.md

@@ -23,7 +23,6 @@ The initializer contains descriptions for all available options. The only option
 
 * **namespace**: This is the default namespace that all metrics will be published to. This should probably match the name of your application or service.
 
-
 ## Usage
 
 Available methods are in the `CloudwatchMetrics` module. For convenience this is aliased to `CW` by default.
@@ -54,9 +53,15 @@ 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(metric_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.
+
 ### AWS Credentials
 
 See [HOWTO Assume AWS role](https://docs.google.com/document/d/1NCXtlhddpJCttBPs2V4mv3J59V0C3ShTzaoSidBAVTU/edit#heading=h.kr4pxvf3gqqt) for info about setting up AWS credential locally. You can read more about AWS SDK configuration in the [AWS docs](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -68,6 +73,13 @@ aws_access_key_id = $AWS_ACCESS_KEY_ID
 aws_secret_access_key = $AWS_SECRET_ACCESS_KEY
 ```
 
+You'll also want an `~/.aws/config` file to set the default region
+```
+[default]
+region = us-west-2
+output = json
+```
+
 ## Cloudwatch Concepts
 
 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.

data/lib/cloudwatch_metrics/version.rb

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

data/lib/cloudwatch_metrics.rb

@@ -22,7 +22,7 @@ module CloudwatchMetrics
         metric_name: metric_name,
         value: value,
         unit: unit,
-        dimensions: dimensions,
+        dimensions: map_dimensions(dimensions),
         timestamp: timestamp
       }]
       put_data(namespace: namespace, metric_data: metric_data)
@@ -36,7 +36,7 @@ module CloudwatchMetrics
         values: values,
         counts: counts,
         unit: unit,
-        dimensions: dimensions,
+        dimensions: map_dimensions(dimensions),
         timestamp: timestamp
       }]
       put_data(namespace: namespace, metric_data: metric_data)
@@ -45,10 +45,16 @@ module CloudwatchMetrics
     private
 
     def put_data(namespace:, metric_data:)
-      resp = cloudwatch_client.put_metric_data({
-        namespace: namespace,
-        metric_data: metric_data
-      })
+      if configuration.publish_environments.include?(environment)
+        cloudwatch_client.put_metric_data({namespace: namespace, metric_data: metric_data})
+      else
+        configuration.logger.info("CloudwatchMetrics (#{namespace}): #{metric_data}")
+      end
+
+      nil
+    rescue StandardError => e
+      configuration.logger.error("CloudwatchMetrics error: #{e.message}")
+      raise CloudwatchMetrics::Error, e.message
     end
 
     def cloudwatch_client
@@ -64,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.14
+  version: 0.1.16
 platform: ruby
 authors:
 - Seth Puckett