ltsv_logger_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65e6dd81c5a9ddb5ea6f6580026457a9cf38caf1
+  data.tar.gz: 1687cbfe364b88189078e9e7c60d612d8fbede47
+SHA512:
+  metadata.gz: 5c9ba867ec9a4c8c8469b834b722ea3c98c42cc24b0a0bd4d76ab82c987cadd7d8f064316fa1e64fb14151b2ce614cf137d0d467b20c5bdd8c05ed9bda2d1bda
+  data.tar.gz: abcfa6406b71b0ffca2758dada6cda5cdecabd9dd9d74863be293a0d8b399f99808a7e4cb0abf03edda4832265a320951c01c9b198667212e99d9d61b0a89a01

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2
+script: rake spec

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 dev.ryu39@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 [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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ryusuke Homma
+
+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,107 @@
+# LtsvLoggerFormatter
+
+[![Build Status](https://travis-ci.org/ryu39/ltsv_logger_formatter.svg?branch=master)](https://travis-ci.org/ryu39/ltsv_logger_formatter)
+
+A simple ruby logger formatter for logging in [LTSV](http://ltsv.org/) format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ltsv_logger_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ltsv_logger_formatter
+
+## Usage
+
+Set your logger formatter and call with hash object.
+
+```ruby
+logger = Logger.new(STDOUT)
+logger.formatter = LtsvLoggerFormatter.new
+
+logger.info({ key: 'val' })
+# => level:INFO      time:2016-10-03T00:27:11.734180 key:val
+logger.info('progname') { { key: 'val' } }
+# => level:INFO      time:2016-10-03T00:27:44.269682 progname:progname       key:val
+```
+
+You can pass String, Exception and Object that can respond to #to_hash.
+
+```ruby
+logger.info 'string'
+# => level:INFO      time:2016-10-03T00:37:39.950529 message:string
+
+begin
+  raise RuntimeError.new('error')
+rescue => e
+  logger.error e
+end
+# => level:ERROR     time:2016-10-03T00:38:52.815406 message:error   class:RuntimeError      backtrace:(irb):16:in `irb_binding'\n...snip...`<main>'
+
+object = Object.new
+def object.to_hash
+  { key: 'val' }
+end
+logger.info object
+# => level:INFO      time:2016-10-03T00:43:52.458565 key:val
+```
+
+### Datetime Format ###
+
+You can specify datetime format for time.
+
+```ruby
+logger.formatter = LtsvLoggerFormatter.new(datetime_format: '%Y%m%d %H%M%S')
+
+logger.info({ key: 'val' })
+# => level:INFO      time:20161003 003139    key:val=> true
+```
+
+### Key name ###
+
+You can change the following key name.
+
+* level
+* time
+* progname
+
+```ruby
+logger.formatter = LtsvLoggerFormatter.new(severity_key: :test1, time_key: :test2, progname_key: :test3)
+logger.info('progname') { { key: 'val' } }
+# => test1:INFO      test2:2016-10-03T00:45:52.073456        test3:progname  key:val
+```
+
+## Dependency
+
+This gem uses [LTSV gem](https://github.com/condor/ltsv/blob/master/ltsv.gemspec).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+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/ryu39/ltsv_logger_formatter.
+This project is intended to be a safe, welcoming space for collaboration, 
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ltsv_logger_formatter"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/ltsv_logger_formatter/version.rb

@@ -0,0 +1,5 @@
+require 'logger'
+
+class LtsvLoggerFormatter < Logger::Formatter
+  VERSION = '0.1.0'
+end

data/lib/ltsv_logger_formatter.rb

@@ -0,0 +1,55 @@
+require 'logger'
+require 'ltsv'
+require 'ltsv_logger_formatter/version'
+
+class LtsvLoggerFormatter < ::Logger::Formatter
+  attr_accessor :severity_key, :time_key, :progname_key
+
+  # Initialize formatter.
+  #
+  # @param [String] datetime_format Optional, datetime format string. Default is '%Y-%m-%dT%H:%M:%S.%6N'.
+  # @param [Symbol] severity_key Optional, key for severity. Default is :level.
+  # @param [Symbol] time_key Optional, key for time. Default is :time.
+  # @param [Symbol] progname_key Optional, key for progname. Default is :progname.
+  def initialize(datetime_format: '%Y-%m-%dT%H:%M:%S.%6N',
+                 severity_key: :level, time_key: :time, progname_key: :progname)
+    super()
+    self.datetime_format = datetime_format
+    @severity_key = severity_key
+    @time_key = time_key
+    @progname_key = progname_key
+  end
+
+  # Return formatted string using arguments.
+  #
+  # This method is expected to call by ::Logger
+  #
+  # @param [String] severity
+  # @param [Time] time
+  # @param [String] progname
+  # @param [Hash, String, Exception, Object] data Data for logging,
+  #   Hash, String, Exception or Object respond_to :to_hash can be used.
+  def call(severity, time, progname, data)
+    log_data = { @severity_key => severity, @time_key => format_datetime(time) }
+    if progname
+      log_data.merge!( @progname_key => progname )
+    end
+    log_data.merge!(format_data(data))
+    ::LTSV.dump(log_data)
+  end
+
+  private
+
+  def format_data(data)
+    case data
+    when Hash
+      data
+    when String
+      { message: data }
+    when Exception
+      { message: data.message, class: data.class, backtrace: (data.backtrace || []).join("\\n") } # \n cannot be used in LTSV, so use \\n in backtrace.
+    else
+      data.to_hash
+    end
+  end
+end

data/ltsv_logger_formatter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ltsv_logger_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ltsv_logger_formatter'
+  spec.version       = LtsvLoggerFormatter::VERSION
+  spec.authors       = ['ryu39']
+  spec.email         = ['dev.ryu39@gmail.com']
+
+  spec.summary       = %q{A simple logger formatter for logging in ltsv format.}
+  spec.description   = %q{A simple logger formatter for logging in ltsv format.}
+  spec.homepage      = 'https://github.com/ryu39/ltsv_logger_formatter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency 'ltsv'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: ltsv_logger_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryu39
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ltsv
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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 simple logger formatter for logging in ltsv format.
+email:
+- dev.ryu39@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ltsv_logger_formatter.rb
+- lib/ltsv_logger_formatter/version.rb
+- ltsv_logger_formatter.gemspec
+homepage: https://github.com/ryu39/ltsv_logger_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.6.7
+signing_key: 
+specification_version: 4
+summary: A simple logger formatter for logging in ltsv format.
+test_files: []