logstash-output-loggly 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b05abc68f0b0f97dcce808afe058e8379c75fe
-  data.tar.gz: 9bad41594e9d4f9464fffbebfe410374984142f2
+  metadata.gz: 6323456ef07633f6509b6a8dfe8a1e15060efc22
+  data.tar.gz: 2bc350d43f9f9f5a7692371a3a2f55c04a6aae5d
 SHA512:
-  metadata.gz: f1419b08088c89e0a787b4cb02ba06035dd7be7d1804ff56ffa5c2b2712e3811d221de6cd82f0c3094b6aefcc9ea64624a9f58a822e5d2759a40ee8a389ea920
-  data.tar.gz: 998805840a88dbce7f9a3b6ff26d9419efe7760b46c8a3a4b8612b62706c8ba13b30f6da472a111af6ef1de711449a5a74c150b9bea54aaef610112fd0594ba4
+  metadata.gz: 763663cd842cffa47291f12f6b4bbe3f8ca8065faaa191897c8c1d000d0ce96c7ed85d18f7e347a442970ea29f2b7f8c80de1136b2864455e38c738efcea5a60
+  data.tar.gz: e2cf37bed1b83b32c9c157f2ad0611f060840fea5304d7117bd877428c7546348511418b2863cba63c917b178bbedcc968042bf9145da8e212e716664937b3c0

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-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,164 @@
+:plugin: loggly
+:type: output
+
+///////////////////////////////////////////
+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}"]
+
+=== Loggly output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Ugly monkey patch to get around http://jira.codehaus.org/browse/JRUBY-5529
+Got a loggly account? Use logstash to ship logs to Loggly!
+
+This is most useful so you can use logstash to parse and structure
+your logs and ship structured, json events to your account at Loggly.
+
+To use this, you'll need to use a Loggly input with type 'http'
+and 'json logging' enabled.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Loggly Output 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}-can_retry>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-key>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-proto>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-proxy_host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-proxy_password>> |<<password,password>>|No
+| <<plugins-{type}s-{plugin}-proxy_port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-proxy_user>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-retry_count>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-tag>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-can_retry"]
+===== `can_retry` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Can Retry.
+Setting this value true helps user to send multiple retry attempts if the first request fails
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logs-01.loggly.com"`
+
+The hostname to send logs to. This should target the loggly http input
+server which is usually "logs-01.loggly.com" (Gen2 account).
+See Loggly HTTP endpoint documentation at
+https://www.loggly.com/docs/http-endpoint/
+
+[id="plugins-{type}s-{plugin}-key"]
+===== `key` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The loggly http input key to send to.
+This is usually visible in the Loggly 'Inputs' page as something like this:
+....
+    https://logs-01.loggly.net/inputs/abcdef12-3456-7890-abcd-ef0123456789
+                                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+                                          \---------->   key   <-------------/
+....
+You can use `%{foo}` field lookups here if you need to pull the api key from
+the event. This is mainly aimed at multitenant hosting providers who want
+to offer shipping a customer's logs to that customer's loggly account.
+
+[id="plugins-{type}s-{plugin}-proto"]
+===== `proto` 
+
+  * Value type is <<string,string>>
+  * Default value is `"http"`
+
+Should the log action be sent over https instead of plain http
+
+[id="plugins-{type}s-{plugin}-proxy_host"]
+===== `proxy_host` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Proxy Host
+
+[id="plugins-{type}s-{plugin}-proxy_password"]
+===== `proxy_password` 
+
+  * Value type is <<password,password>>
+  * Default value is `""`
+
+Proxy Password
+
+[id="plugins-{type}s-{plugin}-proxy_port"]
+===== `proxy_port` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+Proxy Port
+
+[id="plugins-{type}s-{plugin}-proxy_user"]
+===== `proxy_user` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Proxy Username
+
+[id="plugins-{type}s-{plugin}-retry_count"]
+===== `retry_count` 
+
+  * Value type is <<number,number>>
+  * Default value is `5`
+
+Retry count. 
+It may be possible that the request may timeout due to slow Internet connection
+if such condition appears, retry_count helps in retrying request for multiple times
+It will try to submit request until retry_count and then halt
+
+[id="plugins-{type}s-{plugin}-tag"]
+===== `tag` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash"`
+
+Loggly Tag
+Tag helps you to find your logs in the Loggly dashboard easily
+You can make a search in Loggly using tag as "tag:logstash-contrib"
+or the tag set by you in the config file.
+
+You can use %{somefield} to allow for custom tag values.
+Helpful for leveraging Loggly source groups.
+https://www.loggly.com/docs/source-groups/
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-loggly.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-loggly'
-  s.version         = '3.0.0'
+  s.version         = '3.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Got a loggly account? Use logstash to ship logs to Loggly!"
   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/**/*','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-output-loggly
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/loggly.rb
 - logstash-output-loggly.gemspec
 - spec/outputs/loggly_spec.rb