aws-embedded-metrics-customink 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76477125adcfa5d534ff63eda7c6b3469e5ca3c5c778ce40b9b23bce906d1da5
-  data.tar.gz: 0bee3bd7ea8e7d2d1ed0a72f928c29741caf17c9d3af2e83901896bfcb40f39a
+  metadata.gz: dc12276136937bb9f0fe45dfecb340e136b262e3f147bfb1c7449a94092fcaa9
+  data.tar.gz: bca1439d7fd26e6368410f3e6aa92189a98b3e9d5c6d9aae1c67b79300f9467b
 SHA512:
-  metadata.gz: 5a73a2ab9be29c38ab9dd833642d22877481d46b909740820cfa2420d9fa655f9dc348c9dbf82aa73f61621a00ce1263e4eef4e9b4edc6bb380e67410cfce558
-  data.tar.gz: 5ae92d80a90c497a264775a1a5db28ea7614a922cb33865bc7f102e0b65303f80dad0d6f18d485a665100b3a73988a4e387a74dad8e53fe1e267b861df076276
+  metadata.gz: 4c3b5dedf5d198a08f6d4863c6c5cd50b194d124f0e619a46600742d2bb46d2560ba4709d8ddba88009e0b0251fe9efc7bf6ae29e2fa0c58c889647b883ce065
+  data.tar.gz: 822ba5fe608f5aae296f5903b173d1dfc893dceaa7d7007921cec664856ebd7a1b4d1de7dbcc9b3d67e0f0bf2ee2c8a2677a6c7c2e7e4b130ba8f90912c1bd93

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 
 See this http://keepachangelog.com link for information on how we want this documented formatted.
 
+## 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.lock

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

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

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

@@ -1,14 +1,18 @@
 require 'json'
 require 'benchmark'
 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'
 
 module Aws
   module Embedded
     module Metrics
 
+      def config
+        Config.config
+      end
+
       def configure
         Config.configure { |c| yield(c) }
       end
@@ -23,10 +27,6 @@ module Aws
         end
       end
 
-      def sink
-        @sink ||= Sinks::Lambda.new
-      end
-
       extend self
 
     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
@@ -20,7 +22,7 @@ module Aws
 
         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/logger.rb

@@ -3,8 +3,8 @@ 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 = []
@@ -18,7 +18,7 @@ module Aws
         end
 
         def flush
-          Metrics.sink.accept(message) unless empty?
+          @sink.accept(message) unless empty?
         end
 
         def put_dimension(name, value)

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.2.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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ken Collins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies: []
 description: Amazon CloudWatch Embedded Metric Format Client Library for Ruby.
 email:
@@ -34,7 +34,8 @@ files:
 - lib/aws-embedded-metrics-customink/config.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: