hshek-logstash-output-sumologic 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ab0c4c2b9fd38780ff28615212ace0688a4f18b7df9a7a8f57ac625d97495f6
+  data.tar.gz: 60c1c4671459227367525a7bc0b00e011f22260b262fba6e01a139fa20d69b3e
+SHA512:
+  metadata.gz: 8bc7deee7fee975ce9034111e1f6e3c411c333e8f9d57d5a737217d6769cfc194175ee5349f6742424f96278ec2f64b70f2511cfbc2f0a44b7f3278aff57dab4
+  data.tar.gz: 93136d49ed12051198d10e88f120a484e12cd0ca202db095a220ea4aeb1359571bb38ee66e325c6bc85f848240eafad3f5a7474ebcfdf2d041aa4abbd8b2c8cb

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Change Log
+
+## 1.2.3
+- #36
+  - Update sender to send in batch.
+  - Support %{} field evaluation in `source_category`, `source_name`, `source_host` parameters
+- #39 Disable cookies by default
+- #41
+  - Provide Docker image with Logstash 6.6 + output plugin on docker hub
+  - Kubernetes support with Logstash beats to SumoLogic
+  - CI improving
+
+## 1.2.2
+
+- Bug fix: memory leak when using `%{@json}` in format
+
+## 1.2.1
+
+- Bug fix on plug-in logging and samples
+
+## 1.2.0
+
+- Support message piling with both `interval` and `pile_max`
+- Support in memory message queue to overall enhance throughput
+- Retry sending when get throttled or temporary server problem
+- Support monitor throughput statistics in metrics
+
+## 1.1.0
+
+- Support metrics sending
+
+## 1.0.0
+
+- Initial release

data/DEVELOPER.md

