better_log_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3f44ee8af1a96ddddea0cc3d888845901cef7a7
+  data.tar.gz: f1ffe485b3bf5db84d3d24097cad7a9b78d97e3c
+SHA512:
+  metadata.gz: b85a989e39b8d2348988e2da43a81881c128a801144af8177739fee376d44a169ef016df6aeee67e518748d6e4c5674a1d2d64009879d848e1328c4b10def878
+  data.tar.gz: 879733a3ed579c02f1a50f8ca233e46eb78054074d905de1def9d099da5d307b5ad8ead9bc5b20c437ac90e12a244f98d032e22b750e7c8eb6b0cfc3156733c6

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.3

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 better_log_formatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sébastien Puyet
+
+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,30 @@
+# Better Log Formatter
+A formatter allowing you to add dynamic tags to your logs with sidekiq tags support
+
+## Usage
+
+```ruby
+logger = Logger.new(STDOUT)
+formatter = BetterLogFormatter.new("my_app")
+formatter.custom_tag(:foo) { 'Bar' }
+formatter.custom_tag(:request_id) { Request.id }
+logger.formatter = formatter
+logger.info "Hello world!" # 2018-09-16T12:42:27.843291 my_app[1337][Bar][a776fea1-e24c-4976-b8c4-df790b1aefcb] -- INFO: Hello world!
+```
+
+Also, timestamp can be hidden or removed:
+```ruby
+formatter.datetime_format = "%m/%d/%y - %H:%M:%S "
+logger.info "Hello world!" # 09/16/2018T12:42:27 my_app[1337][Bar][a776fea1-e24c-4976-b8c4-df790b1aefcb] -- INFO: Hello world!
+formatter.datetime_display = false
+logger.info "Hello world!" # my_app[1337][Bar][a776fea1-e24c-4976-b8c4-df790b1aefcb] -- INFO: Hello world!
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/spuyet/better_log_formatter.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/better_log_formatter.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "better_log_formatter"
+
+Gem::Specification.new do |spec|
+  spec.name          = "better_log_formatter"
+  spec.version       = BetterLogFormatter::VERSION
+  spec.authors       = ["Sébastien Puyet"]
+  spec.email         = ["sebastien@puyet.fr"]
+
+  spec.summary       = %q{A better log formatter}
+  spec.homepage      = "https://git.dimelo.com/shared/better_log_formatter"
+  spec.license       = "MIT"
+
+  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 "minitest", "~> 5.0"
+  spec.add_development_dependency "timecop", "~> 0.9"
+end

data/bin/console

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

@@ -0,0 +1,51 @@
+require 'logger'
+
+class BetterLogFormatter < ::Logger::Formatter
+  VERSION = "0.1.0".freeze
+  Format = "%s%s[%d]%s%s -- %s: %s\n".freeze
+
+  attr_accessor :app_name
+  attr_accessor :datetime_display
+
+  def initialize(app_name)
+    @app_name = app_name
+    @datetime = datetime_display
+    super()
+  end
+
+  def call(severity, datetime, _, message)
+    Format % [formatted_datetime(datetime), app_name, $$, custom_tags, sidekiq_tags, severity_label(severity), msg2str(message)]
+  end
+
+  def custom_tag(tag_name, &block)
+    @custom_tags ||= {}
+    @custom_tags[tag_name] = block
+    true
+  end
+
+  private
+
+  def custom_tags
+    @custom_tags ||= {}
+    @custom_tags.map { |_, block| block.call }.compact.map{ |tag| "[#{tag}]" }.join
+  end
+
+  def thread_tag
+    "TID-#{Thread.current.object_id.to_s(36)}"
+  end
+
+  def sidekiq_tags
+    return if Thread.current[:sidekiq_context].nil?
+
+    tags = Thread.current[:sidekiq_context].flat_map(&:split) || []
+    "[#{thread_tag}]#{tags.map { |tag| "[#{tag}]" }.join}"
+  end
+
+  def formatted_datetime(datetime)
+    format_datetime(datetime) if datetime_display
+  end
+
+  def severity_label(severity)
+    severity.is_a?(Fixnum) ? ::Logger::SEV_LABEL[severity] : severity
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: better_log_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sébastien Puyet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-17 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- sebastien@puyet.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- better_log_formatter.gemspec
+- bin/console
+- bin/setup
+- lib/better_log_formatter.rb
+homepage: https://git.dimelo.com/shared/better_log_formatter
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A better log formatter
+test_files: []