logstash-output-sumologic 1.2.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30572978a903c07948995ac86c84e13126145f6a01cd1794f47420234b4eefbd
-  data.tar.gz: d2f9a018ec64a26634cc6a5c3b2e6631f8182982280b7f53723a0f7545ee9c6f
+  metadata.gz: 0cb3e69cc8d33b60f981ee807b8deeab442bca032d5715df432d467d5a917b51
+  data.tar.gz: 4e1c485db70cace53f2c46b7fd089be90775e74d569ace0fd1462a98ffe7fed7
 SHA512:
-  metadata.gz: 173d6dae34af5850c7af5edac210420fa5bc7c6ccc7d9019288cf12080b5a77e3bcf111c8458acfe0a39a3fecd1fa9b76fec2716eae79883aae1d6a5879619fe
-  data.tar.gz: 45f1e6f5a7ba96d249d7b2fdb0dd024a198b454bb3cdcdab4603e1e4430fa2cf3b9f6e56b237d6f6ae3dc7fc7545dda083a09b65662caf38c37ce18ab2cdd6a7
+  metadata.gz: '0478381fc42c308038c921dcede8662f5c83147f618c34bf5acf1f9c07b693d3a3e95a0978f74dc8114217b7e1c8b0aff78e29feb2435b27d6b1618a116fddb1'
+  data.tar.gz: f8ba1e23876443e518d468f1f2c162f4053093fa251f870b0abd61528caea9c6fdef88dd86ba91278519ee7fd5baf352479e9d97386c8e9cbcf817b19c41e2c9

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## 1.3.2 (2021-02-03)
+
+- [#60](https://github.com/SumoLogic/logstash-output-sumologic/pull/60) Fix plugin metrics not being sent
+
+## 1.3.1 (2020-12-18)
+
+- [#53](https://github.com/SumoLogic/logstash-output-sumologic/pull/53) Fix "undefined method `blank?'"
+- [#52](https://github.com/SumoLogic/logstash-output-sumologic/pull/52) Fix logstash-plugin-http_client version conflict in Logstash 7
+
+## 1.3.0
+
+- [#41](https://github.com/SumoLogic/logstash-output-sumologic/pull/41) Provide Docker image with Logstash 6.6 + output plugin on docker hub
+- [#41](https://github.com/SumoLogic/logstash-output-sumologic/pull/41) Kubernetes support with Logstash beats to SumoLogic
+- [#41](https://github.com/SumoLogic/logstash-output-sumologic/pull/41) CI improving 
+- [#36](https://github.com/SumoLogic/logstash-output-sumologic/pull/36) Update sender to send in batch.
+- [#36](https://github.com/SumoLogic/logstash-output-sumologic/pull/36) Support %{} field evaluation in `source_category`, `source_name`, `source_host` parameters
+- [#39](https://github.com/SumoLogic/logstash-output-sumologic/pull/39) Disable cookies by default
+
+## 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`
@@ -13,4 +39,4 @@
 
 ## 1.0.0
 
-- Initial release
+- Initial release

data/DEVELOPER.md

@@ -26,8 +26,16 @@ 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:
+### Running in Docker
+
+```bash
+docker build -t logstash-output-plugin .
+docker run --rm -it -e 'sumo_url=https://events.sumologic.net/receiver/v1/http/XXXXXXXXXX' logstash-output-plugin
+```
+
+### Running on bare metal
+
+The test requires JRuby to run.
 
 ```bash
 rvm use jruby
@@ -36,4 +44,12 @@ 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
+## Continuous Integration
+
+The project uses GitHub Actions for:
+
+- Testing pull requests and main branch commits: [.github/workflows/ci.yml](.github/workflows/ci.yml)
+- Publishing new version of gem to RubyGems.org after tagging: [.github/workflows/publish.yml](.github/workflows/publish.yml)
+
+Before publishing a new version, make sure the RubyGems account has MFA disabled for API access.
+Go to [Settings](https://rubygems.org/settings/edit) and set `MFA Level` to `UI only`.

data/LICENSE

@@ -1,18 +1,196 @@
-Copyright (c) 2016 Sumo Logic <https://www.sumologic.com>
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-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
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   1. Definitions.
 
-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.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
 
-This product includes software developed by The Apache Software
-Foundation (http://www.apache.org/).
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
 
-This product includes software developed by Elasticsearch (http://www.elastic.co/).
+      "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

@@ -1,14 +1,10 @@
 # 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)
+[![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.
 
-| TLS Deprecation Notice |
-| --- |
-| In keeping with industry standard security best practices, as of May 31, 2018, the Sumo Logic service will only support TLS version 1.2 going forward. Verify that all connections to Sumo Logic endpoints are made from software that supports TLS 1.2. |
-
 ## 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)
@@ -116,6 +112,7 @@ Logon to Sumo Logic [web app](https://service.sumologic.com/) and run
 | `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_category`       | string  | No        | `Logstash.stats` | The source category this plugin's stats will be sent with when `stats_enabled` is `true`
 | `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
 
@@ -140,7 +137,7 @@ On the other side, this version is marked as thread safe so if necessary, multip
 
 ### Monitor throughput in metrics
 
-If your Sumo Logic account supporting metrics feature, you can enable the stats monitor of 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). Include:
+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 specified by `stats_category` parameter:
 
 | Metric                          | Description                                                 |
 | ------------------------------- | ----------------------------------------------------------- |
@@ -153,3 +150,10 @@ If your Sumo Logic account supporting metrics feature, you can enable the stats
 | `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

@@ -14,6 +14,7 @@ require "logstash/plugin_mixins/http_client"
 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"
@@ -104,19 +105,23 @@ class LogStash::Outputs::SumoLogic < LogStash::Outputs::Base
   # 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
 
+  config :stats_category, :validate => :string, :default => CATEGORY_HEADER_DEFAULT_STATS
+
   # 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()
+    @stats = Statistics.new
     @queue = MessageQueue.new(@stats, config)
-    @builder = PayloadBuilder.new(@stats, config)
     @piler = Piler.new(@queue, @stats, config)
     @monitor = Monitor.new(@queue, @stats, config)
     @sender = Sender.new(client, @queue, @stats, config)
@@ -130,34 +135,18 @@ class LogStash::Outputs::SumoLogic < LogStash::Outputs::Base
   end # def register
 
   def multi_receive(events)
-    # events.map { |e| receive(e) }
-    begin
-      content = Array(events).map { |event| @builder.build(event) }.join($/)
-      @queue.enq(content)
-      @stats.record_multi_input(events.size, content.bytesize)
-    rescue Exception => exception
-      log_err(
-        "Error when processing events",
-        :events => events,
-        :message => exception.message,
-        :class => exception.class.name,
-        :backtrace => exception.backtrace
-    )
-    end
+    Array(events).map { |event| receive(event) }
   end # def multi_receive
   
   def receive(event)
     begin
-      content = @builder.build(event)
-      @piler.input(content)
+      @piler.input(event)
     rescue Exception => exception
-      log_err(
-        "Error when processing event",
+      log_err("error when processing event",
         :event => event,
         :message => exception.message,
         :class => exception.class.name,
-        :backtrace => exception.backtrace
-    )
+        :backtrace => exception.backtrace)
     end
   end # def receive
 

data/lib/logstash/outputs/sumologic/batch.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module LogStash; module Outputs; class SumoLogic;
+  class Batch
+    
+    attr_accessor :headers, :payload
+  
+    def initialize(headers, payload)
+        @headers, @payload = headers, payload
+    end
+  
+  end
+end; end; end;

data/lib/logstash/outputs/sumologic/common.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
-require "date"
-
 module LogStash; module Outputs; class SumoLogic;
   module Common
 
+    require "date"
+
     # global constants
     DEFAULT_LOG_FORMAT = "%{@timestamp} %{host} %{message}"
     METRICS_NAME_PLACEHOLDER = "*"
@@ -12,6 +12,23 @@ module LogStash; module Outputs; class SumoLogic;
     DEFLATE = "deflate"
     GZIP = "gzip"
     STATS_TAG = "STATS_TAG"
+    STOP_TAG = "PLUGIN STOPPED"
+
+    CONTENT_TYPE = "Content-Type"
+    CONTENT_TYPE_LOG = "text/plain"
+    CONTENT_TYPE_GRAPHITE = "application/vnd.sumologic.graphite"
+    CONTENT_TYPE_CARBON2 = "application/vnd.sumologic.carbon2"
+    CONTENT_ENCODING = "Content-Encoding"
+
+    CATEGORY_HEADER = "X-Sumo-Category"
+    CATEGORY_HEADER_DEFAULT = "Logstash"
+    CATEGORY_HEADER_DEFAULT_STATS = "Logstash.stats"
+    HOST_HEADER = "X-Sumo-Host"
+    NAME_HEADER = "X-Sumo-Name"
+    NAME_HEADER_DEFAULT = "logstash-output-sumologic"
+
+    CLIENT_HEADER = "X-Sumo-Client"
+    CLIENT_HEADER_VALUE = "logstash-output-sumologic"
 
     # for debugging test
     LOG_TO_CONSOLE = false
@@ -25,7 +42,7 @@ module LogStash; module Outputs; class SumoLogic;
       if LOG_TO_CONSOLE
         puts "[INFO:#{DateTime::now}]#{message} #{opts.to_s}"
       else
-        @@logger && @@logger.info(message, opts)
+        @@logger && @@logger.info(message, *opts)
       end
     end # def log_info
 
@@ -33,7 +50,7 @@ module LogStash; module Outputs; class SumoLogic;
       if LOG_TO_CONSOLE
         puts "\e[33m[WARN:#{DateTime::now}]#{message} #{opts.to_s}\e[0m"
       else
-        @@logger && @@logger.warn(message, opts)
+        @@logger && @@logger.warn(message, *opts)
       end
     end # def log_warn
 
@@ -41,7 +58,7 @@ module LogStash; module Outputs; class SumoLogic;
       if LOG_TO_CONSOLE
         puts "\e[31m[ERR :#{DateTime::now}]#{message} #{opts.to_s}\e[0m"
       else
-        @@logger && @@logger.error(message, opts)
+        @@logger && @@logger.error(message, *opts)
       end
     end # def log_err
 
@@ -49,9 +66,19 @@ module LogStash; module Outputs; class SumoLogic;
       if LOG_TO_CONSOLE
         puts "\e[36m[DBG :#{DateTime::now}]#{message} #{opts.to_s}\e[0m"
       else
-        @@logger && @@logger.debug(message, opts)
+        @@logger && @@logger.debug(message, *opts)
       end
     end # def log_dbg
 
+    def blank?(value)
+      if value.kind_of?(NilClass)
+        true
+      elsif value.kind_of?(String)
+        value !~ /\S/
+      else
+        value.respond_to?(:empty?) ? value.empty? : !value
+      end
+    end
+
   end
-end; end; end
+end; end; end