cloudwatch-metrics 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acc825c244c5b16fcd792fb39fe89785710cdcc5aa08c43cf082cda2200fada4
-  data.tar.gz: eef5bd9df19b6d13dcf8a2ec4d0b0dcbc1fab97d4822854408031aac0cb9e01b
+  metadata.gz: 4fea54b365db5f46b021de9a93dbe005d8c48a16a1022ad2f8ab8dc0aeb09a6d
+  data.tar.gz: 597a6420648417aa1a48184211bf034846e12700a7a2a0f0501d7766736f8a19
 SHA512:
-  metadata.gz: 2bd61f9092d0619f54c5f47056372511e0735ad75b0ce936ed9b4393d2d636734d10a95a5d1774111aa1efb60029c950d0982b43e72a5d0fa2e4da9c41645510
-  data.tar.gz: e92a0955168e84c4d5eb6cc3c586b647ef0acdf5c99457ada45312cad53ab088be05115e372bdd8e09cc178562f0194b495c7e1d8019d98edcb5b5b86a0f7a00
+  metadata.gz: 82270ea0dac105c309e03a3574e4a81774910ecee57f65f03068938e53dd5c693c3883851f40504b952053182c0d18deecba903924eca11eeeb8e648f64fc894
+  data.tar.gz: 40f2f31599f3a4882df334b176f5d78657a047344a04ef3bc994006fabc556e05258829def820ceb6e78a802ea066a14252a83c683e13e506c4a6f7d4fea1732

data/README.md

@@ -57,6 +57,17 @@ 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.
 
+### 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).
+
+The short version: Create a file `~/.aws/config` and add your access keys there:
+```
+[default]
+aws_access_key_id = $AWS_ACCESS_KEY_ID
+aws_secret_access_key = $AWS_SECRET_ACCESS_KEY
+```
+
 ## 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.12'
+  VERSION = '0.1.14'
 end

data/lib/cloudwatch_metrics.rb

@@ -7,6 +7,10 @@ module CloudwatchMetrics
   class Error < StandardError; end
 
   class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
     def configure
       yield(configuration)
     end
@@ -40,20 +44,26 @@ module CloudwatchMetrics
 
     private
 
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def cloudwatch_client
-      @cloudwatch_client ||= Aws::CloudWatch::Client.new(region: configuration.region)
-    end
-
     def put_data(namespace:, metric_data:)
       resp = cloudwatch_client.put_metric_data({
         namespace: namespace,
         metric_data: metric_data
       })
     end
+
+    def cloudwatch_client
+      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 environment
+      ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+    end
   end
 end
 

data/lib/generators/cloudwatch_metrics/initializer_generator.rb

@@ -6,7 +6,7 @@ module CloudwatchMetrics
       source_root File.expand_path('templates', __dir__)
 
       def copy_initializer_file
-        copy_file "cloudwatch_metrics.rb", "config/initializers/cloudwatch_metrics.rb"
+        copy_file 'cloudwatch_metrics.rb', 'config/initializers/cloudwatch_metrics.rb'
       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.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Seth Puckett