cloudwatch-metrics 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe7fbdd2e3121c9144df74e1e620277b0d9c1d019eefcbc62592e979d575cf2
-  data.tar.gz: e4c052ef871bd758454ebbd52d931eb2af554c0cf3e13ca2aad612cf533c39e4
+  metadata.gz: 2cf213da73437c9d5d4e161a5c521187b7e10c6dec006e5b0d9dca7311a9ec72
+  data.tar.gz: eed0f8940588afa007452cebb3e991ad932c8b18ebae148465769440cf2c328e
 SHA512:
-  metadata.gz: 4ac092df3e27dc27438a72d8e1962fd35a5ea623074c0853f29874c31f90518090555389a9e4d63e8ea88491b40643e2f80d8e531ce9d66b8438ce0826cf90d2
-  data.tar.gz: 8fe6aa51871bef6c68df7d00c22a421834a057c722c819fb7efd58a588f3a8bc03710fb22a445906a01b16d5e7aa61edb84f647100b73aeb8415eab9c11fc220
+  metadata.gz: 2985f423ac16673f9ca42ca7841d192bf109fdd6f59e60f793c369ecf39e2439b8af38254a95068eba4545720e523c9ef0d3d9317d4f05c0e64eceaa2f775bea
+  data.tar.gz: b53195c2982138aad940409ace56540bf244bf672c74aae80c823b9d0b945371d920927496039ee034789d26d5a8f7818c837645e6ec3e54d9eb42a93907a43e

data/README.md

@@ -27,36 +27,36 @@ The initializer contains descriptions for all available options. The only option
 
 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.
+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.report Required Parameters
+### CW.record Required Parameters
 
 * `name`: The name of the metric.
-* `value`: The value for the single data point being reported.
+* `value`: The value for the single data point being recorded.
 
-E.g. `CW.report(name: 'search_result_count', value: 25)`
+E.g. `CW.record(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.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.report_all Required Parameters
+### CW.record_all Required Parameters
 
 * `name`: The name of the metric.
-* `values`: Array of values for the data points being reported.
+* `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.report_all(name: 'search_result_count', values: [25, 50, 65], counts: [1, 2, 1])`
+E.g. `CW.record_all(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
+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 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(name: 'search_result_count', value: 25, unit: CW.COUNT, namespace: 'custom_namespace', dimensions: { group: 'A', subgroup: 'B' }, timeStamp: Time.current - 1.day)`
+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
 

data/lib/cloudwatch_metrics/constants.rb

@@ -35,5 +35,4 @@ module CloudwatchMetrics
     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
+end

data/lib/cloudwatch_metrics/version.rb

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

data/lib/cloudwatch_metrics.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'cloudwatch_metrics/configuration'
+require_relative 'cloudwatch_metrics/constants'
 
 # Posts custom metrics to AWS CloudWatch
 module CloudwatchMetrics

metadata

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