logstash-input-gelf 3.0.2 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc20827353efc7254630086d49fc58ad5e1d8180
-  data.tar.gz: 1acc940d9b7881b168575fa7082f2bc65504eb80
+  metadata.gz: e3815773b0e5e5d3fc957e5f8c883b4e2d8ce31e
+  data.tar.gz: d3f5373c5fe714040a4e612b652ea1b0cf65e088
 SHA512:
-  metadata.gz: 7d9d02333e299d4fad2fa8c2c308f6c8e6b967a08ae9c47c09fced30e52800a4e5fc6b2e3698d54fa1a36b3819b474749a0029b155c198203f3ba5b303d78fca
-  data.tar.gz: 37d4b838f13788e6c9ff96f30df3ae85368eaf132ed9962264d1c5fa9da85f548ca8f19b1fbab8a8097d8d5c224b273aab3cf3add9db2d802f36fa0cf708dda4
+  metadata.gz: c895c6d5eca4ab32a0cbd7c3c49ca78b8271cd063a7ca629c3e8e65f903bb174fce9e520b55be3bd43f32f746872f9683dfe3f3d849edbc3b71e6d5dae789759
+  data.tar.gz: bfbd7588a98b2f00d5d7a4de3454ec40f0c8588735bdc6c515e170a1dd749164c864b0204c7f2f8b67c41c1ebdfa8e2a2ac8d7a927df55f12649096413b608b9

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.3
+  - Docs: Update doc examples to use new event API syntax 
+
 ## 3.0.2
   - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
 

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,105 @@
+:plugin: gelf
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Gelf input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This input will read GELF messages as events over the network,
+making it a good choice if you already use Graylog2 today.
+
+The main use case for this input is to leverage existing GELF
+logging libraries such as the GELF log4j appender. A library used
+by this plugin has a bug which prevents it parsing uncompressed data.
+If you use the log4j appender you need to configure it like this to force
+gzip even for small messages:
+
+  <Socket name="logstash" protocol="udp" host="logstash.example.com" port="5001">
+     <GelfLayout compressionType="GZIP" compressionThreshold="1" />
+  </Socket>
+
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Gelf Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-remap>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-strip_leading_underscore>> |<<boolean,boolean>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"0.0.0.0"`
+
+The IP address or hostname to listen on.
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `12201`
+
+The port to listen on. Remember that ports less than 1024 (privileged
+ports) may require root to use.
+
+[id="plugins-{type}s-{plugin}-remap"]
+===== `remap` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Whether or not to remap the GELF message fields to Logstash event fields or
+leave them intact.
+
+Remapping converts the following GELF fields to Logstash equivalents:
+
+* `full\_message` becomes `event.get("message")`.
+* if there is no `full\_message`, `short\_message` becomes `event.get("message")`.
+
+[id="plugins-{type}s-{plugin}-strip_leading_underscore"]
+===== `strip_leading_underscore` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Whether or not to remove the leading `\_` in GELF fields or leave them
+in place. (Logstash < 1.2 did not remove them by default.). Note that
+GELF version 1.1 format now requires all non-standard fields to be added
+as an "additional" field, beginning with an underscore.
+
+e.g. `\_foo` becomes `foo`
+
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/inputs/gelf.rb

@@ -38,8 +38,8 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
   #
   # Remapping converts the following GELF fields to Logstash equivalents:
   #
-  # * `full\_message` becomes `event["message"]`.
-  # * if there is no `full\_message`, `short\_message` becomes `event["message"]`.
+  # * `full\_message` becomes `event.get("message")`.
+  # * if there is no `full\_message`, `short\_message` becomes `event.get("message")`.
   config :remap, :validate => :boolean, :default => true
 
   # Whether or not to remove the leading `\_` in GELF fields or leave them

data/logstash-input-gelf.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-gelf'
-  s.version         = '3.0.2'
+  s.version         = '3.0.4'
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-gelf
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/gelf.rb
 - logstash-input-gelf.gemspec
 - spec/inputs/gelf_spec.rb
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+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.