logstash-input-generator 3.0.6 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '019b8c49d606316b41cf3b6638ec68cc44868fed95a125a7acb8d16d2f385303'
-  data.tar.gz: 0e3393d2d14ec35a81e12915691189cdb8aead5dc08a453fc269a319e65c889a
+  metadata.gz: 04b4aeec5ad74c7ada044f9c3c0df2338a2c1fdcbbe8dc253b0c5bc13f43a16d
+  data.tar.gz: a8ea8816be669cb54517a3516c165ebb4c2a130fd783beb536b5c4b6420f1d33
 SHA512:
-  metadata.gz: d8570eab8c9636da0163b57d6222473a37ef950d403e56abfbee1b5b140add7690026ee5d5630f79dc6ca2c1eb84a1b141c075609b2f9f56149df90eb7a2a385
-  data.tar.gz: e189bbac98a24995407fc1bafb8dbb03f723b53e01908f0eb0fee92a57f21e930a1232e5c22aa7875f2a6d1cca9d8f5cb8d496c23e7a49da4c01d1ee01ecff3c
+  metadata.gz: d504b3417bef22f8f400ac885bfd7e538535c315801499ed50261bd0ab0a974b7a1d76be9e44840c6518efbafdf97520125de0f13eef433d28e83f1df03223be
+  data.tar.gz: 4af9bf298adecfd1bbb81ad47e6c204e351bfa28eb6f6da8769ef72aefb05e9a9a11c8d767fa7db6431d82b69932080c7d2ffe57aa152dce34f10db0a38d0b28

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.1.0
+  - Feat: adjusted fields for ECS compatibility [#22](https://github.com/logstash-plugins/logstash-input-generator/pull/22)
+  - Fix: do not override the host field if it's present in the generator line (after decoding) 
+  - Fix: codec flushing when closing input
+
 ## 3.0.6
   - Docs: Set the default_codec doc attribute.
 

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
-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
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-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.
+   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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   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.

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-generator.svg)](https://travis-ci.org/logstash-plugins/logstash-input-generator)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-generator.svg)](https://travis-ci.com/logstash-plugins/logstash-input-generator)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -27,6 +27,19 @@ The general intention of this is to test performance of plugins.
 
 An event is generated first
 
+[id="plugins-{type}s-{plugin}-ecs"]
+==== Compatibility with the Elastic Common Schema (ECS)
+
+This plugin uses different field names depending on whether {ecs-ref}[ECS-compatibility]
+in enabled (see also <<plugins-{type}s-{plugin}-ecs_compatibility>>).
+
+|========
+| ECS Disabled | ECS v1, v8 | Description
+
+| `host`  | `[host][name]` | The name of the {ls} host that processed the event
+| `sequence` | `[event][sequence]` | The sequence number for the generated event
+|========
+
 [id="plugins-{type}s-{plugin}-options"]
 ==== Generator Input Configuration Options
 
@@ -36,6 +49,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |=======================================================================
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-count>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-lines>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-message>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
@@ -56,6 +70,42 @@ Set how many messages should be generated.
 
 The default, `0`, means generate an unlimited number of events.
 
+[id="plugins-{type}s-{plugin}-ecs_compatibility"]
+===== `ecs_compatibility`
+
+  * Value type is <<string,string>>
+  * Supported values are:
+    ** `disabled`: uses backwards compatible field names, such as `[host]`
+    ** `v1`, `v8`: uses fields that are compatible with ECS, such as `[host][name]`
+
+Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
+See <<plugins-{type}s-{plugin}-ecs>> for detailed information.
+
+
+**Sample output: ECS enabled**
+[source,ruby]
+-----
+{
+    "message" => "Hello world!",
+    "event" => {
+        "sequence" => 0
+    },
+    "host" => {
+        "name" => "the-machine"
+    }
+}
+-----
+
+**Sample output: ECS disabled**
+[source,ruby]
+-----
+{
+    "message" => "Hello world!",
+    "sequence" => 0,
+    "host" => "the-machine"
+}
+-----
+
 [id="plugins-{type}s-{plugin}-lines"]
 ===== `lines` 
 
@@ -79,7 +129,7 @@ Example:
       }
     }
 
-The above will emit `line 1` then `line 2` then `line`, then `line 1`, etc...
+The above will emit `line 1` then `line 2` then `line 3`, then `line 1`, etc...
 
 [id="plugins-{type}s-{plugin}-message"]
 ===== `message` 
@@ -107,4 +157,4 @@ Otherwise, this value will be used verbatim as the event message.
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
 
-:default_codec!:
+:default_codec!:

data/lib/logstash/inputs/generator.rb

@@ -3,12 +3,17 @@ require "logstash/inputs/threadable"
 require "logstash/namespace"
 require "socket" # for Socket.gethostname
 
+require 'logstash/plugin_mixins/ecs_compatibility_support'
+
 # Generate random log events.
 #
 # The general intention of this is to test performance of plugins.
 #
 # An event is generated first
 class LogStash::Inputs::Generator < LogStash::Inputs::Threadable
+
+  include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
+
   config_name "generator"
 
   default :codec, "plain"
@@ -48,12 +53,16 @@ class LogStash::Inputs::Generator < LogStash::Inputs::Threadable
 
   public
   def register
-    @host = Socket.gethostname
+    @host = Socket.gethostname.freeze
     @count = Array(@count).first
