logstash-output-syslog 2.1.4 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b92e5d61f021cd8d630b491520f02c233bcae7df
-  data.tar.gz: b50cc369e79d9ab4552de7c46a5cb57d9807bd65
+  metadata.gz: 0dc9077162c64d40cf296402a0bb0e936f9de3d2
+  data.tar.gz: 790819973615929988a5c0f5ac622f6d3e3e62ac
 SHA512:
-  metadata.gz: 258ad74f7c730a7fcb41ffcc6961218f1649a5657d9d2d6d856cf3870da347c22abba9359d608df36fe2a264f947e187e01242c8a9aaf0a16e7ed9afe5f4155e
-  data.tar.gz: c9df5387c61c812eea0c719bfac116a61f1b5ae45929b05a4c39c24e9aa3d2aa5545602bcf8c429ffe87015bc6350b4ad4b17d1d0a8ac6a00d67dd85daa29c19
+  metadata.gz: 1fb8e7e2079dc6f8755be685ff626a44aeb9d0b5c72f7e91918c76e3fcc58e1fa6a0932e89107f55bb05d5dba76765503af407bd9b07f108c2ad2cc9ba6e1765
+  data.tar.gz: 9ce3ba29d2a1b4bfbcf222e31ea5e2e944a96d088066a28b6c8caa63218c9cea6c969fe288b52fed22f396bad7cf3bfd330889e45e5486f646788106ae7ef8a2

data/CHANGELOG.md

@@ -1,9 +1,22 @@
-# 2.1.4
+## 3.0.1
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+
+## 3.0.0
+ - breaking,config: Remove deprecated `timestamp` config.
+ - internal: migrate to Logstash Event API 2.0
+
+## 2.1.5
+ - [Internal] test fix to not depend on json order
+
+## 2.1.4
  - [Internal] fix tests
-# 2.1.3
+
+## 2.1.3
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
-# 2.1.2
+
+## 2.1.2
   - New dependency requirements for logstash-core for the 5.0 release
+
 ## 2.1.1
  - Add SSL/TLS support to syslog output plugin (thanks @breml)
  - Added ability to use codecs for this output (thanks @breml)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-syslog-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-syslog-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-output-syslog.svg)](https://travis-ci.org/logstash-plugins/logstash-output-syslog)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,7 +55,12 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
 - Install plugin
 ```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
 bin/plugin install --no-verify
+
 ```
 - Run Logstash with your plugin
 ```sh
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
 ```
 - Start Logstash and proceed to test the plugin
 

data/lib/logstash/outputs/syslog.rb

@@ -106,9 +106,6 @@ class LogStash::Outputs::Syslog < LogStash::Outputs::Base
   # to help you build a new value from other parts of the event.
   config :sourcehost, :validate => :string, :default => "%{host}"
 
-  # timestamp for syslog message
-  config :timestamp, :validate => :string, :default => "%{@timestamp}", :deprecated => "This setting is no longer necessary. The RFC setting will determine what time format is used."
-
   # application name for syslog message. The new value can include `%{foo}` strings
   # to help you build a new value from other parts of the event.
   config :appname, :validate => :string, :default => "LOGSTASH"

data/logstash-output-syslog.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-syslog'
-  s.version         = '2.1.4'
+  s.version         = '3.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"
+  s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
   s.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
   s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_runtime_dependency 'logstash-codec-plain'
 
   s.add_development_dependency 'logstash-devutils'

data/spec/outputs/syslog_spec.rb

@@ -3,9 +3,13 @@
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/outputs/syslog"
 require "logstash/codecs/plain"
+require "json"
 
 describe LogStash::Outputs::Syslog do
 
+  RFC3164_DATE_TIME_REGEX = "(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) (0[1-9]|[12][0-9]|3[01]) ([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)"
+  RFC3339_DATE_TIME_REGEX = "([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{3})?([Zz]|([+-]([01][0-9]|2[0-3]):[0-5][0-9]))"
+
   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
@@ -30,21 +34,21 @@ describe LogStash::Outputs::Syslog do
 
   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 }
