logstash-logger 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc77de67a993f6d92e48eb51a03403545adb4a36
-  data.tar.gz: 155105ccaa41672d379ba39f1f58891079814ef1
+  metadata.gz: 7d1a717987bfefa4eae1faafea2f61fcc0e3b1b5
+  data.tar.gz: 5f7251bf59a5a3a288d773c22b75d085f7f0ce2d
 SHA512:
-  metadata.gz: 49065907ddd39ea7dce437da0d9e4d640667a48d056f487b23948a6a4a97bb2d8a117c6370a430b9465f739b3225a1ac8cb9419f8144928b30af78a118c18a96
-  data.tar.gz: 945c34c855bf8f0fe36b1a40d8b6daaf72ac452590da3e8f3d74069f3fdcc41865f6926513255bd2bca91e661130dbe7ec8a1f82d5813879ca625fd9df7ee135
+  metadata.gz: 1bbc32714b3f38930d53f44a7164f9cfef9d15ae77d6e38c2846577c3be7a681b330097cbdc999657f37768e1f708159dec43880e84c5a9bb5d236066582f961
+  data.tar.gz: 2d7807cc5d58da6de21fa2319cf6c1709a28d31184246109cb85cfa2e4206f92b946e39b8f407f12fa16e73d6168daa56075433e13faeaf29b56533e24e822b5

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.14.0
+- Support for Syslog output. [#59](https://github.com/dwbutler/logstash-logger/pull/59)
+
 ## 0.13.0
 - Support for sending messages to multiple loggers. Each one can have a different formatter. [#58](https://github.com/dwbutler/logstash-logger/pull/58)
 - Fixes tagged logging support when using a custom formatter.

data/README.md

@@ -8,7 +8,7 @@ writing to a file or syslog since logstash can receive the structured data direc
 ## Features
 
 * Can write directly to logstash over a UDP or TCP/SSL connection.
-* Can write to a file, Redis, a unix socket, stdout or stderr.
+* Can write to a file, Redis, Kafka, a unix socket, syslog, stdout, or stderr.
 * Writes in logstash JSON format, but supports other formats as well.
 * Can write to multiple outputs.
 * Logger can take a string message, a hash, a `LogStash::Event`, an object, or a JSON string as input.
@@ -44,6 +44,7 @@ tcp_logger = LogStashLogger.new(type: :tcp, host: 'localhost', port: 5229)
 # Other types of loggers
 file_logger = LogStashLogger.new(type: :file, path: 'log/development.log', sync: true)
 unix_logger = LogStashLogger.new(type: :unix, path: '/tmp/sock')
+syslog_logger = LogStashLogger.new(type: :syslog)
 redis_logger = LogStashLogger.new(type: :redis)
 kafka_logger = LogStashLogger.new(type: :kafka)
 stdout_logger = LogStashLogger.new(type: :stdout)
@@ -75,6 +76,7 @@ ruby_default_formatter_logger = LogStashLogger.new(
 )
 
 # Send messages to multiple outputs. Each output will have the same format.
+# Syslog cannot be an output because it requires a separate logger.
 multi_delegating_logger = LogStashLogger.new(
   type: :multi_delegator,
   outputs: [
@@ -82,7 +84,8 @@ multi_delegating_logger = LogStashLogger.new(
     { type: :udp, host: 'localhost', port: 5228 }
   ])
 
-# Balance messages between several outputs
+# Balance messages between several outputs.
+# Works the same as multi delegator, but randomly chooses an output to send each message.
 balancer_logger = LogStashLogger.new(
   type: :balancer,
   outputs: [
@@ -92,6 +95,7 @@ balancer_logger = LogStashLogger.new(
 
 # Send messages to multiple loggers.
 # Use this if you need to send different formats to different outputs.
+# If you need to log to syslog, you must use this.
 multi_logger = LogStashLogger.new(
   type: :multi_logger,
   outputs: [
@@ -305,6 +309,25 @@ config.logstash.type = :unix
 config.logstash.path = '/tmp/sock'
 ```
 
+#### Syslog
+
+If you're on Ruby 1.9, add `Syslog::Logger` v2 to your Gemfile:
+
+    gem 'SyslogLogger', '2.0'
+
+If you're on Ruby 2+, `Syslog::Logger` is already built into the standard library.
+
+```ruby
+# Required
+config.logstash.type = :syslog
+
+# Optional. Defaults to 'ruby'
+config.logstash.program_name = 'MyApp'
+
+# Optional default facility level. Only works in Ruby 2+
+config.logstash.facility = Syslog::LOG_LOCAL0
+```
+
 #### Redis
 
 Add the redis gem to your Gemfile:

data/lib/logstash-logger/logger.rb

@@ -1,6 +1,11 @@
 require 'logger'
 require 'logstash-logger/tagged_logging'
 
+autoload :Syslog, 'syslog'
+module Syslog
+  autoload :Logger, 'syslog/logger'
+end
+
 module LogStashLogger
   autoload :MultiLogger, 'logstash-logger/multi_logger'
 
@@ -45,20 +50,45 @@ module LogStashLogger
   end
 
   def self.build_logger(opts)
-    case opts[:type]
+    formatter = Formatter.new(opts.delete(:formatter))
+
+    logger = case opts[:type]
     when :multi_logger
-      loggers = opts[:outputs].map {|logger_opts| build_logger(logger_opts) }
-      MultiLogger.new(loggers)
+      build_multi_logger(opts)
+    when :syslog
+      build_syslog_logger(opts)
     else
-      formatter = Formatter.new(opts.delete(:formatter))
-      device = Device.new(opts)
-
-      ::Logger.new(device).tap do |logger|
-        logger.instance_variable_set(:@device, device)
-        logger.extend(self)
-        logger.extend(TaggedLogging)
-        logger.formatter = formatter
-      end
+      build_default_logger(opts)
     end
+
+    logger.formatter = formatter if formatter
+    logger
+  end
+
+  private
+
+  def self.build_default_logger(opts)
+    device = Device.new(opts)
+    ::Logger.new(device).tap do |logger|
+      logger.instance_variable_set(:@device, device)
+      logger.extend(self)
+      logger.extend(TaggedLogging)
+    end
+  end
+
+  def self.build_multi_logger(opts)
+    loggers = opts[:outputs].map { |logger_opts| build_logger(logger_opts) }
+    MultiLogger.new(loggers)
+  end
+
+  def self.build_syslog_logger(opts)
+    logger = begin
+      Syslog::Logger.new(opts[:program_name], opts[:facility])
+    rescue ArgumentError
+      Syslog::Logger.new(opts[:program_name])
+    end
+
+    logger.extend(self)
+    logger.extend(TaggedLogging)
   end
 end

data/lib/logstash-logger/version.rb

@@ -1,3 +1,3 @@
 module LogStashLogger
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/logstash-logger.gemspec

@@ -25,6 +25,10 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'redis'
   gem.add_development_dependency 'poseidon'
 
+  if RUBY_VERSION < '2'
+    gem.add_development_dependency 'SyslogLogger'
+  end
+
   gem.add_development_dependency 'rspec', '>= 3'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'

data/samples/syslog.conf

@@ -0,0 +1,10 @@
+input {
+  syslog {
+    codec => json_lines
+  }
+}
+output {
+  stdout {
+    codec => json_lines
+  }
+}

data/spec/syslog_spec.rb

@@ -0,0 +1,25 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  context "Syslog" do
+    let(:program_name) { "MyApp" }
+    let(:facility) { Syslog::LOG_LOCAL0 }
+    subject { LogStashLogger.new(type: :syslog, program_name: program_name, facility: facility) }
+    let(:syslog) { subject.class.class_variable_get(:@@syslog) }
+
+    it { is_expected.to be_a Syslog::Logger }
+
+    it "writes formatted messages to syslog" do
+      expect(syslog).to receive(:log)
+      subject.info("test")
+    end
+
+    it "sets the syslog identity" do
+      expect(syslog.ident).to eq(program_name)
+    end
+
+    it "sets the default facility if supported" do
+      expect(subject.facility).to eq(facility) if subject.respond_to?(:facility)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -205,6 +205,7 @@ files:
 - samples/file.conf
 - samples/redis.conf
 - samples/ssl.conf
+- samples/syslog.conf
 - samples/tcp.conf
 - samples/udp.conf
 - samples/unix.conf
@@ -233,6 +234,7 @@ files:
 - spec/multi_logger_spec.rb
 - spec/rails_spec.rb
 - spec/spec_helper.rb
+- spec/syslog_spec.rb
 - spec/tagged_logging_spec.rb
 homepage: http://github.com/dwbutler/logstash-logger
 licenses:
@@ -284,4 +286,5 @@ test_files:
 - spec/multi_logger_spec.rb
 - spec/rails_spec.rb
 - spec/spec_helper.rb
+- spec/syslog_spec.rb
 - spec/tagged_logging_spec.rb