ama_logger 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97f8723f2fd607f2c2a4b6a2f9ecb7c0828f361c
-  data.tar.gz: e35ae18d44bf2f2ad3d863e6608368c7cbe93aa4
+SHA256:
+  metadata.gz: 82c2fc23eb3fb3b209ca6a0e5a4227f73adc9e694a4a48f20b9d830a83fe9834
+  data.tar.gz: 967b8acb04279d9d1abc42ef289a76dd7e9ca4681746c7be43d9615c9189540f
 SHA512:
-  metadata.gz: 998b0a701d0988acf1bd99bc8392f94eecf233235b38a06c272c02fbc1de6125a9bd93137e37cd15e1aa243a4a1884d3252e17b477e109db6bec50de9482b594
-  data.tar.gz: f6a072cf401c8aa6ae243e709b20c497607f55410239fb21d6b671396f8777fd4871aa016e0c5ffc137a7b8618c3dfaadd7d0c786dc367edad5a16db82309da8
+  metadata.gz: 3a0fdb20f027e387375528eae35f4275f9f8a2ae022e15e3e56f940236b752b8984982d5b88c07b2928ac09d8124251ad5c6a1c16661fa33a723ab6f472b0a96
+  data.tar.gz: 1f9ddad15968aafcb468789469cb1296374203e79c290941ef51ae305ac95d3b1ba87105a5f0d8449a0ee2bc83850ecb894e0f389675596ab957e251825b4233

data/.rubocop.yml

@@ -17,6 +17,6 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 25
 Metrics/AbcSize:
-  Max: 17
+  Max: 20
 Style/Lambda:
   EnforcedStyle: literal

data/README.md

@@ -32,7 +32,7 @@ This library includes the following custom log formatters:
 
 ### Ama::Logger::Formatter::Lambda
 
-This formatter accepts a Ruby hash as a message and outputs a JSON string.
+This formatter accepts a Ruby hash as a message, an AWS Lambda context instance and outputs a JSON string.
 
 The input hash must look like:
 
@@ -48,6 +48,25 @@ Ama.logger.info(
 )
 ```
 
+### Ama::Logger::Formatter::Json
+
+This formatter accepts a Ruby hash as a message and outputs a JSON string.
+
+The input hash must look like:
+
+```ruby
+Ama.logger.info(
+  event_name: 'log.info',                       # required
+  event_id: '1234',                             # required - indexed
+  event_source: 'my_source',                    # required - indexed
+  exception: 'ArgumentError - something broke', # optional - indexed
+  metric_name: 'error:count',                   # optional - indexed
+  metric_value: 1,                              # optional - indexed, coerced to integer
+  metric_content: 'error',                      # optional - indexed, coerced to string
+  details: { message: 'test' }                  # optional - non-indexed, Hash coerced to string
+)
+```
+
 ### Ama::Logger::Formatter::StringifiedHash
 
 This formatter accepts string message and outputs a JSON string. The formatter is able to filter sensitive data based on the input provided.

data/lib/ama/logger.rb

@@ -29,6 +29,12 @@ module Ama
         end
       end
 
+      def json(io = STDOUT, *args)
+        ::Logger.new(io, *args).tap do |instance|
+          instance.formatter = Ama::Logger::Formatter::Json.new
+        end
+      end
+
       def stringified_hash(base, opts = {})
         base.dup.tap do |instance|
           instance.formatter = Ama::Logger::Formatter::StringifiedHash.new(opts)

data/lib/ama/logger/base.rb

@@ -8,4 +8,5 @@ require 'securerandom'
 
 require_relative 'version'
 require_relative 'formatter/lambda'
+require_relative 'formatter/json'
 require_relative 'formatter/stringified_hash'

data/lib/ama/logger/formatter/json.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Ama
+  module Logger
+    module Formatter
+      class Json
+        def call(severity, time, _progname, msg = {})
+          invalid_argument!(:msg, Hash, msg) unless msg.is_a?(Hash)
+
+          event_name = msg.fetch(:event_name) { missing_argument!(:event_name) }
+          event_source = msg.fetch(:event_source) { missing_argument!(:event_source) }
+          event_id = msg.fetch(:event_id) { missing_argument!(:event_id) }
+
+          {
+            exception: msg[:exception],
+            eventName: event_name,
+            eventSource: event_source.to_s,
+            eventId: event_id.to_s,
+            eventAgent: Ama::Logger::AGENT_VERSION,
+            details: details(msg),
+            indexed: indexed(msg),
+            severity: severity,
+            timestamp: time.utc.iso8601
+          }
+            .compact
+            .to_json
+            .concat("\n")
+        end
+
+        private
+
+        def details(data = {})
+          data.fetch(:details) { {} }.to_json
+        end
+
+        def indexed(opts = {})
+          data = opts.slice(:metric_name, :metric_value, :metric_content)
+
+          {
+            metricName: data[:metric_name]&.to_s,
+            metricValue: data[:metric_value]&.to_i,
+            metricContent: data[:metric_content]&.to_s
+          }
+            .compact
+        end
+
+        def missing_argument!(name)
+          raise ArgumentError, "must pass the `#{name}` argument"
+        end
+
+        def invalid_argument!(name, klass, value)
+          raise ArgumentError, "expected type `#{klass.inspect}` for argument `#{name}` - got `#{value.inspect}`"
+        end
+      end
+    end
+  end
+end

data/lib/ama/logger/version.rb

@@ -2,6 +2,6 @@
 
 module Ama
   module Logger
-    VERSION = '1.1.1'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ama_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jesse Doyle
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,6 +139,7 @@ files:
 - bin/setup
 - lib/ama/logger.rb
 - lib/ama/logger/base.rb
+- lib/ama/logger/formatter/json.rb
 - lib/ama/logger/formatter/lambda.rb
 - lib/ama/logger/formatter/stringified_hash.rb
 - lib/ama/logger/version.rb
@@ -162,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Implementation of AMA's standard logging format