json_tagged_logging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02acce9f70b29082efbd37520fab4ffb0dd4811aecd019a48e848a26e9b065c8
+  data.tar.gz: a600831fcf014b197d33aa2bbd39c963c4193fae413ff8e3889bb9aebc9a1517
+SHA512:
+  metadata.gz: 01720d02b362bec20640e998c7f2fff6028832654160003a0c3f9627a4f2d18815af7218cd3b6cc97a299db958f4c046666d43b2bd309dd42f13a82ceb8ecb12
+  data.tar.gz: f8a55aa6b114346c851399669e0133cc3304d8e639209862005bb3512552516112b580eef482b1044730c5c0cb171caa8f85a787e4cc75c4e32644f570e5c3e0

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,18 @@
+image: ruby:latest
+
+stages:
+  - test
+
+cache:
+  paths:
+    - vendor/ruby
+
+before_script:
+  - ruby -v  # Print out ruby version for debugging
+  - gem install bundler  --no-document    # Bundler is not installed with the image
+  - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+test:
+  stage: test
+  script:
+    - bundle exec rake

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+json_tagged_logging

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

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 t.skukx@gmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in json_tagged_logging.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Taylor Scott
+
+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,79 @@
+# JsonTaggedLogging
+
+This gem is for the purpose of serializing your logs as JSON. This can be valuable if you're shipping logs
+and need to easily search data.
+
+This logger is very similar to [ActiveSupport::TaggedLogging](https://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html). The
+difference rather that tags being strings, your tags can be key/value pairs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_tagged_logging'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install json_tagged_logging
+
+## Usage
+
+**Decorate your logger**
+
+```ruby
+logger = Logger.new(STDOUT)
+logger = JsonTaggedLogging.new(logger)
+
+logger.info 'This is a log'
+#=> {"level":"INFO","timestamp":"2020-05-29T21:23:43.990Z","app":null,"message":"This is a log"}
+```
+
+**Tag your logs**
+
+```ruby
+logger.tagged('request.id': 'abc123') do
+  logger.info 'Some action occurred'
+end
+#=> {"level":"INFO","timestamp":"2020-05-29T21:27:26.810Z","app":null,"message":"Some action occurred","request.id":"abc123"}
+```
+
+**Other usage**
+
+```ruby
+# Pass in a hash
+logger.info data: { x: 1, y: 2 }
+#=> {"level":"INFO","timestamp":"2020-05-29T21:29:02.324Z","app":null,"data":{"x":1,"y":2},"message":null}
+
+# Pass in a hash and include a message
+logger.info message: 'my message', data: { x: 1, y: 2 }
+#=> {"level":"INFO","timestamp":"2020-05-29T21:30:13.106Z","app":null,"data":{"x":1,"y":2},"message":"my message"}
+
+# Pass in an Exception
+logger.error(StandardError.new('oops'))
+#=> {"level":"ERROR","timestamp":"2020-05-29T21:32:15.488Z","app":null,"message":"oops","error":{"name":"StandardError","message":"oops","trace":null}}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/deseretbook/packages/json-tagged-logging. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/deseretbook/packages/json-tagged-logging/-/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JsonTaggedLogging project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/deseretbook/packages/json-tagged-logging/-/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_tagged_logging"
+
+# 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/json_tagged_logging.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/json_tagged_logging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_tagged_logging"
+  spec.version       = JsonTaggedLogging::VERSION
+  spec.authors       = ["Taylor Scott"]
+  spec.email         = ["t.skukx@gmail.com"]
+
+  spec.summary       = %q{Write your logs as JSON}
+  spec.description   = %q{Write and tag your logs formatted as JSON}
+  spec.homepage      = "https://gitlab.com/deseretbook/packages/json-tagged-logging"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'oj'
+end

data/lib/json_tagged_logging.rb

@@ -0,0 +1,55 @@
+require 'active_support/core_ext'
+require 'active_support/json'
+require 'active_support/tagged_logging'
+require 'oj'
+
+require 'json_tagged_logging/formatter'
+require 'json_tagged_logging/version'
+
+##
+# Wraps any standard Logger object to provide tagging capabilities.
+#
+# This implementation is wideley taken from ActiveSupport::TaggedLogging with
+# some modifications
+#
+# @see https://github.com/rails/rails/blob/master/activesupport/lib/active_support/tagged_logging.rb
+#
+# @example Creating Logs
+#   logger = JsonTaggedLogging.new(Logger.new(STDOUT))
+#
+#   logger.tagged(channel: 'api') { logger.info 'Stuff' }
+#   #=> { "level": "INFO", "message": "Stuff", "channel": "api" }
+#
+#   logger.tagged(channel: 'api', user: 1) { logger.info 'Stuff' }
+#   #=> { "level": "INFO", "message": "Stuff", "channel": "api", "user": 1 }
+#
+#   logger.tagged(channel: 'api') { logger.tagged(user: 1) { logger.info 'Stuff' } }
+#   #=> { "level": "INFO", "message": "Stuff", "channel": "api", "user": 1 }
+#
+module JsonTaggedLogging
+  def self.new(logger)
+    logger = logger.dup
+
+    if logger.formatter
+      logger.formatter = logger.formatter.dup
+    else
+      # Ensure we set a default formatter so we aren't extending nil!
+      logger.formatter = ActiveSupport::Logger::SimpleFormatter.new
+    end
+
+    logger.formatter.extend JsonTaggedLogging::Formatter
+    logger.extend(self)
+  end
+
+  delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter
+
+  def tagged(*tags)
+    formatter.tagged(*tags) { yield self }
+  end
+
+  def flush
+    clear_tags!
+    super if defined?(super)
+  end
+end
+

data/lib/json_tagged_logging/formatter.rb

@@ -0,0 +1,55 @@
+##
+# Formats logs as JSON
+#
+module JsonTaggedLogging
+  module Formatter # :nodoc:
+    include ActiveSupport::TaggedLogging::Formatter
+
+    RESERVED_FIELDS = %i[level timestamp app message trace]
+
+    def call(severity, timestamp, progname, msg)
+      tags = tags_hash.except(*RESERVED_FIELDS)
+
+      log = {
+        level: severity,
+        timestamp: timestamp.utc,
+        app: progname
+      }
+
+      log.merge!(serialize_message(msg))
+      log.merge!(tags)
+
+      Oj.dump(log, mode: :compat) + "\n"
+    end
+
+    def tags_hash
+      tags = current_tags.inject do |memo, value|
+        value.is_a?(Hash) ? memo.merge(value) : memo
+      end
+
+      tags.is_a?(Hash) ? tags : {}
+    end
+
+    private
+
+    def serialize_message(msg)
+      serialized = {}
+
+      if msg.is_a?(Hash)
+        serialized.merge! msg.except(*RESERVED_FIELDS)
+        serialized[:message] = msg[:message] || msg['message']
+      elsif msg.is_a?(Exception)
+        serialized[:message] = msg.message
+        serialized[:error] = {
+          name: msg.class.name,
+          message: msg.message,
+          trace: msg.backtrace
+        }
+      else
+        serialized[:message] = msg
+      end
+
+      serialized
+    end
+  end
+end

data/lib/json_tagged_logging/version.rb

@@ -0,0 +1,3 @@
+module JsonTaggedLogging
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: json_tagged_logging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taylor Scott
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: oj
+  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: Write and tag your logs formatted as JSON
+email:
+- t.skukx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_tagged_logging.gemspec
+- lib/json_tagged_logging.rb
+- lib/json_tagged_logging/formatter.rb
+- lib/json_tagged_logging/version.rb
+homepage: https://gitlab.com/deseretbook/packages/json-tagged-logging
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/deseretbook/packages/json-tagged-logging
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Write your logs as JSON
+test_files: []