+    let(:output) { /^<0>#{RFC3164_DATE_TIME_REGEX} 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 }
+    let(:output) { /^<0>1 #{RFC3339_DATE_TIME_REGEX} 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 }
+    let(:output) { /^<18>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: bar\n/m }
 
     it_behaves_like "syslog output"
   end
@@ -52,7 +56,7 @@ describe LogStash::Outputs::Syslog do
   context "sprintf rfc 3164" do
     let(:event) { LogStash::Event.new({"message" => "bar", "host" => "baz", "facility" => "mail", "severity" => "critical", "appname" => "appname", "procid" => "1000" }) }
     let(:options) { {"host" => "foo", "port" => "123", "facility" => "%{facility}", "severity" => "%{severity}", "appname" => "%{appname}", "procid" => "%{procid}"} }
-    let(:output) { /^<18>.+baz appname\[1000\]: bar\n/m }
+    let(:output) { /^<18>#{RFC3164_DATE_TIME_REGEX} baz appname\[1000\]: bar\n/m }
 
     it_behaves_like "syslog output"
   end
@@ -60,7 +64,7 @@ describe LogStash::Outputs::Syslog do
   context "sprintf rfc 5424" do
     let(:event) { LogStash::Event.new({"message" => "bar", "host" => "baz", "facility" => "mail", "severity" => "critical", "appname" => "appname", "procid" => "1000", "msgid" => "2000" }) }
     let(:options) { {"rfc" => "rfc5424", "host" => "foo", "port" => "123", "facility" => "%{facility}", "severity" => "%{severity}", "appname" => "%{appname}", "procid" => "%{procid}", "msgid" => "%{msgid}"} }
-    let(:output) { /^<18>1 .+baz appname 1000 2000 - bar\n/m }
+    let(:output) { /^<18>1 #{RFC3339_DATE_TIME_REGEX} baz appname 1000 2000 - bar\n/m }
 
     it_behaves_like "syslog output"
   end
@@ -68,7 +72,7 @@ describe LogStash::Outputs::Syslog do
   context "use_labels == false, default" do
     let(:event) { LogStash::Event.new({"message" => "bar", "host" => "baz" }) }
     let(:options) { {"use_labels" => false, "host" => "foo", "port" => "123" } }
-    let(:output) { /^<13>.+baz LOGSTASH\[-\]: bar\n/m }
+    let(:output) { /^<13>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: bar\n/m }
 
     it_behaves_like "syslog output"
   end
@@ -76,7 +80,7 @@ describe LogStash::Outputs::Syslog do
   context "use_labels == false, syslog_pri" do
     let(:event) { LogStash::Event.new({"message" => "bar", "host" => "baz", "syslog_pri" => "18" }) }
     let(:options) { {"use_labels" => false, "host" => "foo", "port" => "123" } }
-    let(:output) { /^<18>.+baz LOGSTASH\[-\]: bar\n/m }
+    let(:output) { /^<18>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: bar\n/m }
 
     it_behaves_like "syslog output"
   end
@@ -84,7 +88,7 @@ describe LogStash::Outputs::Syslog do
   context "use_labels == false, sprintf" do
     let(:event) { LogStash::Event.new({"message" => "bar", "host" => "baz", "priority" => "18" }) }
     let(:options) { {"use_labels" => false, "host" => "foo", "port" => "123", "priority" => "%{priority}" } }
-    let(:output) { /^<18>.+baz LOGSTASH\[-\]: bar\n/m }
+    let(:output) { /^<18>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: bar\n/m }
 
     it_behaves_like "syslog output"
   end
@@ -92,35 +96,46 @@ describe LogStash::Outputs::Syslog do
   context "use plain codec with format set" do
     let(:plain) { LogStash::Codecs::Plain.new({"format" => "%{host} %{message}"}) }
     let(:options) { {"host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency", "codec" => plain} }
-    let(:output) { /^<0>.+baz LOGSTASH\[-\]: baz bar\n/m }
+    let(:output) { /^<0>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: baz bar\n/m }
 
     it_behaves_like "syslog output"
   end
 
   context "use codec json" do
     let(:options) { {"host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency", "codec" => "json" } }
-    let(:output) { /^<0>.+baz LOGSTASH\[-\]: {\"@timestamp\":\"[0-9TZ:.+-]+\",\"host\":\"baz\",\"@version\":\"1\",\"message\":\"bar\"}\n/m }
 
-    it_behaves_like "syslog output"
+    it "should write event encoded with json codec" do
+      expect(subject).to receive(:connect).and_return(socket)
+      expect(socket).to receive(:write) do |arg|
+        message = arg[/^<0>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: (.*)/, 1]
+        expect(message).not_to be_nil
+        message_json = JSON.parse(message)
+        expect(message_json).to include("@timestamp")
+        expect(message_json).to include("host" => "baz")
+        expect(message_json).to include("@version" => "1")
+        expect(message_json).to include("message" => "bar")
+      end
+      subject.receive(event)
+    end
   end
 
   context "escape carriage return, newline and newline to \\n" do
     let(:options) { {"host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency", "message" => "foo\r\nbar\nbaz" } }
-    let(:output) { /^<0>.+baz LOGSTASH\[-\]: foo\\nbar\\nbaz\n/m }
+    let(:output) { /^<0>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: foo\\nbar\\nbaz\n/m }
 
     it_behaves_like "syslog output"
   end
 
   context "tailing newline" do
     let(:options) { {"host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency", "message" => "%{message}\n" } }
-    let(:output) { /^<0>.+baz LOGSTASH\[-\]: bar\n/m }
+    let(:output) { /^<0>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: bar\n/m }
 
     it_behaves_like "syslog output"
   end
 
   context "tailing carriage return and newline (windows)" do
     let(:options) { {"host" => "foo", "port" => "123", "facility" => "kernel", "severity" => "emergency", "message" => "%{message}\n" } }
-    let(:output) { /^<0>.+baz LOGSTASH\[-\]: bar\n/m }
+    let(:output) { /^<0>#{RFC3164_DATE_TIME_REGEX} baz LOGSTASH\[-\]: bar\n/m }
 
     it_behaves_like "syslog output"
   end

metadata

@@ -1,33 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-syslog
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
   name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-plain
@@ -35,13 +41,13 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
@@ -49,13 +55,13 @@ dependencies:
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !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-json
@@ -63,10 +69,10 @@ dependencies:
   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
+description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
@@ -93,17 +99,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.5
+rubygems_version: 2.6.3
 signing_key:
 specification_version: 4
 summary: Send events to a syslog server.