logstash-input-gelfx 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6948305aa36cdbbc985d055d43b190ab73420c4
+  data.tar.gz: 9e69725af6292ef8239d866cf100ae4be550006d
+SHA512:
+  metadata.gz: 18ac409ad7295e05ff78e8c9b0060293e10ef080681283aad4395f04ae50b0bc43b51b1c4a72bf4252238b189de9303a3d6eea6e9cf3d0cea25a4d0d4a1ce3ba
+  data.tar.gz: 938a4d884c46e1813b7a7c88167238fb91d09bba7ec218266b7b07f00d808a5a0fa483ee99338a9bb80ace6f5ecb3eed9c63213962d24f7a6bf01ecbf6766545

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## 3.0.2
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+
+## 3.0.1
+  - Republish all the gems under jruby.
+## 3.0.0
+  - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
+## 2.0.8
+  - Make the `Event.from_json` return a single element instead of an array and make this plugin works under 5.0
+## 2.0.7
+  - Fix failing test caused by reverting Java Event back to Ruby Event
+## 2.0.6
+  - Fix plugin crash when Logstash::Json fails to parse a message, https://github.com/logstash-plugins/logstash-input-gelf/pull/27
+## 2.0.5
+  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+## 2.0.4
+  - New dependency requirements for logstash-core for the 5.0 release
+## 2.0.3
+ - Fix Timestamp coercion to preserve upto microsecond precision, https://github.com/logstash-plugins/logstash-input-gelf/pull/35
+## 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/CONTRIBUTORS

@@ -0,0 +1,23 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Bernd Ahlers (bernd)
+* Chris McCoy (lofidellity)
+* Colin Surprenant (colinsurprenant)
+* JeremyEinfeld
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* Kurt Hurtado (kurtado)
+* Nick Ethier (nickethier)
+* Pete Fritchman (fetep)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+* joe miller (joemiller)
+* Guy Boertje (guyboertje)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logstash-mass_effect.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+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.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,103 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Modification by Leffen
+I am using the gelf plugin as a forwarder to rabbitmq and a "possible" way to enhance the data. 
+So I have removed all intrinsic changes to the messages so they go unmodified from source to destination.
+Only adding source_host as a field. Also only support logstash 2.3 and above. Espesiaclly bothersome with official version
+is the meddeling with the timestamp.
+
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+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
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# 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
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/gelf.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/json"
+require "logstash/timestamp"
+require "stud/interval"
+require "date"
+require "socket"
+
+# This input will read GELF messages as events over the network,
+# making it a good choice if you already use Graylog2 today.
+#
+#
+class LogStash::Inputs::Gelf < LogStash::Inputs::Base
+  config_name "gelfx"
+
+  default :codec, "plain"
+
+  # The IP address or hostname to listen on.
+  config :host, :validate => :string, :default => "0.0.0.0"
+
+  # The port to listen on. Remember that ports less than 1024 (privileged
+  # ports) may require root to use.
+  config :port, :validate => :number, :default => 9397
+
+
+  RECONNECT_BACKOFF_SLEEP = 5
+  TIMESTAMP_GELF_FIELD = "timestamp".freeze
+  SOURCE_HOST_FIELD = "source_host".freeze
+  MESSAGE_FIELD = "message"
+  TAGS_FIELD = "tags"
+  PARSE_FAILURE_TAG = "_jsonparsefailure"
+  PARSE_FAILURE_LOG_MESSAGE = "JSON parse failure. Falling back to plain-text"
+
+  public
+  def initialize(params)
+    super
+    BasicSocket.do_not_reverse_lookup = true
+  end # def initialize
+
+  public
+  def register
+    require 'gelfd'
+  end # def register
+
+  public
+  def run(output_queue)
+    begin
+      # udp server
+      udp_listener(output_queue)
+    rescue => e
+      unless stop?
+        @logger.warn("gelf listener died", :exception => e, :backtrace => e.backtrace)
+        Stud.stoppable_sleep(RECONNECT_BACKOFF_SLEEP) { stop? }
+        retry unless stop?
+      end
+    end # begin
+  end # def run
+
+  public
+  def stop
+    @udp.close
+  rescue IOError # the plugin is currently shutting down, so its safe to ignore theses errors
+  end
+
+  private
+  def udp_listener(output_queue)
+    @logger.info("Starting gelf listener", :address => "#{@host}:#{@port}")
+
+    @udp = UDPSocket.new(Socket::AF_INET)
+    @udp.bind(@host, @port)
+
+    while !stop?
+      line, client = @udp.recvfrom(8192)
+
+      begin
+        data = Gelfd::Parser.parse(line)
+      rescue => ex
+        @logger.warn("Gelfd failed to parse a message skipping", :exception => ex, :backtrace => ex.backtrace)
+        next
+      end
+
+      # Gelfd parser outputs null if it received and cached a non-final chunk
+      next if data.nil?
+
+      event = self.class.new_event(data, client[3])
+      next if event.nil?
+
+      output_queue << event
+    end
+  end # def udp_listener
+
+  def self.new_event(json_gelf, host)
+    event = parse(json_gelf)
+    return if event.nil?
+
+    event.set(SOURCE_HOST_FIELD, host)
+
+    event
+  end
+
+
+  # from_json_parse uses the Event#from_json method to deserialize and directly produce events
+  def self.from_json_parse(json)
+    # from_json will always return an array of item.
+    # in the context of gelf, the payload should be an array of 1
+    LogStash::Event.from_json(json).first
+  rescue LogStash::Json::ParserError => e
+    logger.error(PARSE_FAILURE_LOG_MESSAGE, :error => e, :data => json)
+    LogStash::Event.new(MESSAGE_FIELD => json, TAGS_FIELD => [PARSE_FAILURE_TAG, '_fromjsonparser'])
+  end # def self.from_json_parse
+end # class LogStash::Inputs::Gelf

