logstash-input-tcp 4.1.0 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e9170fef8955f298473d6ab8d0fb0a5301f915c
-  data.tar.gz: e82dbe475f4d1c4928da2fd73a5e1e82009a038c
+  metadata.gz: 08f07f06c65b618f52c45c54f344183beca7f64f
+  data.tar.gz: df32793b0047844212f1fad6cc1a45dd5cf0dbee
 SHA512:
-  metadata.gz: 202ff3f0feeb6017794bcfd1f9cdc6775066560fffc658fc3429b6064bf2ee5d1cd02f60087d4ce46149e2e52642e7cfe20439a5d1a905a2f09dab1f4e4387c3
-  data.tar.gz: 7491b4f37c8b2b2ff90e8d11922143ae75da7c4cb35d78e487f906219829f941bee949f7b3fc666c1cd06cfd80c88a4eb88bda167df9534e3f3b67635860b389
+  metadata.gz: 035e413e1bcd0093ac595e4cb92cd8ed7733b5bde73e2114559968f1d103814368a25418969907f9e881f00c737034b4fbed8e7c41ddb9234a1c798e26f36904
+  data.tar.gz: 94039950c7de7183b110e84015177b774e0cc91afcca052623ae2e3e2d38694987ec9717256e94fcce519ad95f430a34e31c7e1b67a3e478d09cca6acf022943

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.1.1
+  - Add documentation for how to use tcp input to accept log4j2 data.
+
 ## 4.1.0
   - Add support for proxy protocol
 

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,205 @@
+:plugin: tcp
+: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}"]
+
+=== Tcp input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Read events over a TCP socket.
+
+Like stdin and file inputs, each event is assumed to be one line of text.
+
+Can either accept connections from clients or connect to a server,
+depending on `mode`.
+
+#### Accepting log4j2 logs
+
+Log4j2 can send JSON over a socket, and we can use that combined with our tcp
+input to accept the logs. 
+
+First, we need to configure your application to send logs in JSON over a
+socket. The following log4j2.xml accomplishes this task.
+
+Note, you will want to change the `host` and `port` settings in this
+configuration to match your needs.
+
+    <Configuration>
+      <Appenders>
+         <Socket name="Socket" host="localhost" port="12345">
+           <JsonLayout compact="true" eventEol="true" />
+        </Socket>
+      </Appenders>
+      <Loggers>
+        <Root level="info">
+          <AppenderRef ref="Socket"/>
+        </Root>
+      </Loggers>
+    </Configuration>
+
+To accept this in Logstash, you will want tcp input and a date filter:
+
+    input {
+      tcp {
+        port => 12345
+        codec => json
+      }
+    }
+
+and add a date filter to take log4j2's `timeMillis` field and use it as the
+event timestamp
+
+    filter {
+      date {
+        match => [ "timeMillis", "UNIX_MS" ]
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Tcp 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}-mode>> |<<string,string>>, one of `["server", "client"]`|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|Yes
+| <<plugins-{type}s-{plugin}-proxy_protocol>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-ssl_cert>> |a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-ssl_enable>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-ssl_extra_chain_certs>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-ssl_key>> |a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-ssl_key_passphrase>> |<<password,password>>|No
+| <<plugins-{type}s-{plugin}-ssl_verify>> |<<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}-data_timeout"]
+===== `data_timeout`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<number,number>>
+  * Default value is `-1`
+
+
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"0.0.0.0"`
+
+When mode is `server`, the address to listen on.
+When mode is `client`, the address to connect to.
+
+[id="plugins-{type}s-{plugin}-mode"]
+===== `mode` 
+
+  * Value can be any of: `server`, `client`
+  * Default value is `"server"`
+
+Mode to operate in. `server` listens for client connections,
+`client` connects to a server.
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * This is a required setting.
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+When mode is `server`, the port to listen on.
+When mode is `client`, the port to connect to.
+
+[id="plugins-{type}s-{plugin}-proxy_protocol"]
+===== `proxy_protocol` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Proxy protocol support, only v1 is supported at this time
+http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
+
+[id="plugins-{type}s-{plugin}-ssl_cacert"]
+===== `ssl_cacert`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.
+
+[id="plugins-{type}s-{plugin}-ssl_cert"]
+===== `ssl_cert` 
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+SSL certificate path
+
+[id="plugins-{type}s-{plugin}-ssl_enable"]
+===== `ssl_enable` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Enable SSL (must be set for other `ssl_` options to take effect).
+
+[id="plugins-{type}s-{plugin}-ssl_extra_chain_certs"]
+===== `ssl_extra_chain_certs` 
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+An Array of extra X509 certificates to be added to the certificate chain.
+Useful when the CA chain is not necessary in the system store.
+
+[id="plugins-{type}s-{plugin}-ssl_key"]
+===== `ssl_key` 
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+SSL key path
+
+[id="plugins-{type}s-{plugin}-ssl_key_passphrase"]
+===== `ssl_key_passphrase` 
+
+  * Value type is <<password,password>>
+  * Default value is `nil`
+
+SSL key passphrase
+
+[id="plugins-{type}s-{plugin}-ssl_verify"]
+===== `ssl_verify` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Verify the identity of the other end of the SSL connection against the CA.
+For input, sets the field `sslsubject` to that of the client certificate.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/inputs/tcp.rb

@@ -11,6 +11,48 @@ require "openssl"
 #
 # Can either accept connections from clients or connect to a server,
 # depending on `mode`.
+#
+# #### Accepting log4j2 logs
+#
+# Log4j2 can send JSON over a socket, and we can use that combined with our tcp
+# input to accept the logs. 
+#
+# First, we need to configure your application to send logs in JSON over a
+# socket. The following log4j2.xml accomplishes this task.
+#
+# Note, you will want to change the `host` and `port` settings in this
+# configuration to match your needs.
+#
+#     <Configuration>
+#       <Appenders>
+#          <Socket name="Socket" host="localhost" port="12345">
+#            <JsonLayout compact="true" eventEol="true" />
+#         </Socket>
+#       </Appenders>
+#       <Loggers>
+#         <Root level="info">
+#           <AppenderRef ref="Socket"/>
+#         </Root>
+#       </Loggers>
+#     </Configuration>
+#
+# To accept this in Logstash, you will want tcp input and a date filter:
+#
+#     input {
+#       tcp {
+#         port => 12345
+#         codec => json
+#       }
+#     }
+#
+# and add a date filter to take log4j2's `timeMillis` field and use it as the
+# event timestamp
+#
+#     filter {
+#       date {
+#         match => [ "timeMillis", "UNIX_MS" ]
+#       }
+#     }
 class LogStash::Inputs::Tcp < LogStash::Inputs::Base
   config_name "tcp"
 

data/logstash-input-tcp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-tcp'
-  s.version         = '4.1.0'
+  s.version         = '4.1.2'
   s.licenses      = ['Apache License (2.0)']
   s.summary       = "Read events over a TCP socket."
   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"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*', 'spec/**/*', '*.gemspec', '*.md', 'CONTRIBUTORS', 'Gemfile', 'LICENSE', 'NOTICE.TXT', 'CHANGELOG.md', 'README.md']
+  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-tcp
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/tcp.rb
 - logstash-input-tcp.gemspec
 - spec/inputs/tcp_spec.rb