cbdr-logfmtr 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 810661cfa6c9c009628813acaa174a03f4703f65
+  data.tar.gz: 5db2ee395510cf26527155ad24c9817d60eeb06f
+SHA512:
+  metadata.gz: d274de19da8f342d182618953c105d6cc63d6d5caaa81b433e0b048b27323affc81105a498668501094460578ab336d3b446b3b0e808ed335692cfc6e6a2f013
+  data.tar.gz: 3cf75ae94f4d34a0c9783eb7b82a3e2dd12b7573a7ddd2a1cadfc58778a5bfea41cd250c2a641fdeacc8220995343dba65ce27ba11f1a49658ce9487b438c703

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'bundler'
+
+gemspec

data/README.md

@@ -0,0 +1,67 @@
+# logfmtr
+The default ruby logger (`require 'logger'`) outputs in this format:
+```
+I, [2015-07-01T11:47:45.157173 #29367]  INFO -- : some message here (StandardError)
+```
+This provides a replacement for the default Logger::Formatter class, and it formats logs in key=value format.
+
+Logs a hash as:
+```
+{ one: 1, two: 2 } => one=1 two=2
+```
+Everything else as:
+```
+=> msg="your message here"
+```
+## Usage
+### Example logging error
+Errors have their own `.to_s` implementation.
+```ruby
+require 'logger'
+require 'cbdr-logfmtr'
+
+logger = Logger.new($stdout)
+logger.formatter = Logfmtr::LogfmtLogger.new
+
+begin
+  raise StandardError.new('some output')
+rescue => e
+  logger.error e
+end
+
+# output
+# level=ERROR datetime="2015-07-01 08:29:52" -0500 progname= msg="some output"
+```
+### Example logging error with a custom datetime format
+```ruby
+require 'logger'
+require 'cbdr-logfmtr'
+
+logger = Logger.new($stdout)
+logger.formatter = Logfmtr::LogfmtLogger.new("%Y-%m-%d %H:%M %Z")
+
+begin
+  raise StandardError.new('some output')
+rescue => e
+  logger.error e
+end
+
+# output
+# level=ERROR datetime="2015-07-01 08:29 CDT" progname= msg="some output"
+```
+### Example logging hash
+It pulls out hash values into their own key=value pairs in logfmt.
+```ruby
+require 'logger'
+require 'cbdr-logfmtr'
+
+logger = Logger.new($stdout)
+logger.formatter = Logfmtr::LogfmtLogger.new
+
+logger.info({ one: 1, two: 2 })
+
+# output
+# level=INFO datetime="2015-07-01 08:29 CDT" progname= one=1 two=2
+```
+### Note about datetime_format
+The default datetime_format in Logger::Formatter appears to be `"%Y-%m-%d %H:%M:%S %z"`. When you set your `logger.datetime_format=`, it does not get used by the formatter class. Logger::Formatter appears to have its own default. This gem makes that explicit.

data/Rakefile

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

data/lib/cbdr-logfmtr.rb

@@ -0,0 +1 @@
+require 'logfmtr/base'

data/lib/logfmtr/base.rb

