logstuff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 874141089c82cc738dfed4a5d9911b671a5f0a19
+  data.tar.gz: bddd43af5b4283c869a69a9d850df5e316efb62f
+SHA512:
+  metadata.gz: af64bc04db1aabb44b3659db7a44f2d800468fe5db9f6e5a7f63001e5b7e5308b662ea488b9bc6c12ad94bd0d56457af3835a044917154e2fa5a71dfc6bea752
+  data.tar.gz: ce26e32e3164061f7853f7d36de9c518ce60e02a556e2076518d79f8e1be3bbad90efdb631d06e1b07711b1a3f93d90b11ac67467c6549dcfbb72dcd85c0e2f4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+gemspec
+
+group :test do
+  gem 'growl'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rails', "~> #{ENV["RAILS_VERSION"] || "3.2.0"}"
+  gem 'rb-fsevent', '~> 0.9'
+  gem 'rcov', :platforms => :mri_18
+  gem 'redis', :require => false
+  gem 'simplecov', :platforms => :mri_19, :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Paul Rhodes
+
+MIT License
+
+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,101 @@
+# Logstuff
+
+Logstuff is a rubygem for writing application logs in a more structured form.
+
+It will output the logs in JSON format to allow collection from logstash/beaver
+or equivalent into a central logging store such as elasticsearch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logstuff'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logstuff
+
+## Usage
+
+The example IRB session below shows examples of the usage of LogStuff and the associated JSON output generated.
+
+   ```ruby
+   # Setup LogStuff to output to STDOUT
+   2.1.2 :001 > LogStuff.setup(:logger => LogStuff.new_logger(STDOUT, Logger::INFO))
+    => true
+
+   # Simple basic logging message
+   2.1.2 :002 > LogStuff.info { "Test message" }
+   {"@source":"logstuff","@tags":[],"@fields":{},"@severity":"info","message":"Test message","@timestamp":"2014-10-20T08:41:36.950904+00:00"}
+    => 139
+
+   # Basic logging with additional tags for categorising messages
+   2.1.2 :004 > LogStuff.info(:mail,:deliver) { "Test message" }
+   {"@source":"logstuff","@tags":["mail","deliver"],"@fields":{},"@severity":"info","message":"Test message","@timestamp":"2014-10-20T08:42:07.589854+00:00"}
+    => 155
+
+   # Basic logging with additional key/value pairs specified for inclusion in the @fields structure
+   2.1.2 :008 > LogStuff.info(:key1 => '1234', :key2 => '5678') { "Test message" }
+   {"@source":"logstuff","@tags":[],"@fields":{"key1":"1234","key2":"5678"},"@severity":"info","message":"Test message","@timestamp":"2014-10-20T08:43:04.035798+00:00"}
+    => 166
+
+   # Using with tag method allows all log messages within the block to inherit those tags
+   2.1.2 :009 > LogStuff.tag(:tag1) do
+   2.1.2 :010 >     LogStuff.info { "A different log message" }
+   2.1.2 :011?>   end
+    {"@source":"logstuff","@tags":["tag1"],"@fields":{},"@severity":"info","message":"A different log message","@timestamp":"2014-10-20T08:44:06.329569+00:00"}
+     => #<Set: {}>
+
+   # The same can be achieved with the metadata method
+   2.1.2 :012 > LogStuff.metadata(:request_id => '345') do
+   2.1.2 :013 >     LogStuff.info { "A different log message" }
+   2.1.2 :014?>   end
+   {"@source":"logstuff","@tags":[],"@fields":{"request_id":"345"},"@severity":"info","message":"A different log message","@timestamp":"2014-10-20T08:44:47.688320+00:00"}
+    => {}
+   ```
+
+## Configuring for use with Rails
+
+To use with Rails first create a new logger and then pass that logger into LogStuff.setup. It is necessary
+to use a wrapping function around to Logger.new to ensure that the autogenerated comment does not appear
+at the top of the generated log file which is non-json and will confuse logstash/beaver.
+
+   ```ruby
+   # Custom Logging
+   jsonlogger = LogStuff.new_logger("#{Rails.root}/log/output.json", Logger::INFO)
+   LogStuff.setup(:logger => jsonlogger)
+   ```
+
+
+Often you might wish to use this library in conjunction with the logstasher gem for encapsulating request
+logs and exceptions. The following block can be used to enable both gems and allow them to reuse a common
+logger.
+
+   ```ruby
+   # Custom Logging
+   jsonlogger = LogStuff.new_logger("#{Rails.root}/log/output.json", Logger::INFO)
+
+   config.log_level = :info
+   config.logstasher.enabled = true
+   config.logstasher.suppress_app_log = false
+   config.logstasher.logger = jsonlogger
+   # Need to specifically set the logstasher loglevel since it will overwrite the one set earlier
+   config.logstasher.log_level = Logger::INFO
+   config.logstasher.source = 'logstasher'
+
+   # Reuse logstasher logger with logstuff
+   LogStuff.setup(:logger => jsonlogger)
+   ```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/withnale/logstuff/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,51 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+# Add default task. When you type just rake command this would run. Travis CI runs this. Making this run spec
+desc 'Default: run specs.'
+task :default => :spec
+
+# Defining spec task for running spec
+desc "Run specs"
+RSpec::Core::RakeTask.new('spec') do |spec|
+  # Pattern filr for spec files to run. This is default btw.
+  spec.pattern = "./spec/**/*_spec.rb"
+end
+
+# Run the rdoc task to generate rdocs for this gem
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  require "logstuff/version"
+  version = Logstuff::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "logstuff #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Code coverage tasks. Different for Ruby 1.8 vs 1.9
+if RUBY_VERSION =~ /^1\.8/
+  # Ruby 1.8 uses rcov for code coverage
+  RSpec::Core::RakeTask.new(:coverage) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov = true
+    spec.rcov_opts = %w{--exclude pkg\/,spec\/,features\/}
+  end
+else
+  # Ruby 1.9+ using simplecov. Note: Simplecov config defined in spec_helper
+  desc "Code coverage detail"
+  task :coverage do
+    ENV['COVERAGE'] = "true"
+    Rake::Task['spec'].execute
+  end
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'logger'
+  require 'logstuff'
+  ARGV.clear
+  IRB.start
+end

