bctlogger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4aec80ca514dcbf6a04eae1ad591273668bbc07994ed030b8ae005f2b165ade1
+  data.tar.gz: c8a78510ff2ae617d0104b5f6372dac2276f8034d8081dd549f97c57713b3531
+SHA512:
+  metadata.gz: '0796d63f6f289cb9c6081526ef130b1c624944c7d079bd0d387003055cf21d223f2eac8cb80a7f2d8bf2072cf2cceada2e88b42ac8ab070f744b9c28af8c52c2'
+  data.tar.gz: b22c93f6c5173b611f3f008644e8e89bbf25726634b87250e75527c7c52489398fe740442e1d6fc77072746bd8d51c826511b05d1dc316f0afa95777f7069524

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bctlogger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    bctlogger (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bctlogger!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,37 @@
+# Bctlogger
+
+Blockchain Tech json log formatter.
+A log formatter for Kibana
+
+## Our logging strategy
+
+[Logging Strategy](https://bctech.atlassian.net/wiki/spaces/architecture/pages/54394887/Logging+strategy)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bctlogger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bctlogger
+
+## Usage
+
+
+## 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 GitHub at https://github.com/blockchaintech-au/bctlogger.

data/Rakefile

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

data/bctlogger.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bctlogger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bctlogger"
+  spec.version       = Bctlogger::VERSION
+  spec.authors       = ["Long Sun"]
+  spec.email         = ["long.sun@blockchaintech.net.au"]
+
+  spec.summary       = %q{Blockchain Tech json log formatter}
+  spec.description   = %q{A log formatter for Kibana}
+  spec.homepage      = "https://github.com/blockchaintech-au/bctlogger"
+
+  # 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'logger'
+module Bctlogger
+  class JsonLogFormatter < ::Logger::Formatter
+    def call(severity, _time, _progname, msg)
+      extra_log_data(msg).merge(
+        "level": severity.downcase,
+        "project": ENV['PROJECT'],
+        "environment": ENV['ENVIRONMENT'],
+        "application": ENV['APP_NAME'],
+        "datetime": Time.now
+      ).to_json + "\r\n"
+    end
+
+    private
+
+    def extra_log_data(msg)
+      if msg.is_a? Hash
+        msg
+      elsif msg.is_a? Exception
+        { "message": msg.message, "backtrace": msg.backtrace }
+      else
+        { "message": msg }
+      end
+    end
+  end
+end

data/lib/bctlogger/version.rb

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

data/lib/bctlogger.rb

@@ -0,0 +1,2 @@
+require 'bctlogger/version'
+require 'bctlogger/json_log_formatter'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: bctlogger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Long Sun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: A log formatter for Kibana
+email:
+- long.sun@blockchaintech.net.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bctlogger.gemspec
+- bin/console
+- bin/setup
+- lib/bctlogger.rb
+- lib/bctlogger/json_log_formatter.rb
+- lib/bctlogger/version.rb
+homepage: https://github.com/blockchaintech-au/bctlogger
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Blockchain Tech json log formatter
+test_files: []