logstash-output-vespa_feed 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9db4968f8c7dcc865a8e7fbb3f8d3f0e23e2de4ebf2289da048be6558a7feef
+  data.tar.gz: b58c0b4b81ac2eb3d6e29eb1c8a3f19313c0a5882455f29600fc00c8056693eb
+SHA512:
+  metadata.gz: f3c6f8d73af1c4b3838951eb553d7bb61a5fd94024c1a1f9dd73ecd2b00240a0ffb0b8266e1ec63e23b831c04e06ba9d5d076c53c1680a9d3896d8504efa3940
+  data.tar.gz: 4ee61fe12faf10c9a185321270983e3d66d6ce313214036e921949d6e2e25fd1349ee77b19710743794c17fd390656aa6b0adaa0e365f566be264c20d3318dc4

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.2.0
+- initial release (0.1.x is pure Ruby)

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:
+* Radu Gheorghe - radu@vespa.ai
+
+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,12 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+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,202 @@
+
+                                 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
+
+   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

@@ -0,0 +1,99 @@
+# Logstash Ouput Plugin for Vespa
+
+Plugin for [Logstash](https://github.com/elastic/logstash) to write to [Vespa](https://vespa.ai). Apache 2.0 license.
+
+## Installation
+
+Download and unpack/install Logstash, then:
+```
+bin/logstash-plugin install logstash-output-vespa
+```
+
+## Development
+If you're developing the plugin, you'll want to do something like:
+```
+# build the gem
+./gradlew gem
+# install it as a Logstash plugin
+/opt/logstash/bin/logstash-plugin install /path/to/logstash-output-vespa/logstash-output-vespa-$VERSION.gem
+# profit
+/opt/logstash/bin/logstash
+```
+Some more good info can be found [here](https://www.elastic.co/guide/en/logstash/current/java-output-plugin.html).
+## Usage
+
+Logstash config example:
+
+```
+# read stuff
+input {
+  # if you want to just send stuff to a "message" field from the terminal
+  #stdin {}
+
+  file {
+    # let's assume we have some data in a CSV file here
+    path => "/path/to/data.csv"
+    # read the file from the beginning
+    start_position => "beginning"
+    # on Logstash restart, forget where we left off and start over again
+    sincedb_path => "/dev/null"
+  }
+}
+
+# parse and transform data here
+filter {
+  csv {
+    # how does the CSV file look like?
+    separator => ","
+    quote_char => '"'
+
+    # if the first line is the header, we'll skip it
+    skip_header => true
+
+    # columns of the CSV file. Make sure you have these fields in the Vespa schema
+    columns => ["id", "description", ...]
+  }
+
+  # remove fields that we don't need. Here you can do a lot more processing
+  mutate {
+    remove_field => ["@timestamp", "@version", "event", "host", "log", "message"]
+  }
+}
+
+# publish to Vespa
+output {
+  # for debugging. You can have multiple outputs (just as you can have multiple inputs/filters)
+  #stdout {}
+
+  vespa_feed { # including defaults here
+  
+    # Vespa endpoint, namespace, doc type (from the schema)
+    vespa_url => "http://localhost:8080"
+    namespace => "no_default_provide_yours"
+    document_type => "no_default_provide_yours_from_schema"
+
+    # take the document ID from this field in each row
+    # if the field doesn't exist, we generate a UUID
+    id_field => "id"
+
+    # how many HTTP/2 connections to keep open
+    max_connections => 1
+    # number of streams per connection
+    max_streams => 128
+    # request timeout (seconds) for each write operation
+    operation_timeout => 180
+    # after this time (seconds), the circuit breaker will be half-open:
+    # it will ping the endpoint to see if it's back,
+    # then resume sending requests when it's back
+    grace_period => 10
+    
+    # how many times to retry on transient failures
+    max_retries => 10
+  }
+}
+```
+
+Then you can start Logstash while pointing to the config file like:
+```
+bin/logstash -f logstash.conf
+```

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/docs/index.asciidoc

@@ -0,0 +1,126 @@
+:plugin: example
+:type: output
+:default_codec: plain
+// Update header with plugin name and default codec
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}s-{plugin}"]
+
+=== Vesoa output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Writes documents to Vespa.
+
+// Format anchors and links to support generated ids for versioning
+// Sample anchor: [id="plugins-{type}s-{plugin}-setting_name"]
+// Sample link: <<plugins-{type}s-{plugin}-setting_name>>
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Vespa Output Configuration Options
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-vespa_url>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-namespace>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-document_type>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-id_field>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-max_retries>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-max_connections>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-max_streams>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-operation_timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-grace_period>> |<<number,number>>|No
+|=======================================================================
+
+[id="plugins-{type}s-{plugin}-vespa_url"]
+===== `vespa_url`
+
+* Value type is <<string,string>>
+* Default value is `http://localhost:8080`
+
+URL to the Vespa instance
+
+[id="plugins-{type}s-{plugin}-namespace"]
+===== `namespace`
+
+* Value type is <<string,string>>
+
+Vespa namespace. A logical grouping of documents in Vespa
+
+[id="plugins-{type}s-{plugin}-document_type"]
+===== `document_type`
+
+* Value type is <<string,string>>
+
+Document type. You should see it in the Vespa services.xml file as well as in the schema file
+
+[id="plugins-{type}s-{plugin}-id_field"]
+===== `id_field`
+
+* Value type is <<string,string>>
+* Default value is `id`
+
+Field to get the document id from. If not present, a UUID will be generated
+
+[id="plugins-{type}s-{plugin}-max_retries"]
+===== `max_retries`
+
+* Value type is <<number,number>>
+* Default value is `60`
+
+On failure, retry this many times
+
+[id="plugins-{type}s-{plugin}-max_connections"]
+===== `max_connections`
+
+* Value type is <<number,number>>
+* Default value is `1`
+
+How many HTTP/2 connections to keep open.
+
+[id="plugins-{type}s-{plugin}-max_streams"]
+===== `max_streams`
+
+* Value type is <<number,number>>
+* Default value is `128`
+
+Number of streams per connection. This is the number of concurrent requests that can be made on a single connection.
+
+[id="plugins-{type}s-{plugin}-operation_timeout"]
+===== `operation_timeout`
+
+* Value type is <<number,number>>
+* Default value is `180`
+
+Request timeout (in seconds) for each write operation.
+
+[id="plugins-{type}s-{plugin}-grace_period"]
+===== `grace_period`
+
+* Value type is <<number,number>>
+* Default value is `10`
+
+After this time (seconds), the circuit breaker will be half-open:
+it will ping the endpoint to see if it's back,
+then resume sending requests when it's back.
+
+// The full list of Value Types is here: 
+// https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]
+
+:default_codec!:

data/lib/logstash/outputs/vespa_feed.rb

@@ -0,0 +1,12 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash-output-vespa_feed_jars"
+require "java"
+
+class LogStash::Outputs::VespaFeed < LogStash::Outputs::Base
+  config_name "vespa_feed"
+
+  def self.javaClass() Java::org.logstashplugins.VespaFeed.java_class; end
+end

data/lib/logstash-output-vespa_feed_jars.rb

@@ -0,0 +1,5 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+# encoding: utf-8
+
+require 'jar_dependencies'
+require_jar('org.logstashplugins', 'logstash-output-vespa_feed', '0.2.0')

data/logstash-output-vespa_feed.gemspec

@@ -0,0 +1,22 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+Gem::Specification.new do |s|
+  s.name            = 'logstash-output-vespa_feed'
+  s.version         = ::File.read('VERSION').split('\n').first
+  s.licenses        = ['Apache-2.0']
+  s.summary         = 'Output plugin for Vespa'
+  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         = ['Radu Gheorghe']
+  s.email           = ['radu@vespa.ai']
+  s.homepage        = 'https://vespa.ai'
+  s.require_paths = ['lib', 'vendor/jar-dependencies']
+
+  s.files = Dir["lib/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { 'logstash_plugin' => 'true', 'logstash_group' => 'output', 'java_plugin' => 'true'}
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'jar-dependencies'
+  s.add_development_dependency 'logstash-devutils'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-vespa_feed
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Radu Gheorghe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: jar-dependencies
+  type: :runtime
+  prerelease: false
+  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
+  type: :development
+  prerelease: false
+  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:
+- radu@vespa.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+- docs/index.asciidoc
+- lib/logstash-output-vespa_feed_jars.rb
+- lib/logstash/outputs/vespa_feed.rb
+- logstash-output-vespa_feed.gemspec
+- vendor/jar-dependencies/org/logstashplugins/logstash-output-vespa_feed/0.2.0/logstash-output-vespa_feed-0.2.0.jar
+homepage: https://vespa.ai
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+  java_plugin: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- vendor/jar-dependencies
+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: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Output plugin for Vespa
+test_files: []