+
+    @host_name_field = ecs_select[disabled: 'host', v1: '[host][name]']
+    @sequence_field = ecs_select[disabled: 'sequence', v1: '[event][sequence]']
   end # def register
 
+  # @overload
   def run(queue)
-    number = 0
+    @queue = queue
 
     if @message == "stdin"
       @logger.info("Generator plugin reading a line from stdin")
@@ -62,35 +71,40 @@ class LogStash::Inputs::Generator < LogStash::Inputs::Threadable
     end
     @lines = [@message] if @lines.nil?
 
+    number = 0
     while !stop? && (@count <= 0 || number < @count)
       @lines.each do |line|
         @codec.decode(line.clone) do |event|
-          decorate(event)
-          event.set("host", @host)
-          event.set("sequence", number)
+          decorate_and_set_fields(event, number)
           queue << event
         end
       end
       number += 1
     end # loop
 
-    if @codec.respond_to?(:flush)
-      @codec.flush do |event|
-        decorate(event)
-        event.set("host", @host)
-        queue << event
-      end
-    end
+    do_flush_codec(queue)
   end # def run
 
-  public
-  def close
-    if @codec.respond_to?(:flush)
-      @codec.flush do |event|
-        decorate(event)
-        event.set("host", @host)
-        queue << event
-      end
+  # @overload LogStash::Inputs::Base#stop
+  def stop
+    do_flush_codec(@queue)
+  end
+
+  private
+
+  def do_flush_codec(queue)
+    return unless @codec.respond_to?(:flush)
+
+    @codec.flush do |event|
+      decorate_and_set_fields(event, nil)
+      queue << event
     end
-  end # def close
+  end
+
+  def decorate_and_set_fields(event, sequence)
+    decorate(event)
+    event.set(@host_name_field, @host) unless event.include?(@host_name_field)
+    event.set(@sequence_field, sequence) if sequence
+  end
+
 end # class LogStash::Inputs::Generator

data/logstash-input-generator.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-generator'
-  s.version         = '3.0.6'
+  s.version         = '3.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Generates random log events for test purposes"
   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"
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
   s.add_runtime_dependency 'logstash-codec-plain'
 
   s.add_development_dependency 'logstash-devutils'

data/spec/inputs/generator_spec.rb

@@ -1,58 +1,74 @@
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/devutils/rspec/shared_examples"
+require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
+
 require "logstash/inputs/generator"
 
-describe LogStash::Inputs::Generator do
+describe LogStash::Inputs::Generator, :ecs_compatibility_support do
 
   it_behaves_like "an interruptible input plugin" do
     let(:config) { { } }
   end
 
-  it "should generate configured message" do
-    conf = <<-CONFIG
-      input {
-        generator {
-          count => 2
-          message => "foo"
-        }
-      }
-    CONFIG
+  ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
 
-    events = input(conf) do |pipeline, queue|
-      2.times.map{queue.pop}
+    before(:each) do
+      allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
     end
 
-    insist { events[0].get("sequence") } == 0
-    insist { events[0].get("message") } == "foo"
-
-    insist { events[1].get("sequence") } == 1
-    insist { events[1].get("message") } == "foo"
-  end
+    let(:sequence_field) do
+      ecs_select.active_mode == :disabled ? 'sequence' : '[event][sequence]'
+    end
 
-  it "should generate message from stdin" do
-    conf = <<-CONFIG
-      input {
-        generator {
-          count => 2
-          message => "stdin"
+    it "should generate configured message" do
+      conf = <<-CONFIG
+        input {
+          generator {
+            count => 2
+            message => "foo"
+          }
         }
-      }
-    CONFIG
+      CONFIG
+
+      events = input(conf) do |pipeline, queue|
+        2.times.map { queue.pop }
+      end
+
+      events.each { |event| expect( event.get("message") ).to eql 'foo' }
 
-    saved_stdin = $stdin
-    stdin_mock = StringIO.new
-    $stdin = stdin_mock
-    expect(stdin_mock).to receive(:readline).once.and_return("bar")
+      expect( events.first.get(sequence_field) ).to be_an Integer
 
-    events = input(conf) do |pipeline, queue|
-      2.times.map{queue.pop}
+      events = events.sort_by { |e| e.get(sequence_field) }
+      expect( events[0].get(sequence_field) ).to eql 0
+      expect( events[1].get(sequence_field) ).to eql 1
     end
 
-    insist { events[0].get("sequence") } == 0
-    insist { events[0].get("message") } == "bar"
+    it "should generate message from stdin" do
+      conf = <<-CONFIG
+        input {
+          generator {
+            count => 2
+            message => "stdin"
+          }
+        }
+      CONFIG
+
+      $stdin = stdin_mock = StringIO.new
+      expect(stdin_mock).to receive(:readline).once.and_return("bar")
 
-    insist { events[1].get("sequence") } == 1
-    insist { events[1].get("message") } == "bar"
+      events = input(conf) do |pipeline, queue|
+        2.times.map { queue.pop }
+      end
+
+      events.each { |event| expect( event.get("message") ).to eql 'bar' }
+
+      events = events.sort_by {|e| e.get(sequence_field) }
+      expect( events[0].get(sequence_field) ).to eql 0
+      expect( events[1].get(sequence_field) ).to eql 1
+    end
+
+    after { $stdin = STDIN }
 
-    $stdin = saved_stdin
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-generator
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -30,6 +30,20 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: logstash-mixin-ecs_compatibility_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -97,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Generates random log events for test purposes