logstash-file 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2MwYzc5MzMxYjE2YjA2M2EwODRmYWQ2MDY4ZDE3MDU5MjQzN2RhYg==
+  data.tar.gz: !binary |-
+    MGU2N2UwOGEwOWZiNjE2NzI0MmNlOTA0YmQ5MTk4MjJlMGE3NzU5Yw==
+SHA512:
+  metadata.gz: !binary |-
+    YWRkMzc4YWEzZGQ3YzUwOTBmZjcyMzc4ZTdjMWU2MDNiMTIyMmE4YzVmZWMy
+    MDQxMDQ4NWIyM2RiMmZiZWJkNDBmNzc4YmIxZWFmNzFhM2U5MGRiMzA1ODdk
+    MjMxZDFkYzcwNjI0YTQxYTJhOTE5M2NhYjA1OWU5YmQ5ODQ2M2Q=
+  data.tar.gz: !binary |-
+    M2UxNGU2YzY0ZTRmNTJmYjUzYzEzMjA1OGYzMTlhNjE5ZmJiNGMzOGM4YzJh
+    OGVmZjA5OWJiYTZmY2M4MTY5NzJlOGIxYzQwN2Q1NTIyMDJjMDIwYmMyNDk1
+    M2M1Njg5M2NjNjg0ZTgwODUxNDE0NTZiYTE5MDIxZjk3OTQxODc=

data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+yardoc
+pkg
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+script: rake
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-head
+  - jruby-19mode
+  - jruby-head
+
+notifications:
+  email:
+    recipients:
+      - development@olery.com
+    email:
+      on_success: change
+      on_failure: always
+
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,12 @@
+./lib/logstash-file/**/*.rb ./lib/logstash-file.rb
+-m markdown
+-M kramdown
+-o yardoc
+-r ./README.md
+--private
+--protected
+--asset ./doc/css/common.css:css/common.css
+--verbose
+-
+./doc/*.md
+LICENSE

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org/'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013, Olery <http://olery.com>
+
+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,40 @@
+# Logstash File Logger
+
+<a href="http://logstash.net/" title="Logstash">
+  <img src="logstash.png" alt="Logstash" align="right">
+</a>
+
+The logstash-file Gem is yet another Logstash logger but instead of using a
+network transporation layer such as TCP or UDP it writes JSON data to a file.
+
+The LogstashFile::Logger class provides a Logger-like interface by supplying
+methods such as `info`, `error`, etc. Unlike the Logger API they take a 2nd
+optional argument that can be used to specify custom fields to set in the
+logging message. See below for more information.
+
+## Requirements
+
+* Ruby 1.9.3 or newer
+
+## Usage
+
+First install the Gem:
+
+    gem install logstash-file
+
+Basic logging is as following:
+
+    require 'logstash-file'
+
+    logger = LogstashFile::Logger.new(STDOUT)
+
+    logger.info("Hello!") # => {"@fields": {"level": "info"}, "@message": "Hello!", "@timestamp": "..."}
+
+    # Logging using custom fields
+    logger.info("Hello!", :user => "Alice") # => {"@fields": {"user": "Alice", ...}, ...}
+
+## License
+
+The source code of this repository and logstash-file itself are licensed under
+the MIT license unless specified otherwise. A copy of this license can be found
+in the file "LICENSE" in the root directory of this repository.

data/Rakefile

@@ -0,0 +1,10 @@
+require_relative 'lib/logstash-file/version'
+
+require 'bundler/gem_tasks'
+require 'ci/reporter/rake/rspec'
+
+Dir['./task/*.rake'].each do |task|
+  import(task)
+end
+
+task :default => :test

data/doc/css/common.css

@@ -0,0 +1,69 @@
+
+body
+{
+    font-size:   14px;
+    line-height: 1.6;
+    margin:      0 auto;
+    max-width:   960px;
+}
+
+p code
+{
+    background:    #f2f2f2;
+    padding-left:  3px;
+    padding-right: 3px;
+}
+
+pre.code
+{
+    font-size:   13px;
+    line-height: 1.4;
+}
+
+/**
+ * YARD uses generic table styles, using a special class means those tables
+ * don't get messed up.
+ */
+.table
+{
+    border:          1px solid #ccc;
+    border-right:    none;
+    border-collapse: separate;
+    border-spacing:  0;
+    text-align:      left;
+}
+
+.table.full
+{
+    width: 100%;
+}
+
+    .table .field_name
+    {
+        min-width: 160px;
+    }
+
+    .table thead tr th.no_sort:first-child
+    {
+        width: 25px;
+    }
+
+    .table thead tr th, .table tbody tr td
+    {
+        border-bottom:  1px solid #ccc;
+        border-right:   1px solid #ccc;
+        min-width:      20px;
+        padding:        8px 5px;
+        text-align:     left;
+        vertical-align: top;
+    }
+
+    .table tbody tr:last-child td
+    {
+        border-bottom: none;
+    }
+
+    .table tr:nth-child(odd) td
+    {
+        background: #f9f9f9;
+    }

