sensu-logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4db534173e30cf3979d6da7ff7f265295ec81355
+  data.tar.gz: 67965cb16d8007580121d805571a05dbfdff7ebf
+SHA512:
+  metadata.gz: bea338ccf9f40ca351c1b1a30c8bbe880c041f0544bd45eb670c12db9af20c4c2c60f548ad4707b0f3e64df55a1afdef67ca66c2ebb8b8807e789bcf0d49c183
+  data.tar.gz: 97207727a424296216289e5a9476a6c4ab012285f9df9a04c2694b4d7b4673172461d2877bb203eeb8c7b788bc50e9b5269f2c00f1a15f2923e6a145a425d1f2

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+addons:
+  code_climate:
+    repo_token: fb78330fb5aad0202b51f0fe25829ecb08229dc8236fb5fd573cd95997603527

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Heavy Water Operations, LLC.
+
+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,28 @@
+# Sensu::Logger
+
+[![Build Status](https://travis-ci.org/sensu/sensu-logger.svg?branch=master)](https://travis-ci.org/sensu/sensu-logger)
+
+[![Code Climate](https://codeclimate.com/github/sensu/sensu-logger.png)](https://codeclimate.com/github/sensu/sensu-logger)
+[![Code Climate Coverage](https://codeclimate.com/github/sensu/sensu-logger/coverage.png)](https://codeclimate.com/github/sensu/sensu-logger)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sensu-logger'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Documentation can be found [here](http://rubydoc.info/github/sensu/sensu-logger/Sensu/Logger).
+
+## Contributing
+
+1. [Fork it](https://github.com/sensu/sensu-logger/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 a new Pull Request

data/Rakefile

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

data/lib/sensu/logger.rb

@@ -0,0 +1,33 @@
+require "sensu/logger/stream"
+
+module Sensu
+  module Logger
+    class << self
+      # Setup a log stream.
+      #
+      # @param [Hash] options to create the log stream with.
+      # @option options [String] :log_level to use.
+      # @option options [String] :log_file to use.
+      # @return [Stream] instance of a log stream.
+      def setup(options={})
+        @stream = Stream.new
+        if options[:log_level]
+          @stream.level = options[:log_level]
+        end
+        if options[:log_file]
+          @stream.reopen(options[:log_file])
+        end
+        @stream
+      end
+
+      # Retrieve the current log stream or set one up if there isn't
+      # one. Note: We may need to add a mutex for thread safety.
+      #
+      # @param [Hash] options to pass to setup().
+      # @return [Stream] instance of a log stream.
+      def get(options={})
+        @stream || setup(options)
+      end
+    end
+  end
+end

data/lib/sensu/logger/constants.rb

@@ -0,0 +1,5 @@
+module Sensu
+  module Logger
+    LEVELS = [:debug, :info, :warn, :error, :fatal]
+  end
+end

data/lib/sensu/logger/stream.rb

@@ -0,0 +1,185 @@
+gem "sensu-em"
+
+require "eventmachine"
+require "multi_json"
+require "sensu/logger/constants"
+
+module Sensu
+  module Logger
+    class Stream
+      # @!attribute [rw] level
+      #   @return level [Symbol] current log level.
+      attr_accessor :level
+
+      # Initialize a log stream, redirect STDERR to STDOUT, create log
+      # level methods, and setup the reactor log event writer.
+      def initialize
+        @stream = []
+        @stream_callbacks = []
+        @level = :info
+        STDOUT.sync = true
+        STDERR.reopen(STDOUT)
+        self.class.create_level_methods
+        setup_writer
+      end
+
+      # Create a method for each of the log levels, they call add() to
+      # add log events to the log stream.
+      def self.create_level_methods
+        LEVELS.each do |level|
+          define_method(level) do |*args|
+            add(level, *args)
+          end
+        end
+      end
+
+      # Check to see if a log level is currently being filtered.
+      #
+      # @param level [Symbol] log event level.
+      # @return [TrueClass, FalseClass]
+      def level_filtered?(level)
+        LEVELS.index(level) < LEVELS.index(@level)
+      end
+
+      # Add a log event to the log stream.
+      #
+      # @param level [Symbol] log event level.
+      # @param args [Array] to pass to create_log_event().
+      # @return [TrueClass, FalseClass] if the log event was added.
+      def add(level, *args)
+        unless level_filtered?(level)
+          event = create_log_event(level, *args)
+          if EM.reactor_running?
+            schedule_write(event)
+          else
+            safe_write(event)
+          end
+          true
+        else
+          false
+        end
+      end
+
+      # Reopen the log stream output, write log events to a file.
+      #
+      # @param target [IO, String] IO stream or file path.
+      def reopen(target)
+        @reopen = target
+        case target
+        when IO
+          STDOUT.reopen(target)
+          STDOUT.sync = true
+          STDERR.reopen(STDOUT)
+        when String
+          if File.writable?(target) || !File.exist?(target) && File.writable?(File.dirname(target))
+            STDOUT.reopen(target, "a")
+            STDOUT.sync = true
+            STDERR.reopen(STDOUT)
+          else
+            error("log file is not writable", {
+              :log_file => target
+            })
+          end
+        end
+      end
+
+      # Setup signal traps for the log stream.
+      # Signals:
+      #   TRAP: toggle debug logging.
+      #   USR2: reopen the log file.
+      def setup_signal_traps
+        if Signal.list.include?("TRAP")
+          Signal.trap("TRAP") do
+            @level = case @level
+            when :debug
+              @previous_level || :info
+            else
+              @previous_level = @level
+              :debug
+            end
+          end
+        end
+        if Signal.list.include?("USR2")
+          Signal.trap("USR2") do
+            if @reopen
+              reopen(@reopen)
+            end
+          end
+        end
+      end
+
+      private
+
+      # Create a JSON log event.
+      #
+      # @param level [Symbol] log event level.
+      # @param message [String] log event message.
+      # @param data [Hash] log event data.
+      # @return [String] JSON log event.
+      def create_log_event(level, message, data=nil)
+        event = {}
+        event[:timestamp] = Time.now.strftime("%Y-%m-%dT%H:%M:%S.%6N%z")
+        event[:level] = level
+        event[:message] = message
+        if data.is_a?(Hash)
+          event.merge!(data)
+        end
+        MultiJson.dump(event)
+      end
+
+      # Schedule a log event write, pushing the JSON log event into
+      # the stream.
+      #
+      # @param event [String] JSON log event.
+      def schedule_write(event)
+        EM.schedule do
+          @stream << event
+          unless @stream_callbacks.empty?
+            @stream_callbacks.shift.call(@stream.shift)
+          end
+        end
+      end
+
+      # Write a JSON log event to STDOUT, which may be redirected to a
+      # log file. This method will take no action if the storage
+      # device has no space remaining.
+      def safe_write(event)
+        begin
+          puts event
+        rescue Errno::ENOSPC
+        end
+      end
+
+      # Register a log stream callback (a write operation).
+      #
+      # @param [Proc] callback to register, it will eventually be
+      #   called and passed a JSON log event as a parameter.
+      def register_callback(&callback)
+        EM.schedule do
+          if @stream.empty?
+            @stream_callbacks << callback
+          else
+            callback.call(@stream.shift)
+          end
+        end
+      end
+
+      # Setup reactor log event writer. On shutdown, remaining log
+      # events will be written/flushed.
+      def setup_writer
+        writer = Proc.new do |log_event|
+          safe_write(log_event)
+          EM.next_tick do
+            register_callback(&writer)
+          end
+        end
+        register_callback(&writer)
+        EM.add_shutdown_hook do
+          @stream.size.times do
+            safe_write(@stream.shift)
+          end
+        end
+      end
+    end
+  end
+end

data/sensu-logger.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-logger"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sean Porter"]
+  spec.email         = ["portertech@gmail.com"]
+  spec.summary       = "The Sensu logger library"
+  spec.description   = "The Sensu logger library"
+  spec.homepage      = "https://github.com/sensu/sensu-logger"
+  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_dependency("sensu-em")
+  spec.add_dependency("multi_json")
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/spec/helpers.rb

@@ -0,0 +1,29 @@
+require "rspec"
+require "eventmachine"
+
+unless RUBY_VERSION < "1.9" || RUBY_PLATFORM =~ /java/
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+module Helpers
+  def timer(delay, &callback)
+    periodic_timer = EM::PeriodicTimer.new(delay) do
+      callback.call
+      periodic_timer.cancel
+    end
+  end
+
+  def async_wrapper(&callback)
+    EM.run do
+      timer(10) do
+        raise "test timed out"
+      end
+      callback.call
+    end
+  end
+
+  def async_done
+    EM.stop_event_loop
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/logger"
+
+describe "Sensu::Logger" do
+  include Helpers
+
+  it "can provide the logger API" do
+    Sensu::Logger.should respond_to(:setup, :get)
+  end
+
+  it "can set up a log stream" do
+    logger = Sensu::Logger.setup
+    logger.info("some info", {:foo => "bar"}).should be_true
+    logger.level = :warn
+    logger.info("some info", {:foo => "bar"}).should be_false
+  end
+
+  it "can retrive the current log stream" do
+    logger = Sensu::Logger.setup
+    Sensu::Logger.get.should eq(logger)
+    Sensu::Logger.get.should eq(logger)
+  end
+
+  it "can setup a log stream if one doesn't exist" do
+    logger = Sensu::Logger.get
+    logger.info("some info", {:foo => "bar"}).should be_true
+  end
+
+  it "can setup a log stream with a log level and file" do
+    stdout = STDOUT.dup
+    file = Tempfile.new("sensu-logger")
+    logger = Sensu::Logger.setup(:log_level => :warn, :log_file => file.path)
+    logger.info("some info", {:foo => "bar"}).should be_false
+    logger.warn("a warning", {:foo => "bar"}).should be_true
+    file_contents = IO.read(file.path)
+    file_contents.should match(/a warning/)
+    logger.reopen(stdout)
+    logger.warn("a warning", {:foo => "bar"}).should be_true
+  end
+
+  it "can setup a log stream with options if one doesn't exist" do
+    logger = Sensu::Logger.get(:log_level => :warn)
+    logger.info("some info", {:foo => "bar"}).should be_false
+    logger.warn("a warning", {:foo => "bar"}).should be_true
+  end
+end

data/spec/stream_spec.rb

@@ -0,0 +1,110 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/logger/stream"
+require "tempfile"
+
+describe "Sensu::Logger::Stream" do
+  include Helpers
+
+  before do
+    @stream = Sensu::Logger::Stream.new
+  end
+
+  it "can log events with different levels" do
+    @stream.debug("some debug info", {:foo => "bar"}).should be_false
+    @stream.info("some info", {:foo => "bar"}).should be_true
+    @stream.warn("a warning", {:foo => "bar"}).should be_true
+    @stream.error("an error", {:foo => "bar"}).should be_true
+    @stream.fatal("something exploded", {:foo => "bar"}).should be_true
+    @stream.level = :debug
+    @stream.debug("some debug info", {:foo => "bar"}).should be_true
+    @stream.info("some info", {:foo => "bar"}).should be_true
+    @stream.level = :warn
+    @stream.info("some info", {:foo => "bar"}).should be_false
+    @stream.warn("a warning", {:foo => "bar"}).should be_true
+  end
+
+  it "can reopen STDERR/STDOUT and redirect them to a log file" do
+    stdout = STDOUT.dup
+    file = Tempfile.new("sensu-logger")
+    @stream.reopen(file.path)
+    @stream.info("some info", {:foo => "bar"}).should be_true
+    @stream.reopen(stdout)
+    file_contents = IO.read(file.path)
+    file_contents.should match(/timestamp/)
+    file_contents.should match(/"message":"some info"/)
+    file_contents.should match(/"foo":"bar"/)
+    @stream.reopen("/untouchable.log")
+    @stream.info("some info", {:foo => "bar"}).should be_true
+  end
+
+  it "can setup signal traps to toggle debug logging and reopen the log file" do
+    @stream.setup_signal_traps
+    @stream.debug("some debug info", {:foo => "bar"}).should be_false
+    @stream.info("some info", {:foo => "bar"}).should be_true
+    Process.kill("TRAP", Process.pid)
+    sleep 0.5
+    @stream.debug("some debug info", {:foo => "bar"}).should be_true
+    @stream.info("some info", {:foo => "bar"}).should be_true
+    Process.kill("TRAP", Process.pid)
+    sleep 0.5
+    @stream.debug("some debug info", {:foo => "bar"}).should be_false
+    @stream.info("some info", {:foo => "bar"}).should be_true
+    @stream.level = :warn
+    @stream.info("some info", {:foo => "bar"}).should be_false
+    Process.kill("TRAP", Process.pid)
+    sleep 0.5
+    @stream.debug("some debug info", {:foo => "bar"}).should be_true
+    @stream.info("some info", {:foo => "bar"}).should be_true
+    Process.kill("TRAP", Process.pid)
+    sleep 0.5
+    @stream.debug("some debug info", {:foo => "bar"}).should be_false
+    @stream.info("some info", {:foo => "bar"}).should be_false
+    @stream.warn("a warning", {:foo => "bar"}).should be_true
+    @stream.reopen(STDOUT)
+    Process.kill("USR2", Process.pid)
+    sleep 0.5
+    @stream.error("an error", {:foo => "bar"}).should be_true
+  end
+
+  it "can operate as expected within the eventmachine reactor" do
+    async_wrapper do
+      stdout = STDOUT.dup
+      file = Tempfile.new("sensu-logger")
+      @stream.reopen(file.path)
+      @stream.debug("some debug info", {:foo => "bar"}).should be_false
+      @stream.info("some info", {:foo => "bar"}).should be_true
+      @stream.warn("a warning", {:foo => "bar"}).should be_true
+      @stream.error("an error", {:foo => "bar"}).should be_true
+      timer(1) do
+        @stream.reopen(stdout)
+        expected = [
+          {:level => "info", :message => "some info", :foo => "bar"},
+          {:level => "warn", :message => "a warning", :foo => "bar"},
+          {:level => "error", :message => "an error", :foo => "bar"}
+        ]
+        file_contents = IO.read(file.path)
+        parsed_contents = file_contents.lines.map do |line|
+          parsed_line = MultiJson.load(line, :symbolize_keys => true)
+          parsed_line.delete(:timestamp)
+          parsed_line
+        end
+        parsed_contents.should eq(expected)
+        async_done
+      end
+    end
+  end
+
+  it "can write remaining log events to a log file when the eventmachine reactor stops" do
+    stdout = STDOUT.dup
+    file = Tempfile.new("sensu-logger")
+    async_wrapper do
+      @stream.reopen(file.path)
+      1000.times do
+        @stream.info("some info", {:foo => "bar"}).should be_true
+      end
+      EM.stop
+    end
+    @stream.reopen(stdout)
+    IO.read(file.path).split("\n").size.should eq(1000)
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: sensu-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-em
+  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: multi_json
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: The Sensu logger library
+email:
+- portertech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sensu/logger.rb
+- lib/sensu/logger/constants.rb
+- lib/sensu/logger/stream.rb
+- sensu-logger.gemspec
+- spec/helpers.rb
+- spec/logger_spec.rb
+- spec/stream_spec.rb
+homepage: https://github.com/sensu/sensu-logger
+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.0
+signing_key: 
+specification_version: 4
+summary: The Sensu logger library
+test_files:
+- spec/helpers.rb
+- spec/logger_spec.rb
+- spec/stream_spec.rb