simple_structured_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 315fe583360fe762860bf5b41c12ddd9b253759e
+  data.tar.gz: 27a68f4612e092dc60d297529f3ee421e4c21667
+SHA512:
+  metadata.gz: 91459af84ce0e26f4a3883effa6fe307de46c8591bf77815667fa7e8b98d267425e84683923b10a38649108ac30efc5321edb861b6b34a067c97dadf16caf3b8
+  data.tar.gz: 8508a7487d73be951791e1e6859f3b10d0859dade862fd434301eaa37034a4d4ec9837e33f29205ef3c873588fe0532b6951cd0ae7a2b402a9ad927082646a88

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_structured_logger.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# SimpleStructuredLogger
+
+Dead-simple structured logging in ruby with a dead-simple codebase. That's it.
+
+```ruby
+gem 'simple_structured_logger'
+```
+
+## Design Goals
+
+* Extremely simple codebase that's easy to read and override
+* Structured logging that reads nicely
+* Ability to easily set context, and expand context with user-configurable hook
+* Ability to easily add structured log pre-processing. I want to be able to pass
+  in an object specific to my application and for the relavent important keys to
+  be expanded automatically.
+* `Rails.logger = SimpleStructuredLogger.new(STDOUT)`
+* Not designed around massive systems or scale
+* Don't support multiple log destinations
+* Don't build in fancy pre-processing for errors or other common ruby objects
+
+### Opinionated Devops Setup
+
+* Errors are tracked using Rollbar, Airbrake, Sentry, etc.
+* Log to STDOUT
+* Pipe STDOUT to PaperTrail, Loggly, etc
+* Great for Heroku or [dokku/docker](http://mikebian.co/sending-dokku-container-logs-to-papertrail/) hosted system
+
+## Alternatives
+
+* https://github.com/jordansissel/ruby-cabin
+* https://github.com/asenchi/scrolls
+* https://github.com/stripe/chalk-log
+* https://github.com/nishidayuya/structured_logger
+
+## Why is structured logging important?
+
+* https://engineering.linkedin.com/distributed-systems/log-what-every-software-engineer-should-know-about-real-time-datas-unifying
+* http://juliusdavies.ca/logging.html
+
+## What about Rail's tagged logging?
+
+Tagged logging is not structured logging. I want to be able to search through
+PaperTrail and easily grab an audit trail for a specific context, i.e. `the_job=FailingJob the_user=1`.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Testing
+
+```
+bundle exec rake
+```

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/bin/console

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

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/simple_structured_logger.rb

@@ -0,0 +1,86 @@
+require 'logger'
+
+module SimpleStructuredLogger
+  def log
+    SimpleStructuredLogger::Writer.instance
+  end
+
+  def self.included(klass)
+
+    # TODO there's got to be a cleaner way to add a class method from `include`
+    klass.class_eval do
+      def self.log
+        SimpleStructuredLogger::Writer.instance
+      end
+    end
+
+  end
+
+  module Configuration
+    extend self
+
+    def expand_context(&block)
+      if block.nil?
+        @expand_context = block
+      else
+        @expand_context
+      end
+    end
+
+    def expand_log(&block)
+      if block.nil?
+        @expand_log = block
+      else
+        @expand_log
+      end
+    end
+  end
+
+  class Writer
+    include Singleton
+
+    attr_reader :default_tags
+
+    def initialize
+      @l = ::Logger.new(STDOUT)
+      @default_tags = {}
+    end
+
+    def reset_context!
+      @default_tags = {}
+    end
+
+    def set_context(context)
+      reset_context!
+
+      @default_tags.merge!(context)
+    end
+
+    def error(msg, opts={})
+      @l.error("#{msg}: #{stringify_tags(opts)}")
+    end
+
+    def info(msg, opts={})
+      @l.info("#{msg}: #{stringify_tags(opts)}")
+    end
+
+    def debug(msg, opts={})
+      @l.debug("#{msg}: #{stringify_tags(opts)}")
+    end
+
+    def warn(msg, opts={})
+      @l.warn("#{msg}: #{stringify_tags(opts)}")
+    end
+
+    private
+
+      def stringify_tags(additional_tags)
+        additional_tags = additional_tags.dup
+
+        # TODO expand
+
+        @default_tags.merge(additional_tags).map { |k,v| "#{k}=#{v}" }.join(' ')
+      end
+
+  end
+end

data/simple_structured_logger.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_structured_logger"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Michael Bianco"]
+  spec.email         = ["mike@cliffsidemedia.com"]
+
+  spec.summary       = "Dead-simple structured logging in ruby with a dead-simple codebase."
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/iloveitaly/simple_structured_logger"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: simple_structured_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bianco
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: 
+email:
+- mike@cliffsidemedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_structured_logger.rb
+- simple_structured_logger.gemspec
+homepage: https://github.com/iloveitaly/simple_structured_logger
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Dead-simple structured logging in ruby with a dead-simple codebase.
+test_files: []