logstash-output-syslog 0.2.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adf244fc4a07c51b9b7f855fd561c04904f07776
-  data.tar.gz: 02c9b31239c8090938d623b19a091d0a67d7e446
+  metadata.gz: 7cd1c6f93332773cecd2bde660aeb2abccb1a06e
+  data.tar.gz: d289eee9433c4f862508899141950508fbcc6ce8
 SHA512:
-  metadata.gz: 642bae90d7875e24535ec18c8162883f86b78a0eb6feed53124e20e182c3dd3dcf2b55cb0a327c5dfeb97dde765a2e996ad39044ed60d825b50f8866031ac9ec
-  data.tar.gz: cdf6c9fdc485edde59acfc49c21eacd8b5a3a85fc20b50ca9ffc14186ad87526e36e787e4967ebfdc6e8fe792f94af3b46addbe17b9b0bf9d4ec2653ad9ec95d
+  metadata.gz: cebbcc9f6525888316022d6d7ced9aa64437ff9a5e187f3e828687cbbfe3d19885324f9bc82a6a898f92d8cfe9d67fe9a12d8da0a6c7ce0fa8d99577cfff5d19
+  data.tar.gz: 984d9deeceeff73ba0b912aa935391d9abb1f2449d65b72a5f104f413707c9251eaa98cb259ed4e7623db459142f576fb403c0c3ff4a666d0a213e6f0925396a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/lib/logstash/outputs/syslog.rb

@@ -57,13 +57,10 @@ class LogStash::Outputs::Syslog < LogStash::Outputs::Base
 
   # syslog server address to connect to
   config :host, :validate => :string, :required => true
-
+  
   # syslog server port to connect to
   config :port, :validate => :number, :required => true
 
-  # when connection fails, retry interval in sec.
-  config :reconnect_interval, :validate => :number, :default => 1
-
   # syslog server protocol. you can choose between udp and tcp
   config :protocol, :validate => ["tcp", "udp"], :default => "udp"
 
@@ -87,67 +84,71 @@ class LogStash::Outputs::Syslog < LogStash::Outputs::Base
 
   # message text to log
   config :message, :validate => :string, :default => "%{message}"
-
+ 
   # message id for syslog message
   config :msgid, :validate => :string, :default => "-"
 
   # syslog message format: you can choose between rfc3164 or rfc5424
   config :rfc, :validate => ["rfc3164", "rfc5424"], :default => "rfc3164"
 
+  
+  public
   def register
-    @client_socket = nil
+      @client_socket = nil
+  end
 
-    facility_code = FACILITY_LABELS.index(@facility)
-    severity_code = SEVERITY_LABELS.index(@severity)
-    @priority = (facility_code * 8) + severity_code
+  private
+  def udp?
+    @protocol == "udp"
+  end
+
+  private
+  def rfc3164?
+    @rfc == "rfc3164"
+  end 
 
-    # use instance variable to avoid string comparison for each event
-    @is_rfc3164 = (@rfc == "rfc3164")
+  private
+  def connect
+    if udp?
+        @client_socket = UDPSocket.new
+        @client_socket.connect(@host, @port)
+    else
+        @client_socket = TCPSocket.new(@host, @port)
+    end
   end
 
+  public
   def receive(event)
-    return unless output?(event)
+    
 
     appname = event.sprintf(@appname)
     procid = event.sprintf(@procid)
     sourcehost = event.sprintf(@sourcehost)
 
-    if @is_rfc3164
+    facility_code = FACILITY_LABELS.index(@facility)
+
+    severity_code = SEVERITY_LABELS.index(@severity)
+
+    priority = (facility_code * 8) + severity_code
+
+    if rfc3164?
       timestamp = event.sprintf("%{+MMM dd HH:mm:ss}")
-      syslog_msg = "<#{@priority.to_s}>#{timestamp} #{sourcehost} #{appname}[#{procid}]: #{event.sprintf(@message)}"
+      syslog_msg = "<"+priority.to_s()+">"+timestamp+" "+sourcehost+" "+appname+"["+procid+"]: "+event.sprintf(@message)
     else
       msgid = event.sprintf(@msgid)
       timestamp = event.sprintf("%{+YYYY-MM-dd'T'HH:mm:ss.SSSZZ}")
