ama_logger 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97f8723f2fd607f2c2a4b6a2f9ecb7c0828f361c
+  data.tar.gz: e35ae18d44bf2f2ad3d863e6608368c7cbe93aa4
+SHA512:
+  metadata.gz: 998b0a701d0988acf1bd99bc8392f94eecf233235b38a06c272c02fbc1de6125a9bd93137e37cd15e1aa243a4a1884d3252e17b477e109db6bec50de9482b594
+  data.tar.gz: f6a072cf401c8aa6ae243e709b20c497607f55410239fb21d6b671396f8777fd4871aa016e0c5ffc137a7b8618c3dfaadd7d0c786dc367edad5a16db82309da8

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+# built gem
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+Documentation:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+Metrics/LineLength:
+  Max: 130
+Metrics/MethodLength:
+  Max: 25
+Metrics/AbcSize:
+  Max: 17
+Style/Lambda:
+  EnforcedStyle: literal

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  SimpleCov.minimum_coverage 100.00
+end

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install:
+  - gem install bundler -v 1.17.3
+install:
+  - bundle _1.17.3_ install

data/CODEOWNERS

@@ -0,0 +1 @@
+* @amaabca/red

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jesse.doyle@ama.ab.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ama_logger.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alberta Motor Association
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Ama::Logger
+
+This library implements AMA's standardized log format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ama_logger', git: 'git@github.com:amaabca/ama_logger'
+```
+
+## Usage
+
+A default logger instance that writes to `STDOUT` is provided via the `Ama.logger` method:
+
+```ruby
+Ama.logger.info(context: context, event_name: 'log.info', metric_name: 'test', metric_value: 1)
+```
+
+You can override the default logger instance if you wish:
+
+```ruby
+Ama.logger = Ama::Logger.lambda(STDERR, level: Logger::Severity::DEBUG)
+```
+
+The default `logger` instance is intended for use with AWS Lambda - it requires a `context` instance (from a [Lambda handler](https://docs.aws.amazon.com/lambda/latest/dg/ruby-context.html)) to be passed as well as any additional data.
+
+## Formatters
+
+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.
+
+The input hash must look like:
+
+```ruby
+Ama.logger.info(
+  context: context,                             # required - the Lambda context instance (https://docs.aws.amazon.com/lambda/latest/dg/ruby-context.html)
+  event_name: 'log.info',                       # required
+  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.
+
+Instances of this formatter accept the following parameters during initialization:
+
+```ruby
+Ama::Logger::Formatter::StringifiedHash.new(
+  filters: [:password],  # optional - named parameters that will be filtered from output
+  event_name: 'my.event' # optional - mapped to the `eventName` property in JSON output
+)
+```
+
+This formatter is commonly used to filter sensitive data from internal Rails logging mechanisms (i.e. ActiveJob).
+
+See below for an example to override the ActiveJob logger:
+
+```ruby
+ActiveJob::Base.logger = Ama::Logger.stringified_hash(
+  ActiveJob::Base.logger,
+  event_name: 'rails.activejob',
+  filters: Rails.configuration.filter_parameters,
+  progname: 'gatekeeper'
+)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amaabca/ama_logger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]
+
+RuboCop::RakeTask.new

data/ama_logger.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ama/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ama_logger'
+  spec.version = Ama::Logger::VERSION
+  spec.authors = [
+    'Jesse Doyle',
+    'Michael van den Beuken',
+    'Darko Dosenovic',
+    'Zoie Carnegie',
+    'Ruben Estevez'
+  ]
+  spec.email = [
+    'jesse.doyle@ama.ab.ca',
+    'michael.vandenbeuken@ama.ab.ca',
+    'darko.dosenovic@ama.ab.ca',
+    'zoie.carnegie@ama.ab.ca',
+    'ruben.estevez@ama.ab.ca'
+  ]
+  spec.required_ruby_version = '>= 2.3.1'
+  spec.summary = 'Implementation of AMA\'s standard logging format'
+  spec.description = 'Log formatters and helper classes for the AMA standardized log format'
+  spec.homepage = 'https://github.com/amaabca/ama_logger'
+  spec.license = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    git_files = `git ls-files -z`.split("\x0")
+    git_files.reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'factory_bot'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.65.0'
+  spec.add_development_dependency 'simplecov'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ama_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ama/logger.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'logger/base'
+
+module Ama
+  # global logger instance initialization
+  # usage:
+  #
+  # Ama.logger.info(context: context, event_name: 'test')
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.lambda
+    end
+  end
+
+  module Logger
+    AGENT_VERSION = "ama_logger:#{Ama::Logger::VERSION}"
+
+    class << self
+      def root
+        Pathname.new(Gem.loaded_specs['ama_logger'].full_gem_path)
+      end
+
+      def lambda(io = STDOUT, *args)
+        ::Logger.new(io, *args).tap do |instance|
+          instance.formatter = Ama::Logger::Formatter::Lambda.new
+        end
+      end
+
+      def stringified_hash(base, opts = {})
+        base.dup.tap do |instance|
+          instance.formatter = Ama::Logger::Formatter::StringifiedHash.new(opts)
+          instance.progname = opts[:progname]
+        end
+      end
+    end
+  end
+end

data/lib/ama/logger/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'time'
+require 'logger'
+require 'pathname'
+require 'securerandom'
+
+require_relative 'version'
+require_relative 'formatter/lambda'
+require_relative 'formatter/stringified_hash'

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Ama
+  module Logger
+    module Formatter
+      class Lambda
+        def call(severity, time, _progname, msg = {})
+          invalid_argument!(:msg, Hash, msg) unless msg.is_a?(Hash)
+
+          context = msg.fetch(:context) { missing_argument!(:context) }
+          event_name = msg.fetch(:event_name) { missing_argument!(:event_name) }
+
+          {
+            exception: msg[:exception],
+            eventName: event_name,
+            eventSource: context.invoked_function_arn,
+            eventId: context.aws_request_id,
+            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/formatter/stringified_hash.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Ama
+  module Logger
+    module Formatter
+      class StringifiedHash
+        attr_accessor :filters, :regex, :event_name
+
+        def initialize(opts = {})
+          self.filters = opts.fetch(:filters) { [] }
+                             .select { |p| p.is_a?(Symbol) || p.is_a?(String) }
+                             .map(&:to_s)
+                             .join('|')
+          self.regex = /:(?<name>#{filters})=>"(?<value>[^"]*)"/
+          self.event_name = opts.fetch(:event_name) { 'log.rails' }
+        end
+
+        def call(severity, time, progname, msg)
+          {
+            eventName: event_name,
+            eventSource: progname || self.class.name,
+            eventId: SecureRandom.uuid,
+            eventAgent: Ama::Logger::AGENT_VERSION,
+            severity: severity,
+            details: msg.gsub(regex, ':\k<name>=>"[FILTERED]"'),
+            timestamp: time.utc.iso8601
+          }
+            .compact
+            .to_json
+            .concat("\n")
+        end
+      end
+    end
+  end
+end

data/lib/ama/logger/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ama
+  module Logger
+    VERSION = '1.1.1'
+  end
+end

data/lib/ama_logger.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'ama/logger'

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: ama_logger
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Jesse Doyle
+- Michael van den Beuken
+- Darko Dosenovic
+- Zoie Carnegie
+- Ruben Estevez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Log formatters and helper classes for the AMA standardized log format
+email:
+- jesse.doyle@ama.ab.ca
+- michael.vandenbeuken@ama.ab.ca
+- darko.dosenovic@ama.ab.ca
+- zoie.carnegie@ama.ab.ca
+- ruben.estevez@ama.ab.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ama_logger.gemspec
+- bin/console
+- bin/setup
+- lib/ama/logger.rb
+- lib/ama/logger/base.rb
+- lib/ama/logger/formatter/lambda.rb
+- lib/ama/logger/formatter/stringified_hash.rb
+- lib/ama/logger/version.rb
+- lib/ama_logger.rb
+homepage: https://github.com/amaabca/ama_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Implementation of AMA's standard logging format
+test_files: []