slog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6281566b29155ca25d47ffda05399f95087c368
+  data.tar.gz: c10525a3d80f1a8d8f77aef31f84328472e1d505
+SHA512:
+  metadata.gz: 7cbfa8a4d518fe83543b90cd8260b7be6d633630f5be17fb2ac9c3bd1686cd5c5bbee917d4204b16ed1f76e142f44f7991bf3bf4af867546af6b31c6a5f07e4f
+  data.tar.gz: ef037550aebd01bffd8a814879031da6007b18046793a5493ea6dc28e92c82399bedf076ba671e67d9e366e56828e2cb80a4f6c66285fb3e269fbf4c68d04f5e

data/.gitignore

@@ -0,0 +1,12 @@
+*~
+*.gem
+*.log
+*.out
+*.pid
+*.swp
+.DS_Store
+.yardoc
+doc
+pkg
+cov
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,52 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/EmptyLines:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/TrailingBlankLines:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/SpaceBeforeSemicolon:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'rake'
+  gem 'yard'
+  gem 'version'
+  gem 'rubygems-tasks'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'simplecov'
+  gem 'rubocop'
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2014 Sean Clemmer
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Slog
+
+Simple, colorful, JSON-based logging.
+
+## Installation
+
+Add `slog` to your application's Gemspec or Gemfile.
+
+## Usage
+
+`Slog::Logger` extends the base `Logger` with JSON serialization, colorization,
+a hashified initializer, and a new `TRACE` level:
+
+```ruby
+require 'slog'
+
+# First, these two are equivalent
+logger_one = Slog::Logger.new
+logger_two = Slog.new
+
+# Redirect your logs to STDERR
+Slog.new out: $stderr
+
+# Set the level with a symbol or Logger constant
+Slog.new level: :trace
+
+# When logging to file, you may want to disable colors and pretty output
+Slog.new out: 'test.log', colorization: false, pretty: false
+
+# Finally, all the options and their defaults
+Slog.new \
+         out: $stdout,   # Set the log output handle
+   shift_age: 7,         # Number of log files to keey
+  shift_size: 1_048_576, # Maximum size of log files
+    colorize: true,      # Toggle colorization of logs
+      pretty: true,      # Toggle pretty JSON output
+       level: :info      # Set the initial level
+```

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler'
+require 'rake'
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test*.rb']
+  test.verbose = true
+end
+
+task default: :test
+
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w[ --readme Readme.md lib/**/*.rb - VERSION ]
+end
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new push: true, sign: {} do |tasks|
+  tasks.console.command = 'pry'
+end
+Gem::Tasks::Sign::Checksum.new sha2: true
+
+
+require 'rake/version_task'
+Rake::VersionTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/slog/logger.rb

@@ -0,0 +1,105 @@
+require 'logger'
+require 'time'
+require 'json'
+
+require 'colorize'
+
+
+# Extending the base Logger class with TRACE capabilities.
+class Logger
+
+  # Adding the new severity level
+  SEV_LABEL << 'TRACE'
+
+  # So we can reference it by name
+  TRACE = SEV_LABEL.index('TRACE')
+
+  # Send a TRACE-level log line
+  def trace progname, &block
+    return true unless @trace
+    add TRACE, nil, progname, &block
+  end
+
+end
+
+
+
+module Slog
+
+  # A colorful JSON logger.
+  class Logger < Logger
+
+    DEFAULT_LEVEL = ::Logger::INFO
+
+    # Maps each log level to a unique combination of fore- and background colors
+    SEVERITY_COLORS = {
+      'debug' => [ :blue,    :default ],
+      'info'  => [ :green,   :default ],
+      'warn'  => [ :yellow,  :default ],
+      'error' => [ :red,     :default ],
+      'fatal' => [ :red,     :black   ],
+      'trace' => [ :magenta, :default ]
+    }
+
+
+    # Create a new Logger.
+    #
+    # A little different than the canonical Logger. Add options to set the
+    # log level and todisable both colorization and pretty JSON output.
+    def initialize out:$stdout, shift_age:7, shift_size:1048576, colorize:true, pretty:true, level:DEFAULT_LEVEL
+      @colorize, @pretty = colorize, pretty
+      super out, shift_age, shift_size
+      self.level = level
+      set_formatter
+    end
+
+
+    # Set the formatter to work our magic
+    def set_formatter
+      self.formatter = proc do |severity, datetime, _, message|
+        severity.downcase! # It's nicer this way
+
+        # If it ain't a structured log, it is now.
+        event = structure_event severity, datetime, message
+
+        # When debugging, mark the location in Hoss's source
+        unless level == DEFAULT_LEVEL
+          event.merge! marker: File.basename(caller[4])
+        end
+
+        # Pretty JSON on STDOUT, line-oriented otherwise
+        format_json event, severity
+      end
+    end
+
+
+    # Turn a call to the formatter into a Hash structure
+    def structure_event severity, datetime, message
+      message = { message: message } unless message.is_a? Hash
+      { 'level' => severity,
+        '@timestamp' => datetime.iso8601(3) # Logstash/Franz format
+      }.merge message
+    end
+
+
+    # Convert the structured event into it's JSON representation
+    def format_json event, severity
+      generator = @pretty ? :pretty_generate : :generate
+      event = JSON.send(generator, event) + "\n"
+      return event unless @colorize
+      event.colorize \
+          color: SEVERITY_COLORS[severity][0],
+          background: SEVERITY_COLORS[severity][1]
+    end
+
+
+    # Override the level setter to allow symbols and TRACE
+    def level= l
+      l = ::Logger.const_get l.upcase if l.is_a? Symbol
+      @trace = l == ::Logger::TRACE
+      l = ::Logger::DEBUG if @trace
+      super l
+    end
+
+  end
+end