data/lib/logstuff/version.rb

@@ -0,0 +1,3 @@
+module Logstuff
+  VERSION = "0.0.1"
+end

data/lib/logstuff.rb

@@ -0,0 +1,115 @@
+require "logstuff/version"
+
+
+require 'thread'
+
+module LogStuff
+  extend self
+
+  attr_accessor :logger_path
+  attr_accessor :logger, :source
+
+  NAMESPACE = :log
+
+
+  def get_thread_current(name)
+    Thread.current[NAMESPACE] ||= {
+        :current_fields => {},
+        :current_tags   => Set.new
+    }
+    Thread.current[NAMESPACE][name].dup
+  end
+
+
+  def set_thread_current(name, value)
+    Thread.current[NAMESPACE]       ||= {
+        :current_fields => {},
+        :current_tags   => Set.new
+    }
+    Thread.current[NAMESPACE][name] = value.dup
+  end
+
+
+  def self.log(severity = 'info', *args, &block)
+
+    return unless block_given?
+
+    # Ignore if we are not logging this severity
+    return unless logger.send("#{severity}?")
+
+    local_fields = {}
+    local_tags   = Set.new
+    args.each do |arg|
+      case arg
+        when Hash
+          local_fields.merge!(arg)
+        when Symbol
+          local_tags.add(arg)
+        when Array
+          local_tags.merge(arg)
+      end
+    end
+
+    msg = yield
+
+    event = LogStash::Event.new('@source' => source,
+                                '@severity' => severity,
+                                'message' => msg,
+                                '@tags' => get_thread_current(:current_tags).merge(local_tags).to_a,
+                                '@fields' => get_thread_current(:current_fields).merge(local_fields)
+    )
+    logger << event.to_json + "\n"
+  end
+
+
+  %w( fatal error warn info debug ).each do |severity|
+    eval <<-EOM, nil, __FILE__, __LINE__ + 1
+      def self.#{severity}(*args, &block)
+        self.log(:#{severity}, *args, &block )
+      end
+    EOM
+  end
+
+
+  def tag(*tags, &block)
+    original_tags = get_thread_current(:current_tags)
+    current_tags  = original_tags.dup + tags.flatten
+    set_thread_current(:current_tags, current_tags)
+    yield
+    set_thread_current(:current_tags, original_tags)
+  end
+
+
+  def metadata(*pairs, &block)
+    original_fields = get_thread_current(:current_fields) || {}
+    current_fields  = original_fields.dup
+    pairs.flatten.each do |pair|
+      pair.each do |k, v|
+        current_fields[k.to_sym] = v
+      end
+    end
+    set_thread_current(:current_fields, current_fields)
+    yield
+    set_thread_current(:current_fields, original_fields)
+  end
+
+
+  def setup(params)
+    require 'logstash-event'
+    self.logger_path = params[:path] || "logstuff.json"
+    self.logger = params[:logger] || new_logger(self.logger_path, params[:loglevel])
+    self.source = params[:source] || 'logstuff'
+  end
+
+
+  def new_logger(path, loglevel)
+    if path.class == String
+      FileUtils.touch path # prevent autocreate messages in log
+    end
+    newlogger = Logger.new path
+    newlogger.level = loglevel unless loglevel.nil?
+    newlogger
+  end
+
+
+end

data/logstuff.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logstuff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logstuff"
+  spec.version       = Logstuff::VERSION
+  spec.authors       = ["Paul Rhodes"]
+  spec.email         = ["withnale@users.noreply.github.com"]
+  spec.summary       = %q{Structured Logging for use with Logstash}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'request_store'
+  spec.add_runtime_dependency 'logstash-event', '~> 1.1.0'
+
+  spec.add_development_dependency('rspec', '>= 2.14')
+  spec.add_development_dependency('bundler', '>= 1.0.0')
+  spec.add_development_dependency('rails', '>= 3.0')
+  spec.add_development_dependency "rake"
+end

data/spec/lib/logstuff_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Logstuff do
+
+
+  describe '.log' do
+    let(:logger) { LogStuff.new_logger('tempfile', Logger::INFO) }
+    before do
+      LogStuff.setup(:logger => logger)
+      allow(LogStash::Time).to receive_messages(:now => 'timestamp')
+      allow_message_expectations_on_nil
+    end
+    it 'adds to log with specified level' do
+      #expect(logger).to receive(:send).with('warn?').and_return(true)
+      expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":[],"@fields":{},"@severity":"warn","message":"WARNING","@timestamp":"timestamp"}\n|)
+      LogStuff.log('warn') { 'WARNING' }
+    end
+
+    it 'adds to log with specified level and tags' do
+      #expect(logger).to receive(:send).with('warn?').and_return(true)
+      expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":["tag1","tag2"],"@fields":{},"@severity":"warn","message":"WARNING","@timestamp":"timestamp"}\n|)
+      LogStuff.log('warn', :tag1, :tag2) { 'WARNING' }
+    end
+
+    it 'adds to log with specified level and hash' do
+      #expect(logger).to receive(:send).with('warn?').and_return(true)
+      expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":[],"@fields":{"key1":"value1","key2":"value2"},"@severity":"warn","message":"WARNING","@timestamp":"timestamp"}\n|)
+      LogStuff.log('warn', :key1 => 'value1', :key2 => 'value2') { 'WARNING' }
+    end
+
+  end
+
+  describe ".loglevel" do
+  %w( fatal error warn info debug ).each do |severity|
+    describe ".#{severity}" do
+      let(:message) { "This is a #{severity} message" }
+      let(:logger) { LogStuff.new_logger('tempfile', Logger::DEBUG) }
+      before do
+        LogStuff.setup(:logger => logger)
+        allow(LogStash::Time).to receive_messages(:now => 'timestamp')
+        allow_message_expectations_on_nil
+      end
+      it 'adds to log with specified level' do
+        #expect(logger).to receive(:send).with('warn?').and_return(true)
+        expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":[],"@fields":{},"@severity":"#{severity}","message":"#{message}","@timestamp":"timestamp"}\n|)
+        LogStuff.send(severity) { message }
+      end
+
+      it 'adds to log with specified level and tags' do
+        #expect(logger).to receive(:send).with('warn?').and_return(true)
+        expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":["tag1","tag2"],"@fields":{},"@severity":"#{severity}","message":"#{message}","@timestamp":"timestamp"}\n|)
+        LogStuff.send(severity, :tag1, :tag2) { message }
+      end
+
+      it 'adds to log with specified level and hash' do
+        #expect(logger).to receive(:send).with('warn?').and_return(true)
+        expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":[],"@fields":{"key1":"value1","key2":"value2"},"@severity":"#{severity}","message":"#{message}","@timestamp":"timestamp"}\n|)
+        LogStuff.send(severity, :key1 => 'value1', :key2 => 'value2') { message }
+      end
+    end
+  end
+  end
+
+  describe "block" do
+    let(:severity) { "warn"}
+    let(:message1) { "This is a #{severity} message 1" }
+    let(:message2) { "This is a #{severity} message 2" }
+
+    let(:logger) { LogStuff.new_logger('tempfile', Logger::DEBUG) }
+    before do
+      LogStuff.setup(:logger => logger)
+      allow(LogStash::Time).to receive_messages(:now => 'timestamp')
+      allow_message_expectations_on_nil
+    end
+    it 'adds tags only within a block' do
+      #expect(logger).to receive(:send).with('warn?').and_return(true)
+      expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":["tag1","tag2"],"@fields":{},"@severity":"#{severity}","message":"#{message1}","@timestamp":"timestamp"}\n|)
+      expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":[],"@fields":{},"@severity":"#{severity}","message":"#{message2}","@timestamp":"timestamp"}\n|)
+
+      LogStuff.tag(:tag1, :tag2) do
+        LogStuff.warn { message1 }
+      end
+      LogStuff.warn { message2 }
+    end
+
+    it 'adds fields only within a block' do
+      #expect(logger).to receive(:send).with('warn?').and_return(true)
+      expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":[],"@fields":{"key1":"value1","key2":"value2"},"@severity":"#{severity}","message":"#{message1}","@timestamp":"timestamp"}\n|)
+      expect(logger).to receive(:<<).with(%Q|{"@source":"logstuff","@tags":[],"@fields":{},"@severity":"#{severity}","message":"#{message2}","@timestamp":"timestamp"}\n|)
+
+      LogStuff.metadata(:key1 => 'value1', :key2 => 'value2') do
+        LogStuff.warn { message1 }
+      end
+      LogStuff.warn { message2 }
+    end
+
+  end
+
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# Notice there is a .rspec file in the root folder. It defines rspec arguments
+
+# Ruby 1.9 uses simplecov. The ENV['COVERAGE'] is set when rake coverage is run in ruby 1.9
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    # Remove the spec folder from coverage. By default all code files are included. For more config options see
+    # https://github.com/colszowka/simplecov
+    add_filter File.expand_path('../../spec', __FILE__)
+  end
+end
+
+# Modify load path so you can require 'ogstasher directly.
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+# Loads bundler setup tasks. Now if I run spec without installing gems then it would say gem not installed and
+# do bundle install instead of ugly load error on require.
+require 'bundler/setup'
+
+# This will require me all the gems automatically for the groups. If I do only .setup then I will have to require gems
+# manually. Note that you have still have to require some gems if they are part of bigger gem like ActiveRecord which is
+# part of Rails. You can say :require => false in gemfile to always use explicit requiring
+Bundler.require(:default, :test)
+
+Dir[File.join("./spec/support/**/*.rb")].each { |f| require f }
+
+# Set Rails environment as test
+ENV['RAILS_ENV'] = 'test'
+
+require 'logger'
+require 'logstash-event'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: logstuff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Rhodes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: request_store
+  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: logstash-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- withnale@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logstuff.rb
+- lib/logstuff/version.rb
+- logstuff.gemspec
+- spec/lib/logstuff_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Structured Logging for use with Logstash
+test_files:
+- spec/lib/logstuff_spec.rb
+- spec/spec_helper.rb