semantic_logger 2.9.2 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5232fd817e451f29ef0c545ec0544773b8dafb3
-  data.tar.gz: 7b6126eb0d3dc720dc9471c750f01c0c5902271d
+  metadata.gz: 0114b0cd9c89056b16e797dad89c995cc0fb9485
+  data.tar.gz: f2df244261d122b2967e973380cf94770b24325e
 SHA512:
-  metadata.gz: 15d25abc264cde1238938cc805263b63df7b7547cc1632a653b6ea45f77addbe71cbb884e54317b9baa27a6107ab30145ef8d8471f1fe785818fd00568746319
-  data.tar.gz: c62818a647641c2280839e253d165b77a9643bdecdacbf0745b882c7151e81e6ea5ec382f9c650bd3e75a77a2b499d3293af63a70c132b4ca079b038de4d33a9
+  metadata.gz: 2eb3829a86b55f7b0014e72a0c624970f134ebc1e9c25ad7a89298078a4d71a993728ec0817f5205fa3afcd82d96186f5dc2e649cceab1e0502bdbfde3cd7845
+  data.tar.gz: 614edca05b62f3de8b48c301c2e059868e607ebea3e4eaa25aacb6fe86e7cde3e83f24fe86b7ca21ac007ff8a96dc217aaaf8c14062e0574003b98876fffcc1c

data/README.md

@@ -11,13 +11,16 @@ For complete documentation see: http://reidmorrison.github.io/semantic_logger
 
 ## Dependencies
 
