logstash-input-irc 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4d11786bd33a81ea3a6bdec4821801821e3ddbf
-  data.tar.gz: ac00dac56cc8e64d08ad7d72d87417b64097ba29
+  metadata.gz: bab7922ae64a948dc9e9777323740ebf6b6edeb5
+  data.tar.gz: c74d1b516bf386e0e9e2703296949c95e55d652e
 SHA512:
-  metadata.gz: c7c3b13b8c66725dcd39e489d1c3299f3823531c17591f0c8862efed69426ca88bc9a134e9fce578895e7632bb99278485f0dfe2a916af05d06bab206689855b
-  data.tar.gz: 847637d4d4026e6f615c811f20de213580616da5e31abb26a5c83e1537f3226b5b57696069c56c3142b9340078d7c218c41d3ba1d30246f390efefa36fa538ef
+  metadata.gz: 08fa649522b3e7634746939fa79bea89fe627e292d1515fc614d65ec096c8c0e5cec119edefe1b3cf3bb4b467cdd7c75b2e15a2132f3e460f0c06011c75c7f7b
+  data.tar.gz: aaab1744536f8d60f6ec57cfa9816bc7abedd3ddfbb05cc27edbbbfb0becf0d3530366a9f4b1cf5796222a2e010e41d4f533bed9b1f50079b4ba62b10fc95cfa

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,152 @@
+:plugin: irc
+: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}"]
+
+=== Irc input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Read events from an IRC Server.
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Irc 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}-catch_all>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-channels>> |<<array,array>>|Yes
+| <<plugins-{type}s-{plugin}-get_stats>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-nick>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-real>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-secure>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-stats_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|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}-catch_all"]
+===== `catch_all` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Catch all IRC channel/user events not just channel messages
+
+[id="plugins-{type}s-{plugin}-channels"]
+===== `channels` 
+
+  * This is a required setting.
+  * Value type is <<array,array>>
+  * There is no default value for this setting.
+
+Channels to join and read messages from.
+
+These should be full channel names including the '#' symbol, such as
+"#logstash".
+
+For passworded channels, add a space and the channel password, such as
+"#logstash password".
+
+
+[id="plugins-{type}s-{plugin}-get_stats"]
+===== `get_stats` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Gather and send user counts for channels - this requires catch_all and will force it
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Host of the IRC Server to connect to.
+
+[id="plugins-{type}s-{plugin}-nick"]
+===== `nick` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash"`
+
+IRC Nickname
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * Value type is <<password,password>>
+  * There is no default value for this setting.
+
+IRC Server password
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `6667`
+
+Port for the IRC Server
+
+[id="plugins-{type}s-{plugin}-real"]
+===== `real` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash"`
+
+IRC Real name
+
+[id="plugins-{type}s-{plugin}-secure"]
+===== `secure` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Set this to true to enable SSL.
+
+[id="plugins-{type}s-{plugin}-stats_interval"]
+===== `stats_interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `5`
+
+How often in minutes to get the user count stats
+
+[id="plugins-{type}s-{plugin}-user"]
+===== `user` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash"`
+
+IRC Username
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-irc.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-irc'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read events from an IRC Server."
   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-irc
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 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
@@ -98,6 +98,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/irc.rb
 - logstash-input-irc.gemspec
 - spec/inputs/irc_spec.rb
@@ -124,7 +125,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: Read events from an IRC Server.