logstash-input-faker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36d8b31ac016bd92319e5ae44622638e939ee1d8
+  data.tar.gz: b05d8e7ed0df4ceee77c5231c879b74a987ac952
+SHA512:
+  metadata.gz: ce2f6fd7c5073eaac2e8c3a313d4da55fd053f42db1abfad3e7fc259218fd2dae62f3eb7b01bdce167ca570af409eea5091eb6e49a1019534ca3ca66d7bb44ed
+  data.tar.gz: 6ec81fe0774de8102c1bfdbc0f4433815af3d255fd4476c84bd4fdbbf77814eea065a2626cd6285f035bc98690bd59643e72409ba96f70e47863b65b8c796bb8

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* jsericks - jsericks@gmail.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = "../../logstash"
+
+if Dir.exist?(logstash_path) && ENV["LOGSTASH_SOURCE"] == 1
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,11 @@
+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/lib/logstash/inputs/faker.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+# require "logstash-core"
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/util/decorators"
+require "faker"
+require "socket" # for Socket.gethostname
+
+I18n.reload!
+
+# [NOTE]
+# ===================================================================
+# The values put into the add_faker_field params must be available
+# modules and method calls from the Faker gem library seen at
+# https://github.com/stympy/faker/
+# ===================================================================
+# Example: 
+# [source, ruby]
+#     input {
+#       faker {
+#         count => 1
+#         add_faker_field => {
+#           "[name][last_name]" => "Name.last_name"
+#           "[name][first_name]" => "Name.first_name"
+#           "[address][city]" => "Address.city"
+#           "[address][address1]" => "Address.street_address"
+#         }
+#         overwrite_fields => true
+#       }
+#     }
+
+class LogStash::Inputs::Faker < LogStash::Inputs::Base
+  config_name "faker"
+
+  default :codec, "plain"
+
+  config :add_faker_field, :validate => :hash, :default => {}
+
+  # Will overwrite fields that are in the event prior to add_faker_field
+  # being invoked ( usually fields created using add_field ) if true
+  # when false this will insert the new faker values into an array with
+  # the previously defined event values
+  config :overwrite_fields, :validate => :boolean, :default => false
+
+  # The number of events to generate
+  # When not explicitly defined plugin will
+  # generate events until stopped
+  config :count, :validate => :number, :default => 0
+
+  public
+  def register
+    @host = Socket.gethostname
+    @count = Array(@count).first
+  end
+
+  def run(queue)
+    number = 0
+
+    while !stop? && (@count <= 0 || number < @count)
+      event = LogStash::Event.new({})
+      add_faker_fields(event)
+      decorate(event)
+      event.set("host", @host)
+      queue << event
+      number += 1
+    end #end loop
+  end # end run
+
+  protected
+  def add_faker_fields(event)
+    new_fields = {}
+    @add_faker_field.each do |field, faker_string|
+      event.remove(field) if @overwrite_fields
+      new_fields[field] = Faker.class_eval(faker_string)
+    end
+    LogStash::Util::Decorators.add_fields(new_fields,event,"inputs/#{self.class.name}")
+  end
+
+  public
+  def close
+    if @codec.respond_to?(:flush)
+      @codec.flush do |event|
+        decorate(event)
+        event.set("host", @host)
+        queue << event
+      end
+    end
+  end
+end

data/logstash-input-faker.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-input-faker'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Generate log events with fake data"
+  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.authors         = ["Jsericks"]
+  s.email           = 'jsericks@gmail.com'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  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)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core"
+  s.add_runtime_dependency "logstash-core-plugin-api"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency "faker", "~> 1.7", ">= 1.7.3"
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/inputs/faker_spec.rb

@@ -0,0 +1,59 @@
+
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/faker"
+
+describe LogStash::Inputs::Faker do
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { } }
+  end
+
+  it "should generate a message and remove the Faker calls" do
+    plg = LogStash::Inputs::Faker.new
+    plg.count = 1
+    plg.add_faker_field = {
+                            "first_name" => "Name.first_name",
+                            "last_name" => "Name.last_name"
+                          }
+
+    event = plugin_input(plg) do |result|
+      result.pop
+    end
+
+    insist { event }.is_a? LogStash::Event
+    insist { event.get("first_name") } != "Name.first_name"
+    insist { event.get("last_name") } != "Name.last_name"
+  end
+
+  it "should generate a message with nested fields and the added_field" do
+    plg = LogStash::Inputs::Faker.new
+    plg.count = 1
+    plg.add_faker_field = {
+                            "[name][first_name]" => "Name.first_name",
+                            "[name][last_name]" => "Name.last_name"
+                          }
+    plg.add_field = { "[name][middle_name]" => "Jimmy" }
+
+    event = plugin_input(plg) do |result|
+      result.pop
+    end
+
+    insist { event }.is_a? LogStash::Event
+    insist { event.get("[name][middle_name]") } == "Jimmy"
+    insist { event.get("[name][first_name]") } != "Name.first_name"
+    insist { event.get("[name][last_name]") } != "Name.last_name"
+  end
+
+  it "should generate 100 messages" do
+    plg = LogStash::Inputs::Faker.new
+    plg.count = 100
+    plg.add_faker_field = {
+                            "first_name" => "Name.first_name",
+                            "last_name" => "Name.last_name"
+                          }
+    events = plugin_input(plg) do |result|
+      100.times.map{result.pop}
+    end
+
+    insist { events.size } == 100
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-faker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jsericks
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  name: faker
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+email: jsericks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/faker.rb
+- logstash-input-faker.gemspec
+- spec/inputs/faker_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.6
+signing_key:
+specification_version: 4
+summary: Generate log events with fake data
+test_files:
+- spec/inputs/faker_spec.rb