-See [.travis.yml](https://github.com/reidmorrison/semantic_logger/.travis.yml) for the list of tested Ruby platforms
+Semantic Logger supports the following Ruby platforms:
+- Ruby 1.9.3, 2.0, 2.1
+- JRuby 1.7
 
 The following gems are only required when their corresponding appenders are being used,
 and are therefore not automatically included by this gem:
-- MongoDB Appender: mongo 1.9.2 or above
-- Syslog Appender: syslog_protocol 0.9.2 or above
-- Syslog Appender to a remote syslogng server over TCP or UDP: resilient_socket 0.5.0 or above
+- MongoDB Appender: gem 'mongo' 1.9.2 or above
+- Syslog Appender: gem 'syslog_protocol' 0.9.2 or above
+- Syslog Appender to a remote syslogng server over TCP or UDP: gem 'resilient_socket' 0.5.0 or above
+- Splunk Appender: gem 'splunk-sdk-ruby'
 
 ## Install
 
@@ -25,8 +28,14 @@ and are therefore not automatically included by this gem:
 
 ## Upgrade Notes:
 
-As of SemanticLogger V2.0 the Rails logging is no longer automatically replaced
-when including SemanticLogger. Include the [rails_semantic_logger](http://github.com/reidmorrison/rails_semantic_logger)
+### V2.10
+
+Ruby 1.8 is no longer supported, see [Ruby 1.8.7 EOL](https://www.ruby-lang.org/en/news/2014/07/01/eol-for-1-8-7-and-1-9-2/)
+
+### V2.0
+
+Rails logging is no longer automatically replaced when including SemanticLogger.
+Include the [rails_semantic_logger](http://github.com/reidmorrison/rails_semantic_logger)
 gem to replace the Rails default logger with SemanticLogger
 
 ## Meta
@@ -40,11 +49,12 @@ This project uses [Semantic Versioning](http://semver.org/).
 
 ## Author
 
-Reid Morrison :: reidmo@gmail.com :: @reidmorrison
+[Reid Morrison](https://github.com/reidmorrison) :: @reidmorrison
 
 ## Contributors
 
-Marc Bellingrath :: marrrc.b@gmail.com
+* [Marc Bellingrath](https://github.com/marc)
+* [Andrew Medeiros](https://github.com/amedeiros)
 
 ## License
 

data/lib/semantic_logger.rb

@@ -14,6 +14,7 @@ module SemanticLogger
     autoload :MongoDB,  'semantic_logger/appender/mongodb'
     autoload :Syslog,   'semantic_logger/appender/syslog'
     autoload :NewRelic, 'semantic_logger/appender/new_relic'
+    autoload :Splunk,   'semantic_logger/appender/splunk'
   end
 end
 

data/lib/semantic_logger/appender/splunk.rb

@@ -0,0 +1,56 @@
+require 'splunk-sdk-ruby'
+
+
+# Recommended not to use the colorized formatter.
+
+class SemanticLogger::Appender::Splunk < SemanticLogger::Appender::Base
+  attr_reader :config, :index, :service, :service_index
+
+  # Allow the level for this appender to be overwritten
+  #   Default: :error
+  def initialize(options, level=:error, &block)
+    # Parse input options for setting up splunk connection
+    parse_options(options)
+
+    # Connect to splunk. Connect is a synonym for creating a Service by hand and calling login.
+    @service = Splunk::connect(@config)
+
+    # The index we are logging to
+    @service_index = @service.indexes[@index]
+
+    # Pass on the level and custom formatter if supplied
+    super(level, &block)
+  end
+
+
+  # Log the message to Splunk
+  def log(log)
+    # Ensure minimum log level is met, and check filter
+    return false if (level_index > (log.level_index || 0)) || !include_message?(log)
+    # Submit the log message
+    @service_index.submit(formatter.call(log))
+    true
+  end
+
+  private
+
+    def parse_options(options)
+      @config = {
+       scheme:   options[:scheme] || :https,
+       host:     options[:host]   || 'localhost',
+       port:     options[:port]   || 8089,
+       username: options[:username],
+       password: options[:password]
+      }
+
+      @index = options[:index]
+
+      if @config[:username].nil?
+        raise ArgumentError, 'Must supply a username.'
+      elsif @config[:password].nil?
+        raise ArgumentError, 'Must supply a password.'
+      elsif @index.nil?
+        raise ArgumentError, 'Must supply an index.'
+      end
+    end
+end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = "2.9.2"
+  VERSION = "2.10.0"
 end

data/test/appender_splunk_test.rb

@@ -0,0 +1,63 @@
+# Allow test to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+require 'logger'
+require 'semantic_logger'
+
+# Unit Test for SemanticLogger::Appender::Splunk
+#
+class AppenderSplunkTest < Test::Unit::TestCase
+  context SemanticLogger::Appender::Splunk do
+
+    context '#parse_options' do
+      context 'argument errors' do
+        should 'raise argument error for missing username' do
+          error = assert_raises ArgumentError do
+            SemanticLogger::Appender::Splunk.new({})
+          end
+
+          assert_equal 'Must supply a username.', error.message
+        end
+
+        should 'raise argument error for missing password' do
+          error = assert_raises ArgumentError do
+            SemanticLogger::Appender::Splunk.new(username: 'username')
+          end
+
+          assert_equal 'Must supply a password.', error.message
+        end
+
+        should 'raise argument error for missing index' do
+          error = assert_raises ArgumentError do
+            SemanticLogger::Appender::Splunk.new(username: 'username', password: 'password')
+          end
+
+          assert_equal 'Must supply an index.', error.message
+        end
+      end
+
+      context 'set default values' do
+        # Stub the splunk connect call, and index call.
+        setup do
+          Splunk.expects(:connect).returns(Splunk::Service.new({}))
+          Splunk::Service.any_instance.expects(:indexes).returns({})
+        end
+
+        should 'have default values' do
+          appender = SemanticLogger::Appender::Splunk.new(username: 'username', password: 'password', index: 'index')
+          config   = appender.config
+          # Default host
+          assert_equal 'localhost', config[:host]
+          # Default pot
+          assert_equal 8089, config[:port]
+          # Default scheme
+          assert_equal :https, config[:scheme]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 2.9.2
+  version: 2.10.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sync_attr
@@ -54,6 +54,7 @@ files:
 - lib/semantic_logger/appender/file.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/appender/new_relic.rb
+- lib/semantic_logger/appender/splunk.rb
 - lib/semantic_logger/appender/syslog.rb
 - lib/semantic_logger/appender/wrapper.rb
 - lib/semantic_logger/base.rb
@@ -65,6 +66,7 @@ files:
 - test/appender_file_test.rb
 - test/appender_mongodb_test.rb
 - test/appender_new_relic_test.rb
+- test/appender_splunk_test.rb
 - test/appender_syslog_test.rb
 - test/appender_wrapper_test.rb
 - test/loggable_test.rb
@@ -99,6 +101,7 @@ test_files:
 - test/appender_file_test.rb
 - test/appender_mongodb_test.rb
 - test/appender_new_relic_test.rb
+- test/appender_splunk_test.rb
 - test/appender_syslog_test.rb
 - test/appender_wrapper_test.rb
 - test/loggable_test.rb