logstash-output-sumologic 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ebf5a83834cd6cad674708a813abe835270481
-  data.tar.gz: 930252e23ef4d415f321a5f837bc43ced4b56a74
+  metadata.gz: c38585a7a41b17574d0139b49b68f96dd86c6caf
+  data.tar.gz: 51dab0e2adc69cbbb76d8573d95f74198b0d4520
 SHA512:
-  metadata.gz: bb790a13d2f84126b7ea350ae0413398858f3abef2054063de8fbf56913affef97e116f06950c9df413ece298c1753dc674e540a1e4ef5c05708be02a2b1e67c
-  data.tar.gz: f8ce4d93bf8b70a16a26004df5db415f6bc9c2231504cdfa674a4b17df5ab0057e183d19bdd3fc5f0b3cfe0986d00c109d67fdd845c1e9ac0c732b878ebd50cc
+  metadata.gz: 6d072897edd66361b757354053630f442b68fb9735694ef29967637050dacb6b1566517056dda16cc40f7ee68f4a9539089250e2defc55a2bc7247511fa28064
+  data.tar.gz: 0cfa190f22c120bff2e5a3b9b009960c39011c970c57957465339b52314dd027e39b4801f6978ede25b94fc307a6637c56121a0c3699a956d5f2bc8948ea37b5

data/CONTRIBUTORS

@@ -3,9 +3,9 @@ reports, or in general have helped Sumo Logic plug-in along its way.
 
 Contributors:
 * Bin Yi (bin3377)
-* Brain Goleno (bgoleno)
+* Brian Goleno (bgoleno)
 * Jacek Migdal (jakozaur)
-* Cris Dessonville (cddude229)
+* Chris Dessonville (cddude229)
 
 Note: If you've sent us patches, bug reports, or otherwise contributed to
 Sumo Logic plug-in, and you aren't on the list above and want to be, please let us know

data/README.md

@@ -6,44 +6,67 @@ It is fully free and fully open source. The license is Apache 2.0, meaning you a
 ## Getting Started
 
 ### 1. Create a Sumo Logic HTTP source
