aws-embedded-metrics-customink 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b246b086f0c3f6ab958cf67acf79d2cde275f62a05dfe334979987c6b89a5921
-  data.tar.gz: 78329a269489d8d76f9dadaf157835fc45b18567b3080fe56064ea31360cfc7c
+  metadata.gz: 3e3fd136db6ae5ed75b8bfee3c810d07fe56bd7cebc388be40b0a15167726f8b
+  data.tar.gz: ff0aac20173bd4b0ce49d304c6dafcd8902c9ed32031d4d39b90be5d1082092e
 SHA512:
-  metadata.gz: 2e2597d6852f219be63ca576706ff0dccf3e3e709047430ae3fee911ff803e9120ae20389118d3c29d8e5e1843467a7178fe72440d413fa645239ff138a56a80
-  data.tar.gz: ad35b3d8557cb822f0d3706deadfc80e496ad932587194d3df9f7d6a4df26c0eaadd8868453de2f53ef2cbee6e2fcfa4192c0298f2389b457ea66869a1579cb1
+  metadata.gz: 8868afb3d8b3c29215104d838206c8d322a12c52fffd498721da1b179b0986e092e75cd6a1763f10f6a492be72faa6f6c61bb802762a5dc4f2034d1b5bdff3f2
+  data.tar.gz: 8f4ba0bedd55a0d5c799c6e4aa9f8d2c14c8cc680b05fd9354b11a1a7027303de0cf0db5f280f3b9fd32787aa5892c9227b7552ef3c21a84196a49b994f102d6

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 
 See this http://keepachangelog.com link for information on how we want this documented formatted.
 
+## v0.5.0
+
+### Added
+
+- Simple singleton/delegator for metrics instance in Rails.
+
 ## v0.4.0
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aws-embedded-metrics-customink (0.4.0)
+    aws-embedded-metrics-customink (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -56,6 +56,38 @@ Aws::Embedded::Metrics.logger do |metrics|
 end
 ```
 
+## Using Rails?
+
+And want to instrument metrics deep in your code during the request/response lifecycle? Consider creating a PORO like this `Metrics` example.
+
+```ruby
+class MyMetrics < Aws::Embedded::Metrics::Instance
+end
+```
+
+This object is ready to use as a per-request singleton that acts as a simple delegator to all metrics/logger methods. A great way to hook it up for your application is in ApplicationController.
+
+```ruby
+class ApplicationController < ActionController::Base
+  around_action :embedded_metrics
+  private
+  def embedded_metrics
+    Aws::Embedded::Metrics.logger do |metrics|
+      MyMetrics.instance = MyMetrics.new(metrics)
+      yield
+    end
+  end
+end
+```
+
+Now you can happily instrument your code.
+
+```ruby
+proof, time = MyMetrics.benchmark { @imagebuilder.data }
+MyMetrics.put_metric 'ImageBuilderTime', time, 'Milliseconds'
+MyMetrics.set_property 'ImageId', params[:image_id]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/aws-embedded-metrics-customink.rb

@@ -6,6 +6,7 @@ require 'aws-embedded-metrics-customink/version'
 require 'aws-embedded-metrics-customink/sinks'
 require 'aws-embedded-metrics-customink/config'
 require 'aws-embedded-metrics-customink/logger'
+require 'aws-embedded-metrics-customink/instance' if defined?(Rails)
 
 module Aws
   module Embedded

data/lib/aws-embedded-metrics-customink/instance.rb

@@ -0,0 +1,18 @@
+module Aws
+  module Embedded
+    module Metrics
+      class Instance < SimpleDelegator
+        mattr_accessor :instance
+
+        extend SingleForwardable
+
+        def_delegators :instance,
+                       :flush,
+                       :benchmark,
+                       :put_dimension,
+                       :put_metric,
+                       :set_property
+      end
+    end
+  end
+end

data/lib/aws-embedded-metrics-customink/version.rb

@@ -1,7 +1,7 @@
 module Aws
   module Embedded
     module Metrics
-      VERSION = '0.4.0'.freeze
+      VERSION = '0.5.0'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-embedded-metrics-customink
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ken Collins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -50,6 +50,7 @@ files:
 - bin/test
 - lib/aws-embedded-metrics-customink.rb
 - lib/aws-embedded-metrics-customink/config.rb
+- lib/aws-embedded-metrics-customink/instance.rb
 - lib/aws-embedded-metrics-customink/logger.rb
 - lib/aws-embedded-metrics-customink/sinks.rb
 - lib/aws-embedded-metrics-customink/sinks/logger.rb