data/logstash-input-gelfx.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-input-gelfx'
+  s.version         = '1.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This input will read GELF messages as events over the network, making it a good choice if you already use Graylog2 today."
+  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"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+
+  s.add_runtime_dependency "gelfd", ["0.2.0"]                 #(Apache 2.0 license)
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency "stud", "~> 0.0.22"
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency "gelf", ["1.3.2"]                  #(MIT license)
+  s.add_development_dependency "flores"
+end

data/spec/inputs/gelf_spec.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/gelf"
+require_relative "../support/helpers"
+require "gelf"
+require "flores/random"
+
+describe LogStash::Inputs::Gelf do
+  context "when interrupting the plugin" do
+    let(:port) { Flores::Random.integer(1024..65535) }
+    let(:host) { "127.0.0.1" }
+    let(:chunksize) { 1420 }
+    let(:producer) { InfiniteGelfProducer.new(host, port, chunksize) }
+    let(:config) { {"host" => host, "port" => port} }
+
+    before { producer.run }
+    after { producer.stop }
+
+
+    it_behaves_like "an interruptible input plugin"
+  end
+
+  it "reads chunked gelf messages " do
+    port = 12209
+    host = "127.0.0.1"
+    chunksize = 1420
+    gelfclient = GELF::Notifier.new(host, port, chunksize)
+
+    conf = <<-CONFIG
+      input {
+        gelfx {
+          port => "#{port}"
+          host => "#{host}"
+        }
+      }
+    CONFIG
+
+    large_random = 2000.times.map { 32 + rand(126 - 32) }.join("")
+
+    messages = [
+      "hello",
+      "world",
+      large_random,
+      "we survived gelf!"
+    ]
+
+    events = input(conf) do |pipeline, queue|
+      # send a first message until plugin is up and receives it
+      while queue.size <= 0
+        gelfclient.notify!("short_message" => "prime")
+        sleep(0.1)
+      end
+      gelfclient.notify!("short_message" => "start")
+
+      e = queue.pop
+      while (e.get("message") != "start")
+        e = queue.pop
+      end
+
+      messages.each do |m|
+        gelfclient.notify!("short_message" => m)
+      end
+
+      messages.map { queue.pop }
+    end
+
+    events.each_with_index do |e, i|
+      insist { e.get("message") } == messages[i]
+      insist { e.get("host") } == Socket.gethostname
+    end
+  end
+
+
+  context "when an invalid JSON is fed to the listener" do
+    subject { LogStash::Inputs::Gelf.new_event(message, "host") }
+    let(:message) { "Invalid JSON message" }
+
+    context "default :from_json parser output" do
+      it { should be_a(LogStash::Event) }
+
+      it "falls back to plain-text" do
+        expect(subject.get("message")).to eq(message)
+      end
+
+      it "tags message with _jsonparsefailure" do
+        expect(subject.get("tags")).to include("_jsonparsefailure")
+      end
+
+      it "tags message with _fromjsonparser" do
+        expect(subject.get("tags")).to include("_fromjsonparser")
+      end
+    end
+  end
+end

data/spec/support/helpers.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+class InfiniteGelfProducer
+  def initialize(host, port, chunksize)
+    @client = GELF::Notifier.new(host, port, chunksize)
+  end
+
+  def run
+    @producer = Thread.new do
+      while true
+        @client.notify!("short_message" => "hello world")
+      end
+    end
+  end
+
+  def stop
+    @producer.kill
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-gelfx
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  name: gelfd
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  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.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  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: 1.3.2
+  name: gelf
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: flores
+  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/logstash-plugin install gemname. This gem is not a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/inputs/gelf.rb
+- logstash-input-gelfx.gemspec
+- spec/inputs/gelf_spec.rb
+- spec/support/helpers.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message:
+rdoc_options: []
+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.8
+signing_key:
+specification_version: 4
+summary: This input will read GELF messages as events over the network, making it a good choice if you already use Graylog2 today.
+test_files:
+- spec/inputs/gelf_spec.rb
+- spec/support/helpers.rb