data/jenkins.sh

@@ -0,0 +1,16 @@
+# This configuration file is used to test/build the project on Olery's private
+# Jenkins instance. Patches containing changes to this file made by people
+# outside of Olery will most likely be rejected.
+
+# The name of the project, used for other settings such as the MySQL database
+# and the package name.
+PROJECT_NAME="logstash_file"
+
+# Whether or not to use a MySQL database, set to a non empty value to enable
+# this. Enabling this will tell Jenkins to create/drop the database and to
+# import any migrations if needed.
+unset USE_MYSQL
+
+# The command to run for the test suite. Junction itself doesn't have a test
+# suite so we'll use a noop.
+TEST_COMMAND="rake jenkins --trace"

data/lib/logstash-file/logger.rb

@@ -0,0 +1,64 @@
+module LogstashFile
+  ##
+  # The {LogstashFile::Logger} class is a simple Logstash JSON logger with an
+  # API similar to the Logger class provided by the Ruby standard library.
+  #
+  # This logger class internally uses a mutex to synchronize write operations,
+  # thus it should be fine to share an instance of this class between multiple
+  # threads. Having said that, you might experience a performance bottleneck if
+  # you're logging a lot across different threads.
+  #
+  class Logger
+    ##
+    # The format used for formatting the times of each log entry.
+    #
+    # @return [String]
+    #
+    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S%z'
+
+    ##
+    # @param [String|IO] path Path to the file to write logging data to. You
+    #  can also supply an IO object to use.
+    #
+    # @todo Investigate to see if a mutex is really required for write-only
+    #  operations.
+    #
+    def initialize(path)
+      @handle = path.respond_to?(:write) ? path : File.open(path, 'a+')
+      @mutex  = Mutex.new
+    end
+
+    ##
+    # Closes the associated stream.
+    #
+    def close
+      @handle.close
+    end
+
+    [:info, :error, :warning, :debug].each do |level|
+      define_method(level) do |message, fields = {}|
+        log(message, fields.merge(:level => level))
+      end
+    end
+
+    private
+
+    ##
+    # @param [String] message The message to log.
+    # @param [Hash] fields Extra fields to log.
+    #
+    def log(message, fields = {})
+      time  = Time.now.utc.strftime(TIME_FORMAT)
+      entry = {:@timestamp => time, :@fields => fields, :@message => message}
+
+      write(entry)
+    end
+
+    ##
+    # @param [Hash] hash
+    #
+    def write(hash)
+      @mutex.synchronize { @handle.puts(JSON(hash)) }
+    end
+  end # Logger
+end # LogstashFile

data/lib/logstash-file/version.rb

@@ -0,0 +1,3 @@
+module LogstashFile
+  VERSION = '0.0.1'
+end # LogstashFile

data/lib/logstash-file.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'thread'
+
+require_relative 'logstash-file/version'
+require_relative 'logstash-file/logger'

data/logstash-file.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/logstash-file/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'logstash-file'
+  gem.version     = LogstashFile::VERSION
+  gem.authors     = ['Yorick Peterse']
+  gem.summary     = 'Simple file based logging for Logstash.'
+  gem.description = gem.summary
+  gem.has_rdoc    = 'yard'
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.files       = `git ls-files`.split("\n").sort
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files  = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_dependency 'json'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'kramdown'
+  gem.add_development_dependency 'ci_reporter'
+end

data/spec/logstash-file/logger_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe LogstashFile::Logger do
+  let :buffer do
+    StringIO.new
+  end
+
+  let :logger do
+    LogstashFile::Logger.new(buffer)
+  end
+
+  def read_output(buffer)
+    buffer.rewind
+
+    return JSON(buffer.read.strip)
+  end
+
+  example 'log an info message' do
+    logger.info('info message')
+
+    output = read_output(buffer)
+
+    output['@message'].should == 'info message'
+    output['@fields'].should  == {'level' => 'info'}
+
+    output.key?('@timestamp').should == true
+  end
+
+  example 'add custom fields to a log entry' do
+    logger.info('info message', :number => 10)
+
+    output = read_output(buffer)
+
+    output['@fields']['number'].should == 10
+  end
+
+  # Half-assed test to ensure that multiple entries are actually written on
+  # separate lines. It doesn't *actually* test thread-safety though, that's a
+  # pretty difficult thing to test reliably.
+  example 'synchronize multi-threaded operations' do
+    amount  = 50
+    threads = []
+
+    amount.times do |n|
+      threads << Thread.new { logger.info("thread #{n}") }
+    end
+
+    threads.each(&:join)
+
+    buffer.rewind
+
+    lines = buffer.read.split("\n")
+
+    lines.length.should == amount
+  end
+
+  example 'create a logger using a filepath' do
+    file   = Tempfile.new('logstash-file')
+    logger = LogstashFile::Logger.new(file.path)
+
+    logger.info('testing')
+    logger.close
+
+    output = read_output(file)
+
+    output['@message'].should == 'testing'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'stringio'
+require 'tempfile'
+
+require_relative 'support/simplecov' if ENV['COVERAGE']
+require_relative '../lib/logstash-file'
+
+RSpec.configure do |config|
+  config.color = true
+end

data/spec/support/simplecov.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+
+SimpleCov.configure do
+  root         File.expand_path('../../../', __FILE__)
+  command_name 'rspec'
+  project_name 'logstash-file'
+
+  add_filter 'spec'
+  add_filter 'lib/logstash-file/version'
+end
+
+SimpleCov.start

data/task/coverage.rake

@@ -0,0 +1,6 @@
+desc 'Generates code coverage'
+task :coverage do
+  ENV['COVERAGE'] = '1'
+
+  Rake::Task['test'].invoke
+end

data/task/doc.rake

@@ -0,0 +1,4 @@
+desc 'Builds the documentation'
+task :doc do
+  sh('yard doc')
+end

data/task/jenkins.rake

@@ -0,0 +1,2 @@
+desc 'Runs all the tests for Jenkins'
+task :jenkins => ['ci:setup:rspec', 'test']

data/task/tag.rake

@@ -0,0 +1,6 @@
+desc 'Creates a Git tag for the current version'
+task :tag do
+  version = Oni::VERSION
+
+  sh %Q{git tag -a -m "Version #{version}" -s #{version}}
+end

data/task/test.rake

@@ -0,0 +1,4 @@
+desc 'Runs the tests'
+task :test do
+  sh 'rspec spec'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: logstash-file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yorick Peterse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: 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: bundler
+  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: yard
+  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: simplecov
+  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: kramdown
+  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: ci_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: Simple file based logging for Logstash.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doc/css/common.css
+- jenkins.sh
+- lib/logstash-file.rb
+- lib/logstash-file/logger.rb
+- lib/logstash-file/version.rb
+- logstash-file.gemspec
+- logstash.png
+- spec/logstash-file/logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/simplecov.rb
+- task/coverage.rake
+- task/doc.rake
+- task/jenkins.rake
+- task/tag.rake
+- task/test.rake
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.2
+signing_key: 
+specification_version: 4
+summary: Simple file based logging for Logstash.
+test_files:
+- spec/logstash-file/logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/simplecov.rb
+has_rdoc: yard