-- Create a [Sumo Logic](https://www.sumologic.com/) free account if you currently don't have one.
-- Create a [HTTP source](http://help.sumologic.com/Send_Data/Sources/HTTP_Source) in your account and get the URL for this source. It should be something like 
+Create a [Sumo Logic](https://www.sumologic.com/) free account if you currently don't have one.
+
+Create a [HTTP source](http://help.sumologic.com/Send_Data/Sources/HTTP_Source) in your account and get the URL for this source. It should be something like:
 ```
 https://events.sumologic.net/receiver/v1/http/XXXXXXXXXX
 ```
 
 ### 2. Install LogStash on your machine
-- Following this [instruction](https://www.elastic.co/guide/en/logstash/current/getting-started-with-logstash.html) to download and install LogStash. This plugin require Logstash 2.3 or higher to run.
-
-### 3. Build plugin gem and install to LogStash
-- Build your plugin gem
+Following this [instruction](https://www.elastic.co/guide/en/logstash/current/getting-started-with-logstash.html) to download and install LogStash. This plugin requires Logstash 2.3 or higher to work.
 
+### 3. Build your plugin gem
 In your local Git clone, running:
 ```sh
 gem build logstash-output-sumologic.gemspec
 ```
-
 You will get a .gem file as `logstash-output-sumologic-1.0.0.gem`
 
-- Install plugin into LogStash
-
+### 4. Install plugin into LogStash
 In the Logstash home, running:
 ```sh
 bin/logstash-plugin install <path of .gem>
 ```
 
-### 4. Start Logstash and send log
+### 5. Start Logstash and send log
 In the Logstash home, running:
 ```sh
 bin/logstash -e 'input{stdin{}}output{sumologic{url=>"<url from step 1>"}}'
 ```
-
 This will send any input from console to Sumo Logic cloud service.
 
-### 5. Get result from Sumo Logic web app
-- Logon to Sumo Logic [web app](https://prod-www.sumologic.net/ui/) and run [Search](http://help.sumologic.com/Search) or [Live Tail](http://help.sumologic.com/Search/Live_Tail)
+### 6. Get result from Sumo Logic web app
+Logon to Sumo Logic [web app](https://prod-www.sumologic.net/ui/) and run [Search](http://help.sumologic.com/Search) or [Live Tail](http://help.sumologic.com/Search/Live_Tail)
 
-### Further things
+### Furthermore
 - Try it with different input/filter/codec plugins
 - Start LogStash as a service/daemon in your production environment 
-- Report and issue or idea through [Git Hub](https://github.com/SumoLogic/logstash-output-sumologic)
+- Report any issue or idea through [Git Hub](https://github.com/SumoLogic/logstash-output-sumologic)
+
+## Parameters
+This plugin is based on [logstash-mixin-http_client](https://github.com/logstash-plugins/logstash-mixin-http_client) thus it supports all parameters like proxy, authentication, retry, etc.
+
+And it supports following additional prarmeters:
+```
+  # The URL to send logs to. This should be given when creating a HTTP Source
+  # on Sumo Logic web app. See http://help.sumologic.com/Send_Data/Sources/HTTP_Source
+  config :url, :validate => :string, :required => true
+
+  # Include extra HTTP headers on request if needed 
+  config :extra_headers, :validate => :hash, :default => []
+
+  # The formatter of message, by default is message with timestamp and host as prefix
+  config :format, :validate => :string, :default => "%{@timestamp} %{host} %{message}"
+
+  # Hold messages for at least (x) seconds as a pile; 0 means sending every events immediately  
+  config :interval, :validate => :number, :default => 0
+
+  # Compress the payload 
+  config :compress, :validate => :boolean, :default => false
+
+```
+
+
+
+

data/lib/logstash/outputs/sumologic.rb

@@ -18,14 +18,14 @@ class LogStash::Outputs::SumoLogic < LogStash::Outputs::Base
   
   config_name "sumologic"
   
-  # The hostname to send logs to. This should be given when creating a HTTP Source
-  # on Sumo Logic web app http://help.sumologic.com/Send_Data/Sources/HTTP_Source
+  # The URL to send logs to. This should be given when creating a HTTP Source
+  # on Sumo Logic web app. See http://help.sumologic.com/Send_Data/Sources/HTTP_Source
   config :url, :validate => :string, :required => true
 
   # Include extra HTTP headers on request if needed 
   config :extra_headers, :validate => :hash, :default => []
 
-  # The formatter of message, by default is message with timestamp as prefix
+  # The formatter of message, by default is message with timestamp and host as prefix
   config :format, :validate => :string, :default => "%{@timestamp} %{host} %{message}"
 
   # Hold messages for at least (x) seconds as a pile; 0 means sending every events immediately  

data/logstash-output-sumologic.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-output-sumologic'
-  s.version = "1.0.0"
+  s.version = "1.0.1"
   s.licenses = ["Apache-2.0"]
   s.summary = "Deliever the log to Sumo Logic cloud service."
-  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.description = "This gem is a Logstash output plugin to deliver the log to Sumo Logic cloud service. Go to https://github.com/SumoLogic/logstash-output-sumologic for getting help, reporting issues, etc."
   s.authors = ["Sumo Logic"]
   s.email = "byi@sumologic.com"
   s.homepage = "http://www.sumologic.com"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-sumologic
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sumo Logic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -58,9 +58,9 @@ dependencies:
     - - ">="
       - !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
+description: This gem is a Logstash output plugin to deliver the log to Sumo Logic
+  cloud service. Go to https://github.com/SumoLogic/logstash-output-sumologic for
+  getting help, reporting issues, etc.
 email: byi@sumologic.com
 executables: []
 extensions: []