cloudwatch-metrics 0.1.24 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42322dee77d4b10cbb7118d4f76bbe6631c757822bfd920b81603fa26a8b0cf8
-  data.tar.gz: d3536c5c8ad7457b97882a1026bc3a711216539e258b4f7169d7d3844d8dc717
+  metadata.gz: 28559f6e9beaa0232533fc708bc611ce9a36bfb6ceba507750dcb96fa0d7ff58
+  data.tar.gz: 15e3fdcb7cb15b25232b3cebd2e38924f4b3c3478f6e5ff9fca5d94312ea4029
 SHA512:
-  metadata.gz: 5a0ebee838a22456130bb39acf86ab92532cc5fb89803405ba734512ba3bd227ae73d9bfd1cc8a7efaa2d0b687d57c7903b5785f8d564e4ebec7bb26d9ce8904
-  data.tar.gz: bbe37d0490b24e7724b0d114883ac73e707a74e9320f69d4ee6acfbdf7c11f7eb39bfcde88ad57b1d709793ce248235d69b2c9236e432a4ef17f20f11620163e
+  metadata.gz: 9b8adc74f221b238cfe66e5fd9820c0988e5e2adad395ffc9f475fcdcbc8f80ee67592ff54f5fb842ff1c81ff0f199a5ac3b1b82f779dbbe6f29d1be5b90542d
+  data.tar.gz: a8c7c353c71566b128745eb294420dcb3c8dc894eaed53a16acf266f2871fb1eec4cc76d4281bb5c955956ba53ac69a036c67d5bcec8bc5ad3ac8216f5215611

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,354 @@
+inherit_from:
+    - .rubocop_strict.yml
+
+inherit_mode:
+    merge:
+        - Exclude
+
+require:
+    - rubocop-rspec
+    - rubocop-performance
+    - rubocop-rails
+
+## For Reference:
+## Rubocop docs: https://docs.rubocop.org/
+## Ruby Style Guide: https://rubystyle.guide/
+## Rails Style Guide: https://rails.rubystyle.guide/
+## RSpec Style Guide: https://rspec.rubystyle.guide/
+
+AllCops:
+    TargetRubyVersion: 3.0.3
+    SuggestExtensions: false
+    NewCops: enable
+    Exclude:
+        - bin/**/*
+        - config/**/*
+        - db/seeds/**/*
+        - db/*
+        - node_modules/**/*
+        - vendor/**/*
+        - tmp/**/*
+
+Layout/SpaceInsideHashLiteralBraces:
+    Enabled: true
+    EnforcedStyle: no_space
+    EnforcedStyleForEmptyBraces: no_space
+
+Layout/MultilineMethodCallIndentation:
+    Enabled: true
+    EnforcedStyle: indented
+
+Layout/ArrayAlignment:
+    Enabled: true
+    EnforcedStyle: with_fixed_indentation
+
+Layout/FirstHashElementIndentation:
+    Enabled: true
+    EnforcedStyle: consistent
+
+Style/NegatedIf:
+    Enabled: true
+    EnforcedStyle: postfix
+
+Layout/FirstArgumentIndentation:
+    Enabled: true
+    EnforcedStyle: consistent
+
+Layout/MultilineOperationIndentation:
+    Enabled: true
+    EnforcedStyle: indented
+
+Layout/FirstArrayElementIndentation:
+    Enabled: true
+    EnforcedStyle: consistent
+
+Style/HashSyntax:
+    Enabled: true
+    EnforcedStyle: ruby19_no_mixed_keys
+
+Style/EmptyMethod:
+    Enabled: true
+    EnforcedStyle: expanded
+
+Style/RescueModifier:
+    Enabled: true
+    Exclude:
+        - spec/**/*
+
+Rails/Output:
+    Enabled: true
+    Exclude:
+        - lib/**/*
+        - app/services/tasks/*
+
+Rails/UnknownEnv:
+    Enabled: true
+    Environments:
+        - production
+        - staging
+        - test
+        - development
+
+Metrics/BlockNesting:
+    Enabled: true
+    Max: 3
+
+# Default Max: 10
+Metrics/MethodLength:
+    Max: 20
+    CountAsOne: ['array', 'hash']
+
+Metrics/ModuleLength:
+    Enabled: true
+    Max: 100
+    CountAsOne: ['array', 'hash']
+
+Metrics/PerceivedComplexity:
+    Enabled: true
+    Max: 16
+
+Metrics/ParameterLists:
+    Enabled: true
+    Max: 8
+
+RSpec/ExampleLength:
+    Enabled: true
+    Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+    Enabled: true
+    Max: 20
+
+RSpec/NestedGroups:
+    Enabled: true
+    Max: 4
+
+Rails/Delegate:
+    Enabled: false
+
+Style/Documentation:
+    Enabled: false
+
+# Leave disabled in favor of Perceived/Complexity
+Metrics/AbcSize:
+    Enabled: false
+
+Style/ClassAndModuleChildren:
+    Enabled: false
+
+Style/IfUnlessModifier:
+    Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+    Enabled: false
+
+Style/InverseMethods:
+    Enabled: false
+
+Style/StringConcatenation:
+    Enabled: false
+
+Style/HashEachMethods:
+    Enabled: false
+
+Style/CaseLikeIf:
+    Enabled: false
+
+# Leave disabled in favor of PerceivedComplexity
+Metrics/CyclomaticComplexity:
+    Enabled: false
+
+Style/Next:
+    Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+    Enabled: false
+
+Style/HashAsLastArrayItem:
+    Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+    Enabled: false
+
+Naming/AccessorMethodName:
+    Enabled: false
+
+Style/IfWithBooleanLiteralBranches:
+    Enabled: false
+
+Metrics/BlockLength:
+    Enabled: false
+
+Style/NumericPredicate:
+    Enabled: false
+
+Style/SoleNestedConditional:
+    Enabled: false
+
+Style/GuardClause:
+    Enabled: false
+
+Style/SymbolArray:
+    Enabled: false
+
+Style/WordArray:
+    Enabled: false
+
+Naming/VariableNumber:
+    Enabled: false
+
+Naming/MethodParameterName:
+    Enabled: false
+
+Lint/DuplicateBranch:
+    Enabled: false
+
+Style/MultilineTernaryOperator:
+    Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+    Enabled: false
+
+Style/SymbolProc:
+    Enabled: false
+
+Lint/UselessAccessModifier:
+    Enabled: false
+
+Lint/UselessMethodDefinition:
+    Enabled: false
+
+Lint/EmptyBlock:
+    Enabled: false
+
+Style/CaseEquality:
+    Enabled: false
+
+Style/ExplicitBlockArgument:
+    Enabled: false
+
+Lint/TripleQuotes:
+    Enabled: false
+
+Style/ZeroLengthPredicate:
+    Enabled: false
+
+Style/StringChars:
+    Enabled: false
+
+Performance/RedundantSplitRegexpArgument:
+    Enabled: false
+
+Style/OptionalBooleanParameter:
+    Enabled: false
+
+Style/RedundantArgument:
+    Enabled: false
+
+Style/MutableConstant:
+    Enabled: false
+
+Naming/PredicateName:
+    Enabled: false
+
+Lint/UnusedBlockArgument:
+    Enabled: false
+
+Style/RaiseArgs:
+    Enabled: false
+
+Style/MultilineBlockChain:
+    Enabled: false
+
+Performance/Sum:
+    Enabled: false
+
+Lint/UnexpectedBlockArity:
+    Enabled: false
+
+Lint/SymbolConversion:
+    Enabled: false
+
+Performance/CollectionLiteralInLoop:
+    Enabled: false
+
+Style/FormatString:
+    Enabled: false
+
+Style/FormatStringToken:
+    Enabled: false
+
+Lint/MissingSuper:
+    Enabled: false
+
+Style/NumericLiterals:
+    Enabled: false
+
+Style/RegexpLiteral:
+    Enabled: false
+
+Style/PreferredHashMethods:
+    Enabled: false
+
+Lint/EmptyClass:
+    Enabled: false
+
+Style/WhileUntilModifier:
+    Enabled: false
+
+Lint/DisjunctiveAssignmentInConstructor:
+    Enabled: false
+
+Style/FloatDivision:
+    Enabled: false
+
+Lint/ToJSON:
+    Enabled: false
+
+Performance/Casecmp:
+    Enabled: false
+
+Style/CommentAnnotation:
+    Enabled: false
+
+Lint/EmptyFile:
+    Enabled: false
+
+Style/AccessorGrouping:
+    Enabled: false
+
+Naming/MethodName:
+    Enabled: false
+
+Style/DoubleNegation:
+    Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+    Enabled: false
+
+Performance/TimesMap:
+    Enabled: false
+
+Style/ExpandPathArguments:
+    Enabled: false
+
+Style/Lambda:
+    Enabled: false
+
+Style/RedundantSelfAssignment:
+    Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+    Enabled: false
+
+Style/NegatedIfElseCondition:
+    Enabled: false
+
+Lint/ImplicitStringConcatenation:
+    Enabled: false
+
+Rails/RenderInline:
+    Enabled: false
+
+Rails/LexicallyScopedActionFilter:
+    Enabled: false

data/.rubocop_strict.yml

@@ -0,0 +1,23 @@
+# Inspiration: https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard
+# There are a handful of cops that should be applied to all
+# files always regardless of anything.
+# These are those cops.
+Lint/Debugger: # don't leave binding.pry
+    Enabled: true
+    Exclude: []
+
+RSpec/Focus: # run ALL tests on CI
+    Enabled: true
+    Exclude: []
+
+Rails/Output: # Don't leave puts-debugging
+    Enabled: true
+    Exclude: []
+
+Rails/FindEach: # each could severely affect the performance, use find_each
+    Enabled: true
+    Exclude: []
+
+Rails/UniqBeforePluck: # uniq.pluck and not pluck.uniq
+    Enabled: true
+    Exclude: []

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'debug', '>= 1.0.0'
+  gem 'rspec', '~> 3.11'
+  gem 'rubocop', '~> 1.21', require: false
+  gem 'rubocop-performance', '~> 1.18', require: false
+  gem 'rubocop-rails', '~> 2.19', require: false
+  gem 'rubocop-rspec', '~> 2.22', require: false
+  gem 'simplecov', '~> 0.22', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    cloudwatch-metrics (0.1.25)
+      activesupport (~> 7.0)
+      aws-sdk-cloudwatch (~> 1.73)
+      rake (~> 13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.780.0)
+    aws-sdk-cloudwatch (1.75.0)
+      aws-sdk-core (~> 3, >= 3.174.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.175.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-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.2.2)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.7.0)
+      reline (>= 0.3.0)
+    jmespath (1.6.2)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    reline (0.3.5)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.19.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  cloudwatch-metrics!
+  debug (>= 1.0.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.21)
+  rubocop-performance (~> 1.18)
+  rubocop-rails (~> 2.19)
+  rubocop-rspec (~> 2.22)
+  simplecov (~> 0.22)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -0,0 +1,99 @@
+# CloudwatchMetrics
+
+`CloudwatchMetrics` is a Ruby gem for writing custom metrics to AWS Cloudwatch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'cloudwatch-metrics'
+```
+
+And then execute:
+```
+bundle install
+```
+
+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.
+
+## 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)`
+
+### 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).
+
+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
+```
+
+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.
+
+## Changing this gem
+
+If you make changes to this gem you need to do a few things to make those updates available to clients.
+
+**Prerequisites**: You will need an account on [rubygems.org](https://rubygems.org/) and you will need to be added as an owner of this gem. Talk to Seth for this. ([Managing Owners](https://guides.rubygems.org/managing-owners-using-ui/))
+
+1. Bump the version in `lib/cloudwatch_metrics/version.rb`
+2. Build the updated gem with `gem build cloudwatch_metrics.gemspec`
+3. Push the updated to gem to rubygems with `gem push ./cloudwatch-metrics-[VERSION].gem`
+
+When the change has been published clients can update to the latest version with `bundle update cloudwatch-metrics`.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cloudwatch_metrics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/cloudwatch_metrics/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CloudwatchMetrics
+  class Configuration
+    attr_accessor :namespace, :region, :environment
+    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/constants.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CloudwatchMetrics
+  SECONDS = 'Seconds'
+  MICROSECONDS = 'Microseconds'
+  MILLISECONDS = 'Milliseconds'
+  BYTES = 'Bytes'
+  KILOBYTES = 'Kilobytes'
+  MEGABYTES = 'Megabytes'
+  GIGABYTES = 'Gigabytes'
+  TERABYTES = 'Terabytes'
+  BITS = 'Bits'
+  KILOBITS = 'Kilobits'
+  MEGABITS = 'Megabits'
+  GIGABITS = 'Gigabits'
+  TERABITS = 'Terabits'
+  PERCENT = 'Percent'
+  COUNT = 'Count'
+  BYTES_PER_SECOND = 'Bytes/Second'
+  KILOBYTES_PER_SECOND = 'Kilobytes/Second'
+  MEGABYTES_PER_SECOND = 'Megabytes/Second'
+  GIGABYTES_PER_SECOND = 'Gigabytes/Second'
+  TERABYTES_PER_SECOND = 'Terabytes/Second'
+  BITS_PER_SECOND = 'Bits/Second'
+  KILOBITS_PER_SECOND = 'Kilobits/Second'
+  MEGABITS_PER_SECOND = 'Megabits/Second'
+  GIGABITS_PER_SECOND = 'Gigabits/Second'
+  TERABITS_PER_SECOND = 'Terabits/Second'
+  COUNT_PER_SECOND = 'Count/Second'
+  NONE = 'None'
+
+  UNITS = [
+    SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS,
+    MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND,
+    GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND,
+    GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, NONE
+  ]
+end

data/lib/cloudwatch_metrics/version.rb

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

data/lib/cloudwatch_metrics.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-cloudwatch'
+require 'active_support'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/time'
+require_relative 'cloudwatch_metrics/configuration'
+require_relative 'cloudwatch_metrics/constants'
+
+# Posts custom metrics to AWS CloudWatch
+module CloudwatchMetrics
+  class Error < StandardError; end
+
+  class << self
+    delegate :configuration, :configure, :record, :record_all, to: :instance
+
+    def instance
+      @instance ||= CloudwatchMetrics::Client.new
+    end
+
+    def flush
+      @instance = nil
+    end
+  end
+
+  class Client
+    def configuration
+      @configuration ||= CloudwatchMetrics::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def record(
+      name:, value:, unit: nil, namespace: configuration.namespace, dimensions: nil, timestamp: nil
+    )
+      metric_data = [{
+        metric_name: name,
+        value: value,
+        unit: unit,
+        dimensions: map_dimensions(dimensions),
+        timestamp: timestamp
+      }]
+      put_data(namespace: namespace, metric_data: metric_data)
+    end
+
+    def record_all(
+      name:, values:, counts:, unit: nil, namespace: configuration.namespace, dimensions: nil, timestamp: nil
+    )
+      metric_data = [{
+        metric_name: name,
+        values: values,
+        counts: counts,
+        unit: unit,
+        dimensions: map_dimensions(dimensions),
+        timestamp: timestamp
+      }]
+      put_data(namespace: namespace, metric_data: metric_data)
+    end
+
+    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
+      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
+      configuration.environment || ENV.fetch('RAILS_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.to_s,
+          value: dimensions[key]
+        }
+      end
+
+      mapped_values
+    end
+  end
+end
+
+Object.const_set(:CW, CloudwatchMetrics) unless CloudwatchMetrics.configuration.no_cw_alias

data/lib/generators/cloudwatch_metrics/initializer_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CloudwatchMetrics
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_initializer_file
+        copy_file 'cloudwatch_metrics.rb', 'config/initializers/cloudwatch_metrics.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'cloudwatch_metrics'
+
+CloudwatchMetrics.configure do |config|
+  # This is the default namespace that all metrics will be published to.
+  # This should probably match the name of your application or service.
+  config.namespace = ''
+
+  # This is an optional configuration that will allow you to disable the
+  # `CW` alias. This is useful if you have a constant named `CW` that
+  # conflicts with the alias. Default is `false`.
+  # config.no_cw_alias = true
+
+  # 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 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 development]
+
+  # 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
+
+  # This is an optional configuration to set the running environment.
+  # This is useful if the gem is being used in a non-rails application.
+  # Defaults to ENV['RAILS_ENV'] if present or 'development'` otherwise.
+  # config.environment = 'production'
+end

data/pull_request_template.md

@@ -0,0 +1,65 @@
+## Type of PR
+<!-- Guidance: Each PR should fall into ONE of these categories. If it falls into multiple, please consider breaking up the PR. -->
+
+- [ ] Bug Fix
+- [ ] New Feature
+- [ ] Style Changes/Code Refactor
+- [ ] Data Updates/Migrations
+- [ ] Instrumentation or alerting
+
+## Description
+<!-- Guidance: Please describe what this PR does in such a way that an engineer less familiar with this work could understand it. -->
+
+## References
+- [Ticket]()
+- [Design]()
+- [Tech Spec]()
+- [Product Spec]()
+
+## Size
+<!-- Guidance: Most PRs should be S-M sizes. Please don’t submit a L or XL PR without prior agreement from both the person doing the code review and a staff engineer. -->
+
+- [ ] S <10 lines
+- [ ] M <300 lines
+- [ ] L <1000 lines
+- [ ] XL >1000 lines
+
+## Business Impact of Affected Code
+<!-- Guidance: Most PRs should be S-L impact. Please don’t submit an XL PR without prior agreement from both the person doing the code review and a staff engineer. If the PR is an XL, ensure there is a strict testing and rollback plan in place with an SLA for when to rollback if an outage occurs. -->
+
+- [ ] S (zero impact)
+- [ ] M (may cause features not to work or small bugs)
+- [ ] L (may cause a P1 outage or data corruption)
+- [ ] XL (may cause a P0 outage or data corruption)
+
+## Rollout Strategy
+<!-- Guidance: Err on the side of caution with the rollout strategy. If there are multiple PRs, please link to them below. Get explicit sign off from the Product Manager or stakeholder on the rollout strategy and timing of the rollout. Align with them on the test plan for production. Ensure the test plan is both detailed and has sufficient metrics to determine whether to keep the change in place or to rollback. Should be in checklist form and completed on the closed PR. -->
+- [ ] Behind feature flag
+- [ ] Immediately into production
+- [ ] Unused until other action is taken (add link to PR, link to ticket or describe action that needs to be taken)
+
+Test Plan for Production:
+
+
+## Rollback Strategy
+<!-- Guidance: This is a runbook for rolling this change back in the event of an issue. It should be detailed enough to be completed by any engineer on the team and in checklist form. -->
+
+## Local Testing
+<!-- Guidance: Be sure to test both the happy path scenario and the unhappy path scenario. Ideally both automated tests and manual testing should have occurred but only one is required. The local testing plan must have been executed before the PR is put up. Please elaborate on the workflow and services tested, as well as the different data variations. -->
+
+- [ ] Covered by automated tests
+- [ ] Tested manually
+
+Local Testing Plan Executed:
+
+## Instrumentation/Alerting
+<!-- Guidance: Instrumentation and alerting should be a part of a new feature PR or have a separate instrumentation/alerting PR linked as a fast follow. For other types of PRs, this is optional (unless it’s an instrumentation/alerting PR). -->
+
+- [ ] Instrumentation included
+- [ ] Alerting to Sentry included
+
+## Screencaps
+
+
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudwatch-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.24
+  version: 0.1.26
 platform: ruby
 authors:
 - Seth Puckett
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -54,11 +54,27 @@ dependencies:
         version: '13.0'
 description:
 email:
-- puckett.seth@gmail.com
+- seth.puckett@pathccm.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_strict.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/cloudwatch_metrics.rb
+- lib/cloudwatch_metrics/configuration.rb
+- lib/cloudwatch_metrics/constants.rb
+- lib/cloudwatch_metrics/version.rb
+- lib/generators/cloudwatch_metrics/initializer_generator.rb
+- lib/generators/cloudwatch_metrics/templates/cloudwatch_metrics.rb
+- pull_request_template.md
 homepage: https://github.com/pathccm/cloudwatch_metrics
 licenses: []
 metadata: