cloudwatch-metrics 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 586e6288f7bb28dc0f45870852ea72130d9451fbdf5c9156014cfcfa153c0589
-  data.tar.gz: c47d772e45bbe741b1a8ea3579000d893c4318b74a64b361ee2663e3954d837c
+  metadata.gz: dce097d501539877de89d8451ef1c4f3fe2a96cbaebee60a06292b733696e30d
+  data.tar.gz: c65b336e84a4ed3c6c185b582e1e3488e2e95edfd01dab02f7a7d68c3e084e04
 SHA512:
-  metadata.gz: 7c899e1748bbc566958933a8a2ea7cc0082c64ebf65ce4ad726e2d327778140da564ce49a6afef6d0e264b84296c9a548542583c2b44fcd4eecaad1d7cdf5239
-  data.tar.gz: 5d2c76ec9505340252ed5eb3273c30ca759777eccc02062902a6e0b6fa489a98ed38931c81bfdafcfd93b5499a59853bee8da26d25655a08cf9ca772879dc4d7
+  metadata.gz: 5decfcc8b1023d215c7771e3548888f6c3c5cddca8f23eee819d258b811ec3b1cca4c30114da6a9cf02312b1bcc1b6034477509539e40b41c83c7e47069c2bef
+  data.tar.gz: 386f21b0c4efe665d3b01963c9ffc236b9e9c4a22bd33d2f0f651b25076cac4bfde3ce9e985791074b28ee97c0296ee69fd6472a9c5c9e32243a82ea87edcc88

data/.rubocop.yml

@@ -1,13 +1,339 @@
+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: 2.6
+    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
+
+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
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Lint/ImplicitStringConcatenation:
+    Enabled: false
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Rails/RenderInline:
+    Enabled: false
 
-Layout/LineLength:
-  Max: 120
+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/README.md

@@ -1,35 +1,74 @@
 # CloudwatchMetrics
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cloudwatch_metrics`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+`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
+```
 
-    $ bundle install
+To create the initializer:
+```
+rails generate cloudwatch_metrics:initializer
+```
 
-Or install it yourself as:
+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.
 
-    $ gem install cloudwatch_metrics
 
 ## Usage
 
-TODO: Write usage instructions here
+Available methods are in the `CloudwatchMetrics` module. For convenience this is aliased to `CW` by default.
+
+Metrics are reported using `CW.report` for single data points, or `CW.report_all` for collections of data points. Required and optional parameters for these methods are detailed below.
+
+### CW.report Required Parameters
+
+* `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)`
+
+
+`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.
+* `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])`
+
+### Optional Parameters
+
+Both reporting 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`: 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.
+
+## 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.
 
-## Development
+## Changing this gem
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+If you make changes to this gem you need to do a few things to make those updates available to clients.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+**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/))
 
-## Contributing
+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`
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cloudwatch_metrics.
+When the change has been published clients can update to the latest version with `bundle update cloudwatch-metrics`.

data/lib/cloudwatch_metrics/configuration.rb

@@ -3,5 +3,10 @@
 module CloudwatchMetrics
   class Configuration
     attr_accessor :namespace
+    attr_writer :no_cw_alias
+
+    def no_cw_alias
+      @no_cw_alias ||= false
+    end
   end
 end

data/lib/cloudwatch_metrics/constants.rb

@@ -0,0 +1,39 @@
+# 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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloudwatchMetrics
-  VERSION = "0.1.9"
+  VERSION = "0.1.11"
 end

data/lib/cloudwatch_metrics.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "cloudwatch_metrics/configuration"
+require_relative 'cloudwatch_metrics/configuration'
 
+# Posts custom metrics to AWS CloudWatch
 module CloudwatchMetrics
   class Error < StandardError; end
 
@@ -17,5 +18,43 @@ module CloudwatchMetrics
     def hi
       puts "Hello, #{configuration.namespace}"
     end
+
+    def record(
+      metric_name:, value:, unit: nil, namespace: configuration.namespace, dimensions: [], timestamp: nil
+    )
+      metric_data = [{
+        metric_name: metric_name,
+        value: value,
+        unit: unit,
+        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
+    )
+      metric_data = [{
+        metric_name: metric_name,
+        values: values,
+        counts: counts,
+        unit: unit,
+        dimensions: dimensions,
+        timestamp: timestamp
+      }]
+      put_data(namespace: namespace, metric_data: metric_data)
+    end
+
+    private
+
+    def put_data(namespace:, metric_data:)
+      resp = @cloudwatch_client.put_metric_data({
+        namespace: namespace,
+        metric_data: metric_data
+      })
+    end
   end
 end
+
+CW = CloudwatchMetrics unless CloudwatchMetrics.configuration.no_cw_alias

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

@@ -3,7 +3,12 @@
 require 'cloudwatch_metrics'
 
 CloudwatchMetrics.configure do |config|
-  # This is the default namespace that all metrics from this application will be published to.
-  # It should most likely be the name of the application/service.
-  config.namespace = "APPLICATION_NAME"
+  # 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 = 'APPLICATION_NAME'
+
+  # 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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudwatch-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Seth Puckett
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatch
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_strict.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -83,6 +84,7 @@ files:
 - 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