cloudwatch-metrics 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f81642066454cacb68f5e5d76f7cee30aae9cb09d9db2dd9a1026a102c974f3f
-  data.tar.gz: 33ad13c41b6caa0fb8da1a538ca11cc2a11a688f012daee58ba39eeb82e6c441
+  metadata.gz: 1dff409be424bcafe2081ebe6583808b9577f957db434dcf6d0101f4e61c8eb9
+  data.tar.gz: bc45bed975955dc25846b8a427f8ed28b62f26f4910a8fef8262374ccd21eede
 SHA512:
-  metadata.gz: d676d266e1d6bb2f9468b2fd6b9bf3b348cec4a59bcea379201b68762487849de78fdab7acdde876a0b7df1aa57440938e8657bb0f3d0870cf64a983d4c7263d
-  data.tar.gz: 56e203e9bdad56fe89626309ec86ee2bfcae8879a262471034b9ebaad0c4e6093f5d7b96767108d91468a28dbee7db4db0f6bd7e4202eb26adaebd96ccf736d0
+  metadata.gz: c63953bc1565b6aa922d8521067193d25c680667a09a1361dd5ef8dfaacdbbf31acf50ea0b11f552355372146a27dad2df59b6314f3cb70d330e538c084c8740
+  data.tar.gz: 4c93c5b6b9a38d6a570e86c271d0855bea2321b6c3474a9231119bfa3798a6e8af3a4158604738fc6e0cfc7c6cf681c1bdcd26ab7fe62494def64beeb639eea0

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.
@@ -57,6 +56,10 @@ Both reporting methods accept optional parameters, which are detailed below, alo
 * `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`.
 * `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.
 
+### 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 +71,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/configuration.rb

@@ -3,10 +3,18 @@
 module CloudwatchMetrics
   class Configuration
     attr_accessor :namespace, :region
-    attr_writer :no_cw_alias
+    attr_writer :no_cw_alias, :publish_environments, :logger
 
     def no_cw_alias
       @no_cw_alias ||= false
     end
+
+    def publish_environments
+      @publish_environments ||= %w[production]
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
   end
 end

data/lib/cloudwatch_metrics/version.rb

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

data/lib/cloudwatch_metrics.rb

@@ -44,15 +44,31 @@ module CloudwatchMetrics
 
     private
 
+    def put_data(namespace:, 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
-      @cloudwatch_client ||= Aws::CloudWatch::Client.new(region: configuration.region)
+      return @cloudwatch_client unless @cloudwatch_client.nil?
+
+      @cloudwatch_client = if !configuration.region.nil?
+                             Aws::CloudWatch::Client.new(region: configuration.region)
+                           else
+                             Aws::CloudWatch::Client.new
+                           end
     end
 
-    def put_data(namespace:, metric_data:)
-      resp = cloudwatch_client.put_metric_data({
-        namespace: namespace,
-        metric_data: metric_data
-      })
+    def environment
+      ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
     end
   end
 end

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

@@ -16,4 +16,15 @@ CloudwatchMetrics.configure do |config|
   # 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.
   # 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]
+
+  # This is an optional configuration to set the logger that
+  # the metrics will be logged to. Defaults to `Logger.new(STDOUT)`.
+  # For rails applications you can set this to `Rails.logger`.
+  # config.logger = Rails.logger
 end

metadata

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