data/lib/slog/metadata.rb

@@ -0,0 +1,25 @@
+# Everything you wanted to know about the big Slog.
+module Slog
+
+  # Point to actual gem location
+  ROOT     = File.join File.dirname(__FILE__), '..', '..'
+
+  # We use a VERSION file to tie into our build pipeline
+  VERSION  = File.read(File.join(ROOT, 'VERSION')).strip
+
+  # We don't really do all that much, be humble
+  SUMMARY  = 'Simple, colorful, JSON-based logging'
+
+  # Your benevolent dictator for life
+  AUTHOR   = 'Sean Clemmer'
+
+  # Turn here to strangle your dictator
+  EMAIL    = 'sczizzo@gmail.com'
+
+  # Like the MIT license, but even simpler
+  LICENSE  = 'ISC'
+
+  # If you really just can't get enough
+  HOMEPAGE = 'https://github.com/sczizzo/slog'
+
+end

data/lib/slog.rb

@@ -0,0 +1,7 @@
+require_relative 'slog/logger'
+
+module Slog
+  def self.new *opts
+    Logger.new *opts
+  end
+end

data/slog.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path(File.join('..', 'lib'), __FILE__)
+require 'slog/metadata'
+
+Gem::Specification.new do |s|
+  s.name        = 'slog'
+  s.version     = Slog::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = Slog::AUTHOR
+  s.email       = Slog::EMAIL
+  s.license     = Slog::LICENSE
+  s.homepage    = Slog::HOMEPAGE
+  s.summary     = Slog::SUMMARY
+  s.description = Slog::SUMMARY + '.'
+
+  s.add_runtime_dependency 'colorize', '~> 0'
+
+  s.require_paths = %w[ lib ]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start do
+  coverage_dir 'cov'
+end
+
+require 'rubocop'
+RuboCop::CLI.new.run

data/test/test_slog.rb

@@ -0,0 +1,61 @@
+require_relative 'test_helper'
+
+require 'thread'
+require 'tmpdir'
+require 'tempfile'
+require 'fileutils'
+require 'pathname'
+require 'minitest/autorun'
+
+require 'slog'
+
+
+Thread.abort_on_exception = true
+
+
+
+# Mostly for coverage, testing the utility functions.
+class TestSlog < MiniTest::Test
+
+  attr_reader :tmpdir, :logger
+
+
+  def setup
+    @tmpdir = Dir.mktmpdir
+    @logger = Slog::Logger.new colorize: false, out: $stderr
+    @logger.level = ::Logger::WARN
+  end
+
+
+  def teardown
+    FileUtils.rm_rf tmpdir
+  end
+
+
+  def test_slog_logger_structure_event now=DateTime.now
+    expected_event = {
+      'level' => 'info',
+      '@timestamp' => now.iso8601(3)
+    }
+    assert expected_event, logger.structure_event('info', now, {})
+  end
+
+
+  def test_slog_logger_format_json
+    assert "{}\n", logger.format_json({}, 'info')
+  end
+
+
+  def test_slog_logger_formatter now=DateTime.now
+    event = {
+      'level' => 'info',
+      '@timestamp' => now.iso8601(3)
+    }
+    expected_output = JSON.pretty_generate(event) + "\n"
+    assert expected_output, logger.formatter.call('INFO', now, nil, {})
+  end
+
+  def test_slog_logger
+    assert logger.info({})
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: slog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sean Clemmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: Simple, colorful, JSON-based logging.
+email: sczizzo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/slog.rb
+- lib/slog/logger.rb
+- lib/slog/metadata.rb
+- slog.gemspec
+- test/test_helper.rb
+- test/test_slog.rb
+homepage: https://github.com/sczizzo/slog
+licenses:
+- ISC
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple, colorful, JSON-based logging
+test_files:
+- test/test_helper.rb
+- test/test_slog.rb