logstash-output-appsearch 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8319d2bb602b0945ab9dbbd3ebd9fd1f7185a4d31fbdb7ffc55da0bf08439c94
+  data.tar.gz: 32993c1731e2d356b1a2c5c7e41961e063a4322cd6220626a08941b1768b453a
+SHA512:
+  metadata.gz: 9013619834b2b2b6597d4cd3327479555a3fe16dc0fce3a34751d269025435fbb4480a46009342883d0439de970144dac184843d20500367bebc6d02d9768236
+  data.tar.gz: 8f5f4c3a8fd223634ea9cbef34daca2d88a30110afe03c35fc4f0ffd1884a40a13e419275c3ef4125434b5ce40b80b125da548281cf8ed94d37b16c0467a77b4

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 1.0.0.beta1
+  - Changed documentation to correct required fields and other information [#2](https://github.com/logstash-plugins/logstash-output-appsearch/pull/2)
+  - Added check for correct host, engine and api_key during register [#2](https://github.com/logstash-plugins/logstash-output-appsearch/pull/2)
+  - Changed config `store_timestamp` to `timestamp_destination` [#2](https://github.com/logstash-plugins/logstash-output-appsearch/pull/2)
+
+## 0.1.0
+  - Initial version

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:
+* Joao Duarte - jsvduarte@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/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-appsearch
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

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

data/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/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a 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.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash-output-appsearch_jars.rb

@@ -0,0 +1 @@
+require_relative '../vendor/swiftype-app-search-0.3.0-all.jar'

data/lib/logstash/outputs/appsearch.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require 'logstash-output-appsearch_jars.rb'
+java_import com.swiftype.appsearch.Client
+
+# An appsearch output that does nothing.
+class LogStash::Outputs::AppSearch < LogStash::Outputs::Base
+  config_name "appsearch"
+
+  config :engine, :validate => :string, :required => true
+  config :host, :validate => :string, :required => true
+  config :api_key, :validate => :password, :required => true
+  config :timestamp_destination, :validate => :string
+  config :document_id, :validate => :string
+
+  public
+  def register
+    @client = Client.new(@host, @api_key.value)
+    @client.get_engine(@engine)
+  rescue => e
+    if e.message =~ /401/
+      raise ::LogStash::ConfigurationError.new("Failed to connect to App Search. Error: 401. Please check your credentials")
+    elsif e.message =~ /404/
+      raise ::LogStash::ConfigurationError.new("Failed to connect to App Search. Error: 404. Please check if host '#{@host}' is correct and you've created an engine with name '#{@engine}'")
+    else
+      raise ::LogStash::ConfigurationError.new("Failed to connect to App Search. #{e.message}")
+    end
+  end
+
+  public
+  def multi_receive(events)
+    # because App Search has a limit of 100 documents per bulk
+    events.each_slice(100) do |events|
+      batch = format_batch(events)
+      if @logger.trace?
+        @logger.trace("Sending bulk to AppSearch", :size => batch.size, :data => batch.inspect)
+      end
+      index(batch)
+    end
+  end
+
+  private
+  def format_batch(events)
+    events.map do |event|
+      doc = event.to_hash
+      # we need to remove default fields that start with "@"
+      # since appsearch doesn't accept them
+      if @timestamp_destination
+        doc[@timestamp_destination] = doc.delete("@timestamp")
+      else # delete it
+        doc.delete("@timestamp")
+      end
+      if @document_id
+        doc["id"] = event.sprintf(@document_id)
+      end
+      doc.delete("@version")
+      doc
+    end
+  end
+
+  def index(documents)
+    response = @client.index_documents(@engine, documents)
+    report(documents, response)
+  rescue => e
+    @logger.error("Failed to execute index operation. Retrying..", :exception => e.class, :reason => e.message)
+    sleep(1)
+    retry
+  end
+
+  def report(documents, response)
+    documents.each_with_index do |document, i|
+      errors = response[i]["errors"]
+      if errors.empty?
+        @logger.trace? && @logger.trace("Document was indexed with no errors", :document => document)
+      else
+        @logger.warn("Document failed to index. Dropping..", :document => document, :errors => errors.to_a)
+      end
+    end
+  end
+end

data/logstash-output-appsearch.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-appsearch'
+  s.version       = '1.0.0.beta1'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Index data to Elastic App Search'
+  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.homepage      = 'https://elastic.co'
+  s.authors       = ['Joao Duarte', 'Elastic']
+  s.email         = 'info@elastic.co'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # 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" => "output" }
+
+  s.add_development_dependency 'jar-dependencies', '~> 0.3.2'
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/appsearch_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/appsearch"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::AppSearch do
+  let(:sample_event) { LogStash::Event.new }
+  let(:host) { "test-host" }
+  let(:api_key) { "my_key" }
+  let(:engine) { "test-engine" }
+  let(:output) { described_class.new("host" => host, "api_key" => api_key, "engine" => engine) }
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-appsearch
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: ruby
+authors:
+- Joao Duarte
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  name: jar-dependencies
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: '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: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash-output-appsearch_jars.rb
+- lib/logstash/outputs/appsearch.rb
+- logstash-output-appsearch.gemspec
+- spec/outputs/appsearch_spec.rb
+- vendor/swiftype-app-search-0.3.0-all.jar
+homepage: https://elastic.co
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+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: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: Index data to Elastic App Search
+test_files:
+- spec/outputs/appsearch_spec.rb