aws-embedded-metrics-customink 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76477125adcfa5d534ff63eda7c6b3469e5ca3c5c778ce40b9b23bce906d1da5
-  data.tar.gz: 0bee3bd7ea8e7d2d1ed0a72f928c29741caf17c9d3af2e83901896bfcb40f39a
+  metadata.gz: b07c505a8d7790b89bff615c824567402f3e6b613287753ea5b7fe930614ce8b
+  data.tar.gz: cd42f99bccbd143a40acdd8f7ec91e442d3fc2c6475397179561c78482e9a2de
 SHA512:
-  metadata.gz: 5a73a2ab9be29c38ab9dd833642d22877481d46b909740820cfa2420d9fa655f9dc348c9dbf82aa73f61621a00ce1263e4eef4e9b4edc6bb380e67410cfce558
-  data.tar.gz: 5ae92d80a90c497a264775a1a5db28ea7614a922cb33865bc7f102e0b65303f80dad0d6f18d485a665100b3a73988a4e387a74dad8e53fe1e267b861df076276
+  metadata.gz: 8de84739de64092a2998196e7a5348ad2a8339282eb7fdc7dfbb0773096dd70fd8ef77e853e8a812075c3d6ef2cddd74fdb9cb629643bb0efabd9fe9a8168582
+  data.tar.gz: 9892885a4debc5335e8c43cecc687e4107c8ac52efb046cb82b12c3d12c0529a40c23d73e4b9539ca51b94b6de6dfd805f417136f68a6a3551ddc684e85f72a9

data/.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+name: Lint
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.7'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Bundle
+        run: |
+          ./bin/setup
+      - name: Rubocop
+        run: |
+          ./bin/bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,89 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - "test/**/*"
+    - "bin/**/*"
+    - "*.gemspec"
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment: # PENDING: [Ruby3.x] Remove this, autofix, test, conform.
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,19 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-07-30 18:19:25 UTC using RuboCop version 0.88.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/aws-embedded-metrics-customink.rb'

data/CHANGELOG.md

@@ -3,6 +3,42 @@
 
 See this http://keepachangelog.com link for information on how we want this documented formatted.
 
+## v0.6.0
+
+### Fixed
+
+- Moved concurrent-ruby to runtime dep.
+
+## v0.5.0
+
+### Added
+
+- Simple singleton/delegator for metrics instance in Rails.
+
+## v0.4.0
+
+### Changed
+
+- Use Concurrent Ruby for Logger data.
+
+## v0.3.0
+
+### Added
+
+- New `benchmark` helper.
+
+## v0.2.0
+
+### Changed
+
+- `Lambda` sink renamed to `Stdout` to reflect its destination rather than its intended use
+- The currently configured sink is now accessed through the `Config` object rather than from the root namespace
+- Improved test coverage
+
+### Added
+
+- A `Logger` sink to emit to a Ruby Logger instance, for logfile output
+
 ## v0.1.0
 
 ### Added

data/Gemfile

@@ -1,8 +1,9 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec
 
-gem 'rake'
 gem 'minitest'
+gem 'rake'
+gem 'rubocop'
 
 group :test do
   gem 'mocha'

data/Gemfile.lock

@@ -1,19 +1,41 @@
 PATH
   remote: .
   specs:
-    aws-embedded-metrics-customink (0.1.0)
+    aws-embedded-metrics-customink (0.6.0)
+      concurrent-ruby
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     coderay (1.1.3)
+    concurrent-ruby (1.1.7)
     method_source (1.0.0)
     minitest (5.14.1)
     mocha (1.11.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.3)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -24,6 +46,7 @@ DEPENDENCIES
   mocha
   pry
   rake
+  rubocop
 
 BUNDLED WITH
    2.1.2

data/README.md

@@ -29,7 +29,7 @@ gem 'aws-embedded-metrics-customink'
 ```
 ## Usage
 
-Simple configuration.
+Simple configuration:
 
 ```ruby
 Aws::Embedded::Metrics.configure do |c|
@@ -37,6 +37,14 @@ Aws::Embedded::Metrics.configure do |c|
 end
 ```
 
+Using the `Logger` sink to write to a log file:
+
+```ruby
+Aws::Embedded::Metrics.configure do |c|
+  c.sink = Aws::Embedded::Metrics::Sinks::Logger.new(Rails.logger)
+end
+```
+
 Usage is in a scope block. All metrics are flushed afterward
 
 ```ruby
@@ -48,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/aws-embedded-metrics-customink.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.add_dependency 'concurrent-ruby'
 end

data/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

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

@@ -1,14 +1,21 @@
 require 'json'
 require 'benchmark'