@@ -0,0 +1,39 @@
+# Development Guide
+
+Logstash output plugin for delivering log to Sumo Logic cloud service through HTTP source.
+
+## How to build .gem file from repository
+
+Open logstash-output-sumologic.gemspec and make any necessary configuration changes.
+In your local Git clone, run:
+
+```bash
+gem build logstash-output-sumologic.gemspec
+```
+
+You will get a .gem file in the same directory as `logstash-output-sumologic-x.y.z.gem`
+Remove old version of plugin (optional):
+
+```bash
+bin/logstash-plugin remove logstash-output-sumologic
+```
+
+And then install the plugin locally:
+
+```bash
+bin/logstash-plugin install <full path of .gem>
+```
+
+## How to run test with rspec
+
+The test requires JRuby to run. So you need to install [JRuby](http://jruby.org/), [bundle](https://bundler.io/bundle_install.html) and [RVM](https://rvm.io/) (for switching between JRuby and Ruby) first.
+And then run:
+
+```bash
+rvm use jruby
+bundle install
+export sumo_url=https://events.sumologic.net/receiver/v1/http/XXXXXXXXXX
+rspec spec/
+```
+
+The project is integrated to the Travis CI now. Make sure [all test passed](https://travis-ci.org/SumoLogic/logstash-output-sumologic) before creating PR

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+gem 'rspec'
+gem 'rspec-eventually'

data/LICENSE

@@ -0,0 +1,196 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2018 Sumo Logic
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   
+   This product includes software developed by The Apache Software
+   Foundation (http://www.apache.org/).
+
+   This product includes software developed by Elasticsearch 
+   (http://www.elastic.co/).

data/README.md

@@ -0,0 +1,158 @@
+# Logstash Sumo Logic Output Plugin
+
+[![Build Status](https://travis-ci.org/SumoLogic/logstash-output-sumologic.svg?branch=master)](https://travis-ci.org/SumoLogic/logstash-output-sumologic)  [![Gem Version](https://badge.fury.io/rb/logstash-output-sumologic.svg)](https://badge.fury.io/rb/logstash-output-sumologic)  [![Docker Pulls](https://img.shields.io/docker/pulls/sumologic/logstash-output-sumologic.svg)](https://hub.docker.com/r/sumologic/logstash-output-sumologic)
+
+This is an output plugin for [Logstash](https://github.com/elastic/logstash).
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Getting Started
+
+This guide is for the users just want to download the binary and make the plugin work. For the developer, please refer to the [Developer Guide](DEVELOPER.md)
+
+### 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:
+`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 requires Logstash 2.3 or higher to work.
+
+### 3. Install latest Logstash Sumo Logic Output plugin from [RubyGems](https://rubygems.org/gems/logstash-output-sumologic)
+
+```bash
+bin/logstash-plugin install logstash-output-sumologic
+```
+
+### 4. Start Logstash and send log
+
+In the Logstash home, running:
+
+```bash
+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. Try out samples
+
+#### Send Log lines
+
+Set the URL got from step 1 as environment variable:
+
+```bash
+export sumo_url=https://events.sumologic.net/receiver/v1/http/XXXXXXXXXX
+```
+
+Launch sample with:
+
+```bash
+bin/logstash -f samples/log.conf
+```
+
+The input from console will be sent to Sumo Logic cloud service as log lines.
+
+#### Send Metrics
+
+Set the URL got from step 1 as environment variable:
+
+```bash
+export sumo_url=https://events.sumologic.net/receiver/v1/http/XXXXXXXXXX
+```
+
+Install [plugins-filters-metrics](https://www.elastic.co/guide/en/logstash/current/plugins-filters-metrics.html) plugin
+
+Launch sample with:
+
+```bash
+bin/logstash -f samples/metrics.conf
+```
+
+Mocked events will be sent to Sumo Logic server as 1 minute and 15 minutes rate metrics.
+
+### 6. Get result from Sumo Logic web app
+
+Logon to Sumo Logic [web app](https://service.sumologic.com/) and run
+
+- [Log Search](http://help.sumologic.com/Search)
+- [Live Tail](http://help.sumologic.com/Search/Live_Tail)
+- [Metrics Search](https://help.sumologic.com/Metrics)
+
+## What's Next
+
+- Try it with different input/filter/codec plugins
+- Start LogStash as a service/daemon in your production environment
+- Report any issue or idea through [Git Hub](https://github.com/SumoLogic/logstash-output-sumologic)
+
+## Parameters of Plugin
+
+| Parameter              | Type    | Required? | Default value | Description           |
+| ---------------------- | ------- | --------- | :-----------: | --------------------- |
+| `url`                  | string  | Yes       |               | HTTP Source URL
+| `source_category`      | string  | No        | `Logstash`    | Source category to appear when searching in Sumo Logic by `_sourceCategory`. Using empty string if want keep source category of the HTTP source.
+| `source_name`          | string  | No        | `logstash-output-sumologic` | Source name to appear when searching in Sumo Logic by `_sourceName`. Using empty string if want keep source name of the HTTP source.
+| `source_host`          | string  | No        | machine name  | Source host to appear when searching in Sumo Logic by `_sourceHost`. Using empty string if want keep source host of the HTTP source.
+| `extra_headers`        | hash    | No        |               | Extra fields need to be send in HTTP headers.
+| `compress`             | boolean | No        | `false`       | Enable or disable compression.
+| `compress_encoding`    | string  | No        | `"deflate"`   | Encoding method of comressing, can only be `"deflate"` or `"gzip"`.
+| `interval`             | number  | No        | `0`           | The maximum time for waiting before sending the message pile, in seconds.
+| `pile_max`             | number  | No        | `102400`      | The maximum size of message pile, in bytes.
+| `queue_max`            | number  | No        | `4096`        | The maximum message piles can be hold in memory.
+| `sender_max`           | number  | No        | `100`         | The maximum HTTP senders working in parallel.
+| `format`               | string  | No        | `"%{@timestamp} %{host} %{message}"` | For log only, the formatter of log lines. Use `%{@json}` as the placeholder for whole event json.
+| `json_mapping`         | hash    | No        |               | Override the structure of `{@json}` tag with the given key value pairs.<br />For example:<br />`json_mapping => { "foo" => "%{@timestamp}" "bar" => "%{message}" }`<br />will create messages as:<br />`{"foo":"2016-07-27T18:37:59.460Z","bar":"hello world"}`<br />`{"foo":"2016-07-27T18:38:01.222Z","bar":"bye!"}`
+| `metrics`              | hash    | No        |               | If defined, the event will be sent as metrics. Keys will be the metrics name and values will be the metrics value.
+| `metrics_format`       | string  | No        | `"cabon2"`    | Metrics format, can only be `"graphite"` or `"carbon2"`.
+| `metrics_name`         | string  | No        | `"*"`         | Define the metric name looking, the placeholder "*" will be replaced with the actual metric name.
+| `intrinsic_tags`       | hash    | No        |               | For carbon2 format only, send extra intrinsic key-value pairs other than `metric` (which is the metric name).
+| `meta_tags`            | hash    | No        |               | For carbon2 format only, send metadata key-value pairs.
+| `fields_as_metrics`    | boolean | No        | `false`       | If `true`, all fields in logstash event with number value will be sent as a metrics (with filtering by `fields_include` and `fields_exclude` ; the `metics` parameter is ignored.
+| `fields_include`       | array   | No        | all fields    | Working with `fields_as_metrics` parameter, only the fields which full name matching these RegEx pattern(s) will be included in metrics.
+| `fields_exclude`       | array   | No        | none          | Working with `fields_as_metrics` parameter, the fields which full name matching these RegEx pattern(s) will be ignored in metrics.
+| `sleep_before_requeue` | number  | No        | `30`          | The message failed to send to server will be retried after (x) seconds. Not retried if negative number set
+| `stats_enabled`        | boolean | No        | `false`       | If `true`, stats of this plugin will be sent as metrics
+| `stats_interval`       | number  | No        | `60`          | The stats will be sent every (x) seconds
+
+This plugin is based on [logstash-mixin-http_client](https://github.com/logstash-plugins/logstash-mixin-http_client) thus also supports all HTTP layer parameters like proxy, authentication, timeout etc.
+
+## Trouble Shooting
+
+### Enable plugin logging
+
+Logstash is using log4j2 framework for [logging](https://www.elastic.co/guide/en/logstash/current/logging.html). Starting with 5.0, each individual plugin can configure the logging strategy. [Here](https://github.com/SumoLogic/logstash-output-sumologic/blob/master/samples/log4j2.properties) is a sample log4j2.properties to print plugin log to console and a rotating file.
+
+### Optimize throughput
+
+The throughput can be tuning with following parameters:
+
+- Messages will be piled before sending if both `interval` and `pile_max` are larger than `0`. (e.g. multiple messages will sent in single HTTP request); The maximum size of pile is defined in `pile_max` and if there is no more message comes in, piled message will be sent out every `interval` seconds. A higher number of these parameters normally means more messages will be piled together so overall reduce the overhead in transmission and benefit for compressing efficiency; but it may make a larger latency because messages may be hold in plugin for longer before sending;
+- Message piles will be cached before sending in a memory queue. The maximum piles can stay in queue is defined with `queue_max`. A larger setting may be helpful if input is blocked by the plugin consuming speed, but may also consume more RAM (which can be set in [JVM options](https://www.elastic.co/guide/en/logstash/current/config-setting-files.html))
+- The plugin will use up to `sender_max` HTTP senders in parallel for talking to Sumo Logic server. This number is also limited by the max TCP connections
+- Depends on the content pattern, adjusting `compress`/`compress_encoding` for balancing between the CPU consumption and package size
+
+On the other side, this version is marked as thread safe so if necessary, multiple plugins can work [in parallel as workers](https://www.elastic.co/guide/en/logstash/current/tuning-logstash.html)
+
+### Monitor throughput in metrics
+
+If your Sumo Logic account supports metrics feature, you can enable the stats monitor of this plugin with configuring `stats_enabled` to `true`. For every `stats_interval` seconds, a batch of metrics data points will be sent to Sumo Logic with source category `XXX.stats` (`XXX` is the source category of main output):
+
+| Metric                          | Description                                                 |
+| ------------------------------- | ----------------------------------------------------------- |
+| `total_input_events`            | Total number of events handled from the plugin startup
+| `total_input_bytes`             | Total bytes of inputs after encoded to payload
+| `total_metrics_datapoints`      | Total metrics data points generated from input
+| `total_log_lines`               | Total log lines generated from input
+| `total_output_requests`         | Total number of HTTP requests sent to Sumo Logic server
+| `total_output_bytes`            | Total bytes of payloads sent to Sumo Logic server
+| `total_output_bytes_compressed` | Total bytes of payloads sent to Sumo Logic server (after compressing)
+| `total_response_times`          | Total number of responses acknowledged by Sumo Logic server
+| `total_response_success`        | Total number of accepted(200) acknowledged by Sumo Logic server
+
+**NOTE:** The data points will consume DPM quota
+
+
+### TLS 1.2 Requirement
+
+Sumo Logic only accepts connections from clients using TLS version 1.2 or greater. To utilize the content of this repo, ensure that it's running in an execution environment that is configured to use TLS 1.2 or greater.

data/lib/logstash/outputs/sumologic.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+require "logstash/event"
+require "logstash/json"
+require "logstash/namespace"
+require "logstash/outputs/base"
+require "logstash/plugin_mixins/http_client"
+
+# Now you can use logstash to deliver logs to Sumo Logic
+#
+# Create a HTTP Source
+# in your Sumo Logic account and you can now use logstash to parse your log and 
+# send your logs to your account at Sumo Logic.
+#
+class LogStash::Outputs::SumoLogic < LogStash::Outputs::Base
+  declare_threadsafe!
+  
+  require "logstash/outputs/sumologic/batch"
+  require "logstash/outputs/sumologic/common"
+  require "logstash/outputs/sumologic/compressor"
+  require "logstash/outputs/sumologic/header_builder"
+  require "logstash/outputs/sumologic/message_queue"
+  require "logstash/outputs/sumologic/monitor"
+  require "logstash/outputs/sumologic/payload_builder"
+  require "logstash/outputs/sumologic/piler"
+  require "logstash/outputs/sumologic/sender"
+  require "logstash/outputs/sumologic/statistics"
+  
+  include LogStash::PluginMixins::HttpClient
+  include LogStash::Outputs::SumoLogic::Common
+
+  config_name "sumologic"
+
+  # 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
+
+  # Define the source category metadata
+  config :source_category, :validate => :string
+
+  # Define the source host metadata
+  config :source_host, :validate => :string
+
+  # Define the source name metadata
+  config :source_name, :validate => :string
+
+  # Include extra HTTP headers on request if needed 
+  config :extra_headers, :validate => :hash
+
+  # Compress the payload 
+  config :compress, :validate => :boolean, :default => false
+
+  # The encoding method of compress
+  config :compress_encoding, :validate =>:string, :default => DEFLATE
+
+  # Accumulate events in (x) seconds as a pile/request; 0 means sending every events in isolated requests
+  config :interval, :validate => :number, :default => 0
+
+  # Accumulate events for up to (x) bytes as a pile/request; messages larger than this size will be sent in isolated requests
+  config :pile_max, :validate => :number, :default => 1024000
+
+  # Max # of events can be hold in memory before sending
+  config :queue_max, :validate => :number, :default => 4096
+
+  # Max # of HTTP senders working in parallel
+  config :sender_max, :validate => :number, :default => 100
+
+  # The formatter of log message, by default is message with timestamp and host as prefix
+  # Use %{@json} tag to send whole event
+  config :format, :validate => :string, :default => DEFAULT_LOG_FORMAT
+
+  # Override the structure of @json tag with the given key value pairs
+  config :json_mapping, :validate => :hash
+  
+  # Send metric(s) if configured. This is a hash with k as metric name and v as metric value
+  # Both metric names and values support dynamic strings like %{host}
+  # For example: 
+  #     metrics => { "%{host}/uptime" => "%{uptime_1m}" }
+  config :metrics, :validate => :hash
+
+  # Create metric(s) automatically from @json fields if configured. 
+  config :fields_as_metrics, :validate => :boolean, :default => false
+  
+  config :fields_include, :validate => :array, :default => [ ]
+  
+  config :fields_exclude, :validate => :array, :default => [ ]
+
+  # Defines the format of the metric, support "graphite" or "carbon2"
+  config :metrics_format, :validate => :string, :default => CARBON2
+
+  # Define the metric name looking, the placeholder "*" will be replaced with the actual metric name
+  # For example:
+  #     metrics => { "uptime.1m" => "%{uptime_1m}" }
+  #     metrics_name => "mynamespace.*"
+  # will produce metrics as:
+  #     "mynamespace.uptime.1m xxx 1234567"
+  config :metrics_name, :validate => :string, :default => METRICS_NAME_PLACEHOLDER
+
+  # For carbon2 metrics format only, define the intrinsic tags (which will be used to identify the metrics)
+  # There is always an intrinsic tag as "metric" which value is from metrics_name
+  config :intrinsic_tags, :validate => :hash, :default => {}
+
+  # For carbon2 metrics format only, define the meta tags (which will NOT be used to identify the metrics)
+  config :meta_tags, :validate => :hash, :default => {}
+  
+  # For messages fail to send or get 429/503/504 response, try to resend after (x) seconds; don't resend if (x) < 0
+  config :sleep_before_requeue, :validate => :number, :default => 30
+
+  # Sending throughput data as metrics
+  config :stats_enabled, :validate => :boolean, :default => false
+
+  # Sending throughput data points every (x) seconds
+  config :stats_interval, :validate => :number, :default => 60
+
+  # Disable cookies by default (used in HTTP mixin)
+  config :cookies, :validate => :boolean, :default => false
+
+  attr_reader :stats
+  
+  def register
+    set_logger(@logger)
+    @stats = Statistics.new
+    @queue = MessageQueue.new(@stats, config)
+    @piler = Piler.new(@queue, @stats, config)
+    @monitor = Monitor.new(@queue, @stats, config)
+    @sender = Sender.new(client, @queue, @stats, config)
+    if @sender.connect()
+      @sender.start()
+      @piler.start()
+      @monitor.start()
+    else
+      throw "connection failed, please check the url and retry"
+    end
+  end # def register
+
+  def multi_receive(events)
+    Array(events).map { |event| receive(event) }
+  end # def multi_receive
+  
+  def receive(event)
+    begin
+      @piler.input(event)
+    rescue Exception => exception
+      log_err("error when processing event",
+        :event => event,
+        :message => exception.message,
+        :class => exception.class.name,
+        :backtrace => exception.backtrace)
+    end
+  end # def receive
+
+  def close
+    @monitor.stop()
+    @piler.stop()
+    @sender.stop()
+    client.close()
+  end # def close
+
+end # class LogStash::Outputs::SumoLogic