@@ -0,0 +1,47 @@
+module Logfmtr
+  class LogfmtLogger
+    def initialize(datetime_format=nil)
+      @datetime_format = datetime_format || "%Y-%m-%d %H:%M:%S %z"
+    end
+
+    def call(severity, datetime, progname, msg)
+      if msg.is_a? Hash
+        msg_str = logfmtify_hash(msg)
+      else
+        msg = add_quotes(escape_newlines(msg))
+        msg_str = %Q[msg=#{msg}]
+      end
+
+      %Q[level=#{severity} datetime="#{datetime.strftime(@datetime_format)}" progname=#{progname} #{msg_str}\n]
+    end
+
+    private
+
+    def logfmtify_hash(message)
+      message.collect do |key, value|
+        value = add_quotes(escape_newlines(value))
+        %Q[#{key}=#{value}]
+      end.join(' ')
+    end
+
+    def add_quotes(message)
+      if needs_quotes(message)
+        %Q["#{message}"]
+      else
+        %Q[#{message}]
+      end
+    end
+
+    def needs_quotes(message)
+      if message.to_s =~ /[^a-zA-Z0-9\-\.]/
+        true
+      else
+        false
+      end
+    end
+
+    def escape_newlines(message)
+      message.to_s.gsub(/\n/, "\\n")
+    end
+  end
+end

data/lib/logfmtr/version.rb

@@ -0,0 +1,3 @@
+module Logfmtr
+  VERSION = "0.0.4"
+end

data/logfmtr.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require "logfmtr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cbdr-logfmtr"
+  s.version     = Logfmtr::VERSION
+  s.licenses    = ['WTFPL']
+  s.platform    = Gem::Platform::RUBY
+  s.date        = %q{2015-09-25}
+  s.authors     = ['Archana Sriram', 'Steven Thomas']
+  s.email       = 'creativehandle@gmail.com'
+  s.homepage    = "https://github.com/cbdr/logfmtr"
+  s.summary     = %q{a replacement for Logger::Formatter}
+  s.description = %q{for formatting logs in logfmt}
+
+  s.add_dependency "rake", "~> 10.4"
+  s.add_development_dependency "rspec", "~> 3.3"
+  s.add_development_dependency 'logfmt', '~> 0.0.7'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/spec/lib/logfmtr_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'logger'
+require 'logfmt'
+require 'stringio'
+
+describe Logfmtr::LogfmtLogger do
+  it "exists" do
+    logfmtr = Logfmtr::LogfmtLogger.new
+    expect(logfmtr).to be
+  end
+
+  it "logs using default datetime format" do
+    dt_format = default_datetime_format
+    expect { log_error(nil) }.to output(%Q[level=ERROR datetime="#{Time.now.strftime(dt_format)}" progname= msg="some output"\n]).to_stdout
+  end
+
+  it "logs using custom datetime format" do
+    dt_format = custom_datetime_format
+    expect { log_error(dt_format) }.to output(%Q[level=ERROR datetime="#{Time.now.strftime(dt_format)}" progname= msg="some output"\n]).to_stdout
+  end
+
+  it "logs hashes basically" do
+    dt_format = default_datetime_format
+    expect { log_hash(dt_format) }.to output(%Q[level=INFO datetime="#{Time.now.strftime(dt_format)}" progname= one=1 two=2 three="!@#$$%^&*}"\n]).to_stdout
+  end
+
+  it "logs hashes in logfmt format" do
+    dt_format = default_datetime_format
+
+    output = log_to_buffer do |logger|
+      logger.formatter = Logfmtr::LogfmtLogger.new(dt_format)
+      logHash = { :foo => "bar", :baz => "hello world" }
+      logger.info logHash
+    end
+
+    expectedHash = {"level" => "INFO", "foo" => "bar", "baz" => "hello world"}
+    actualHash = Logfmt.parse output
+    expect(actualHash).to include(expectedHash)
+  end
+
+  it "puts quotes around values that need them" do
+    dt_format = default_datetime_format
+    expect { log_quotes_needed(dt_format) }.to output(%Q[level=INFO datetime="#{Time.now.strftime(dt_format)}" progname= msg="Testing some /stuff"\n]).to_stdout
+  end
+
+  it "escapes new lines in values" do
+    dt_format = default_datetime_format
+    expect { escape_newlines_needed(dt_format) }.to output(%Q[level=INFO datetime="#{Time.now.strftime(dt_format)}" progname= msg="Testing some\\nstuff"\n]).to_stdout
+  end
+end
+
+def custom_datetime_format
+  "%Y-%m-%d %H:%M %z"
+end
+
+def default_datetime_format
+  "%Y-%m-%d %H:%M:%S %z"
+end
+
+def log_to_buffer
+  buffer = StringIO.new
+  logger = Logger.new buffer
+  yield logger
+  buffer.string
+end
+
+def log_error(datetime_format)
+  begin
+    logger = logger_init(datetime_format)
+    raise StandardError.new('some output')
+  rescue => e
+    logger.error e
+  end
+end
+
+def log_hash(datetime_format)
+  logger = logger_init(datetime_format)
+  logger.info ({ one: 1, two: 2, three: "!@#$$%^&*}" })
+end
+
+def log_quotes_needed(datetime_format)
+  logger = logger_init(datetime_format)
+  logger.info ("Testing some /stuff")
+end
+
+def escape_newlines_needed(datetime_format)
+  logger = logger_init(datetime_format)
+  logger.info ("Testing some\nstuff")
+end
+
+def logger_init(datetime_format)
+  logger = Logger.new($stdout)
+  logger.formatter = Logfmtr::LogfmtLogger.new(datetime_format)
+  logger
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'cbdr-logfmtr'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cbdr-logfmtr
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Archana Sriram
+- Steven Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: logfmt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+description: for formatting logs in logfmt
+email: creativehandle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/cbdr-logfmtr.rb
+- lib/logfmtr/base.rb
+- lib/logfmtr/version.rb
+- logfmtr.gemspec
+- spec/lib/logfmtr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cbdr/logfmtr
+licenses:
+- WTFPL
+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.4.6
+signing_key: 
+specification_version: 4
+summary: a replacement for Logger::Formatter
+test_files:
+- spec/lib/logfmtr_spec.rb
+- spec/spec_helper.rb