-      syslog_msg = "<#{@priority.to_s}>1 #{timestamp} #{sourcehost} #{appname} #{procid} #{msgid} - #{event.sprintf(@message)}"
+      syslog_msg = "<"+priority.to_s()+">1 "+timestamp+" "+sourcehost+" "+appname+" "+procid+" "+msgid+" - "+event.sprintf(@message)
     end
 
     begin
-      @client_socket ||= connect
+      connect unless @client_socket
       @client_socket.write(syslog_msg + "\n")
     rescue => e
-      @logger.warn("syslog " + @protocol + " output exception: closing, reconnecting and resending event", :host => @host, :port => @port, :exception => e, :backtrace => e.backtrace, :event => event)
+      @logger.warn(@protocol+" output exception", :host => @host, :port => @port,
+                 :exception => e, :backtrace => e.backtrace)
       @client_socket.close rescue nil
       @client_socket = nil
-
-      sleep(@reconnect_interval)
-      retry
-    end
-  end
-
-  private
-
-  def udp?
-    @protocol == "udp"
-  end
-
-  def connect
-    socket = nil
-    if udp?
-      socket = UDPSocket.new
-      socket.connect(@host, @port)
-    else
-      socket = TCPSocket.new(@host, @port)
     end
-    socket
   end
 end
+

data/logstash-output-syslog.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-syslog'
-  s.version         = '0.2.0'
+  s.version         = '2.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Send events to a syslog server."
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,9 +20,8 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.snapshot", "< 3.0.0"
 
   s.add_development_dependency 'logstash-devutils'
-  s.add_development_dependency 'logstash-codec-plain'
 end
 

data/spec/outputs/syslog_spec.rb

@@ -1,50 +1 @@
-# encoding: utf-8
-
 require "logstash/devutils/rspec/spec_helper"
-require "logstash/outputs/syslog"
-
-describe LogStash::Outputs::Syslog do
-
-  it "should register without errors" do
-    plugin = LogStash::Plugin.lookup("output", "syslog").new({"host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency"})
-    expect { plugin.register }.to_not raise_error
-  end
-
-  subject do
-    plugin = LogStash::Plugin.lookup("output", "syslog").new(options)
-    plugin.register
-    plugin
-  end
-
-  let(:socket) { double("fake socket") }
-  let(:event) { LogStash::Event.new({"message" => "bar", "host" => "baz"}) }
-
-  shared_examples "syslog output" do
-    it "should write expected format" do
-      expect(subject).to receive(:connect).and_return(socket)
-      expect(socket).to receive(:write).with(output)
-      subject.receive(event)
-    end
-  end
-
-  context "rfc 3164 and udp by default" do
-    let(:options) { {"host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency"} }
-    let(:output) { /^<0>.+baz LOGSTASH\[-\]: bar\n/m }
-
-    it_behaves_like "syslog output"
-  end
-
-  context "rfc 5424 and tcp" do
-    let(:options) { {"rfc" => "rfc5424", "protocol" => "tcp", "host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency"} }
-    let(:output) { /^<0>1 .+baz LOGSTASH - - - bar\n/m }
-
-    it_behaves_like "syslog output"
-  end
-
-  context "calculate priority" do
-    let(:options) { {"host" => "foo", "port" => "123", "facility" => "mail", "severity" => "critical"} }
-    let(:output) { /^<18>.+baz LOGSTASH\[-\]: bar\n/m }
-
-    it_behaves_like "syslog output"
-  end
-end

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-syslog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   name: logstash-core
   prerelease: false
   type: :runtime
@@ -26,10 +26,10 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -44,34 +44,18 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-codec-plain
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/outputs/syslog.rb
 - logstash-output-syslog.gemspec
 - spec/outputs/syslog_spec.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"