+require 'concurrent/array'
+require 'concurrent/hash'
 require 'aws-embedded-metrics-customink/version'
-require 'aws-embedded-metrics-customink/config'
 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
     module Metrics
 
+      def config
+        Config.config
+      end
+
       def configure
         Config.configure { |c| yield(c) }
       end
@@ -23,11 +30,7 @@ module Aws
         end
       end
 
-      def sink
-        @sink ||= Sinks::Lambda.new
-      end
-
-      extend self
+      module_function :config, :configure, :reconfigure, :logger
 
     end
   end

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

@@ -3,6 +3,8 @@ module Aws
     module Metrics
       module Config
 
+        DEFAULT_SINK = Sinks::Stdout
+
         def configure
           yield(config)
           config
@@ -16,11 +18,11 @@ module Aws
           @config ||= Configuration.new
         end
 
-        extend self
+        module_function :configure, :reconfigure, :config
 
         class Configuration
 
-          attr_writer :namespace
+          attr_writer :namespace, :sink
 
           def reconfigure
             instance_variables.each { |var| instance_variable_set var, nil }
@@ -30,9 +32,14 @@ module Aws
 
           def namespace
             return @namespace if defined?(@namespace)
+
             ENV['AWS_EMF_NAMESPACE'] || 'aws-embedded-metrics'
           end
 
+          def sink
+            @sink ||= DEFAULT_SINK.new
+          end
+
         end
       end
     end

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/logger.rb

@@ -3,12 +3,12 @@ module Aws
     module Metrics
       class Logger
 
-        def initialize(sink = Sinks::Lambda)
-          @sink = sink.new
+        def initialize(sink = Config.config.sink)
+          @sink = sink
           @namespace = Config.config.namespace
-          @dimensions = []
-          @metrics = []
-          @properties = {}
+          @dimensions = Concurrent::Array.new
+          @metrics = Concurrent::Array.new
+          @properties = Concurrent::Hash.new
         end
 
         def metrics
@@ -18,7 +18,14 @@ module Aws
         end
 
         def flush
-          Metrics.sink.accept(message) unless empty?
+          @sink.accept(message) unless empty?
+        end
+
+        def benchmark
+          value = nil
+          seconds = Benchmark.realtime { value = yield }
+          milliseconds = (seconds * 1000).to_i
+          [value, milliseconds]
         end
 
         def put_dimension(name, value)
@@ -27,9 +34,9 @@ module Aws
         end
 
         def put_metric(name, value, unit = nil)
-          @metrics << { 'Name' => name }.tap { |m|
+          @metrics << { 'Name' => name }.tap do |m|
             m['Unit'] = unit if unit
-          }
+          end
           set_property name, value
         end
 
@@ -39,7 +46,7 @@ module Aws
         end
 
         def empty?
-          [@dimensions, @metrics, @properties].all? { |x| x.empty? }
+          [@dimensions, @metrics, @properties].all?(&:empty?)
         end
 
         def message

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

@@ -1 +1,2 @@
-require 'aws-embedded-metrics-customink/sinks/lambda'
+require 'aws-embedded-metrics-customink/sinks/logger'
+require 'aws-embedded-metrics-customink/sinks/stdout'

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

@@ -0,0 +1,22 @@
+module Aws
+  module Embedded
+    module Metrics
+      module Sinks
+        class Logger
+
+          attr_reader :logger, :level
+
+          def initialize(logger, level: :info)
+            @logger = logger
+            @level = level.to_sym
+          end
+
+          def accept(message)
+            logger.public_send(level, JSON.dump(message))
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/aws-embedded-metrics-customink/sinks/{lambda.rb → stdout.rb}

@@ -2,7 +2,7 @@ module Aws
   module Embedded
     module Metrics
       module Sinks
-        class Lambda
+        class Stdout
 
           def accept(message)
             puts JSON.dump(message)

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

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: aws-embedded-metrics-customink
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ken Collins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Amazon CloudWatch Embedded Metric Format Client Library for Ruby.
 email:
 - ken@metaskills.net
@@ -18,7 +32,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/lint.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -27,14 +44,17 @@ files:
 - README.md
 - Rakefile
 - aws-embedded-metrics-customink.gemspec
+- bin/bundle
 - bin/console
 - bin/setup
 - 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/lambda.rb
+- lib/aws-embedded-metrics-customink/sinks/logger.rb
+- lib/aws-embedded-metrics-customink/sinks/stdout.rb
 - lib/aws-embedded-metrics-customink/version.rb
 homepage: https://github.com/customink/aws-embedded-metrics-customink
 licenses: