yell-adapters-fluentd 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+gem "yell", "~> 2.0"
+gem "fluent-logger", "~> 0.4.3"
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rr"
+  gem "simplecov"
+  
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.1.3)
+    docile (1.1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    fluent-logger (0.4.7)
+      msgpack (>= 0.4.4, < 0.6.0, != 0.5.3, != 0.5.2, != 0.5.1, != 0.5.0)
+      yajl-ruby (~> 1.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    msgpack (0.5.8)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rr (1.1.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    yajl-ruby (1.2.0)
+    yell (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  fluent-logger (~> 0.4.3)
+  jeweler (~> 1.8.7)
+  rdoc (~> 3.12)
+  rr
+  rspec (~> 2.8.0)
+  simplecov
+  yell (~> 2.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Jason Smith
+
+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,79 @@
+Fluentd adapter for Yell
+
+If you are not yet familiar with **Yell - Your Extensible Logging Library** 
+check out the github project under https://github.com/rudionrails/yell or jump 
+directly into the Yell wiki at https://github.com/rudionrails/yell/wiki.
+
+## Installation
+
+System wide:
+
+```console
+gem install yell-adapters-fluentd```
+
+Or in your Gemfile:
+
+```ruby
+gem "yell-adapters-fluentd"
+```
+
+## Usage
+
+The Fluentd adapter is based on the GELF adapter at https://github.com/rudionrails/yell-adapters-gelf
+
+```ruby
+logger = Yell.new :fluentd
+
+# or alternatively with the block syntax
+logger = Yell.new do |l|
+  l.adapter :fluentd
+end
+
+logger.info 'Hello World!'
+```
+
+By default, the adapter will send the following information to Fluentd:
+
+`level`: The current log level  
+`timestamp`: The time when the log event occured  
+`host`: The current hostname  
+`file`: The name of the file where the log event occured  
+`line`: The line in the file where the log event occured  
+`_method`: The method where the log event occured  
+`_pid`: The PID of your current process
+
+### Example: Running Fluentd on a different host or port
+
+```ruby
+logger = Yell.new :fluentd, :host => '127.0.0.1', :port => 1234
+
+# or with the block syntax
+logger = Yell.new do |l|
+  l.adapter :fluentd, :host => '127.0.0.1', :port => 1234
+end
+
+logger.info 'Hello World!'
+```
+
+### Example: Using a custom tag
+By default, the tag "yell" is used. This can be overridden for custom handling.
+
+```ruby
+logger = Yell.new :fluentd, :tag => 'yell.custom'
+
+# or with the block syntax
+logger = Yell.new do |l|
+  l.adapter :fluentd, :tag => 'yell.custom'
+end
+
+logger.info 'Hello World!'
+```
+
+### Example: Passing additional keys to the adapter
+
+```ruby
+logger = Yell.new :fluentd
+
+logger.info "Hello World", "_thread_id" => Thread.current.object_id, 
+                           "_current_user_id" => current_user.id
+```

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "yell-adapters-fluentd"
+  gem.homepage = "http://github.com/red5studios/yell-adapters-fluentd"
+  gem.license = "MIT"
+  gem.summary = %Q{Fluentd adapter for Yell}
+  gem.description = %Q{Fluentd adapter for Yell}
+  gem.email = "jsmith@red5studios.com"
+  gem.authors = ["Jason Smith"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yell-adapters-fluentd #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/yell-adapters-fluentd.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/yell/adapters/fluentd'

data/lib/yell/adapters/fluentd.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require 'yell'
+require 'fluent-logger'
+
+module Yell
+	module Adapters
+		class Fluentd < Yell::Adapters::Base
+
+			attr_accessor :tag, :host, :port
+			attr_accessor :log
+
+			setup do |options|
+				@host = (options[:host] || 'localhost')
+				@port = (options[:port] || 24224)
+				@tag = (options[:tag] || "yell")
+
+				connect
+			end
+
+			close do
+				@log.close if @log
+			end
+
+			write do |event|
+				connect
+
+				message = format({
+					'version' => '1.0',
+					'level' => Severities[event.level],
+					'timestamp' => event.time.to_f,
+					'host' => event.hostname,
+					'file' => event.file,
+					'line' => event.line,
+					'_method' => event.method,
+					'_pid' => event.pid
+				}, *event.messages )
+
+				log.post(tag, message)
+			end
+
+			def connect
+				@log ||= Fluent::Logger::FluentLogger.new(nil, :host => (@host || 'localhost'), :port => (@port || 24224))
+			end
+
+			def format( *messages )
+				messages.inject(Hash.new) do |result, m|
+					result.merge to_message(m)
+				end
+			end
+
+			def to_message( message )
+				case message
+					when Hash
+						message
+					when Exception
+						{ "short_message" => "#{message.class}: #{message.message}" }.tap do |m|
+							m.merge!( "long_message" => message.backtrace.join("\n") ) if message.backtrace
+						end
+					else { "short_message" => message.to_s }
+				end
+			end
+		end
+
+		register(:fluentd, Yell::Adapters::Fluentd)
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rr'
+require 'yell-adapters-fluentd'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_framework = :rr
+end

data/spec/yell/adapters/fluentd_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Yell::Adapters::Fluentd do
+
+  class FluentStub
+    def tag; @tag; end
+    def message; @message; end
+
+    def post(tag,message)
+      @tag = tag
+      @message = message
+    end
+  end
+
+  let(:logger) { Yell::Logger.new }
+
+  context "a new Yell::Adapters::Fluentd instance" do
+    subject { Yell::Adapters::Fluentd.new }
+
+    its(:host) { should == 'localhost' }
+    its(:port) { should == 24224 }
+    its(:tag) { should == 'yell' }
+  end
+
+  context :host do
+    let(:adapter) { Yell::Adapters::Fluentd.new }
+    subject { adapter.host }
+
+    before { adapter.host = 'hostname' }
+
+    it { should == 'hostname' }
+  end
+
+  context :port do
+    let(:adapter) { Yell::Adapters::Fluentd.new }
+    subject { adapter.port }
+
+    before { adapter.port = 1234 }
+
+    it { should == 1234 }
+  end
+
+  context :write do
+    let(:event) { Yell::Event.new(logger, 1, 'Hello World') }
+    let(:adapter) { Yell::Adapters::Fluentd.new }
+
+    context :datagrams do
+      before do
+        @fluent = FluentStub.new
+        stub(Fluent::Logger::FluentLogger).new(nil,anything) { @fluent }
+      end
+
+      after { adapter.write event }
+
+      it "should receive :version" do
+        mock.proxy(@fluent).post("yell",hash_including('version' => '1.0'))
+      end
+
+      it "should receive :level" do
+        mock.proxy(@fluent).post("yell", hash_including('level' => Yell::Severities[event.level]) )
+      end
+
+      it "should receive :short_message" do
+        mock.proxy(@fluent).post("yell", hash_including('short_message' => event.messages.first) )
+      end
+
+      it "should receive :timestamp" do
+        mock.proxy(@fluent).post("yell", hash_including('timestamp' => event.time.to_f) )
+      end
+
+      it "should receive :host" do
+        mock.proxy(@fluent).post("yell", hash_including('host' => event.hostname) )
+      end
+
+      it "should receive :file" do
+        mock.proxy(@fluent).post("yell", hash_including('file' => event.file) )
+      end
+
+      it "should receive :line" do
+        mock.proxy(@fluent).post("yell", hash_including('line' => event.line) )
+      end
+
+      it "should receive :method" do
+        mock.proxy(@fluent).post("yell", hash_including('_method' => event.method) )
+      end
+
+      it "should receive :pid" do
+        mock.proxy(@fluent).post("yell", hash_including('_pid' => event.pid) )
+      end
+
+      context "given a Hash" do
+        let(:event) { Yell::Event.new(logger, 1, 'short_message' => 'Hello World', '_custom_field' => 'Custom Field') }
+
+        it "should receive :short_message" do
+          mock.proxy(@fluent).post("yell", hash_including('short_message' => 'Hello World') )
+        end
+
+        it "should receive :_custom_field" do
+          mock.proxy(@fluent).post("yell", hash_including('_custom_field' => 'Custom Field') )
+        end
+      end
+
+      context "given an Exception" do
+        let(:exception) { StandardError.new('This is an error') }
+        let(:event) { Yell::Event.new(logger, 1, exception) }
+
+        before do
+          mock(exception).backtrace.times(any_times) { [:back, :trace] }
+        end
+
+        it "should receive :short_message" do
+          mock.proxy(@fluent).post("yell", hash_including('short_message' => "#{exception.class}: #{exception.message}") )
+        end
+
+        it "should receive :long_message" do
+          mock.proxy(@fluent).post("yell", hash_including('long_message' => "back\ntrace") )
+        end
+      end
+
+      context "given a Yell::Event with :options" do
+        let(:event) { Yell::Event.new(logger, 1, 'Hello World', "_custom_field" => 'Custom Field') }
+
+        it "should receive :short_message" do
+          mock.proxy(@fluent).post("yell", hash_including('short_message' => 'Hello World') )
+        end
+
+        it "should receive :_custom_field" do
+          mock.proxy(@fluent).post("yell", hash_including('_custom_field' => 'Custom Field') )
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: yell-adapters-fluentd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: Fluentd adapter for Yell
+email: jsmith@red5studios.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/yell-adapters-fluentd.rb
+- lib/yell/adapters/fluentd.rb
+- spec/spec_helper.rb
+- spec/yell/adapters/fluentd_spec.rb
+homepage: http://github.com/red5studios/yell-adapters-fluentd
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2881317609981975877
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Fluentd adapter for Yell
+test_files: []