logstash-output-vespa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05d52921a31026d0ec3211b06fe3c79d8d0244253015bb74695ea3aaf80ec93f
+  data.tar.gz: b8b69aea8f790482f799574e73ac00496d1dfd95b2ea9a97ba56b50665ff5c7a
+SHA512:
+  metadata.gz: b5644a86918bb0f72e9b7656ae4a6c864c12afb00979603366175d42728d1816d1285088a2a652543d6de703430e345d2dc6c658fc2203e19a97ab4aa13fe567
+  data.tar.gz: 2b4c7e6922a94efda2923fc8af562e1c9ae5f78a62e326922f3c02406a9f270ffd899b152fcc6d74a476766c738ba182bfeac9e0ef207e721dbc3f9eb2d5e3ea

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

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/DEVELOPER.md

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+logstash_path = ENV['LOGSTASH_PATH'] || '/opt/logstash/logstash-8.14.2'
+
+if Dir.exist?(logstash_path)
+  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/main/CONTRIBUTING.md) file.

data/lib/logstash/outputs/vespa.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "net/http"
+require "uri"
+require "securerandom"
+
+class LogStash::Outputs::Vespa < LogStash::Outputs::Base
+  config_name "vespa"
+
+  # URL to the Vespa instance
+  config :vespa_url, :validate => :string, :required => true, :default => "http://localhost:8080"
+
+  # Namespace. You should see it in the Vespa services.xml file as "id" in the <content> tag
+  config :namespace, :validate => :string, :required => true
+
+  # Document type. You should see it in the Vespa services.xml file as well as in the schema file
+  config :document_type, :validate => :string, :required => true
+
+  # Field to get the document id from. If not present, a UUID will be generated
+  config :id_field, :validate => :string, :default => "id"
+
+  # On failure, retry this many times
+  config :max_retries, :validate => :number, :default => 60
+
+  concurrency :shared
+
+  public
+  def register
+    # initialize a dead letter queue writer
+    @dlq_writer = execution_context.dlq_writer
+
+    @base_uri = URI.parse(@vespa_url)
+  end # def register
+
+  public
+  def receive(event)
+    retry_attempts = @max_retries
+
+    # if there's a document "id" field, we should use it as the document id
+    # otherwise, we generate a UUID
+    id = event.get(@id_field) || SecureRandom.uuid
+
+    # build the path from the cluster name, document type and document id
+    uri = @base_uri.dup
+    uri.path = "/document/v1/#{@namespace}/#{@document_type}/docid/#{id}"
+
+    http_client = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Post.new(uri.request_uri, {'Content-Type' => 'application/json'})
+
+    document = {
+      "fields" => event.to_hash()
+    }
+
+    request.body = document.to_json
+    response = http_client.request(request)
+
+    # Retry on 429, 500, 502, 503, 504
+    retry_count = 0
+    while [429, 500, 502, 503, 504].include?(response.code.to_i) && retry_count < @max_retries
+      @logger.warn("Received #{response.code} for path #{uri.path} and content #{document.to_json}. " \
+        "Retrying... (attempt #{retry_count + 1}/#{@max_retries})")
+      retry_count += 1
+      sleep 2 ** retry_count # Exponential backoff
+      response = http_client.request(request)
+    end
+
+    if response.code.to_i != 200
+      @logger.error("Error sending event to Vespa. Writing to dead letter queue (if it's configured in logstash.yml).",
+        :response_code => response.code, :response_body => response.body)
+      @dlq_writer.write(event, response.body)
+    end
+
+    rescue => e
+      # initialize retry count if it's not already set
+      retry_count ||= 0
+      if retry_count < @max_retries
+        @logger.error("Exception caught while sending event to Vespa. Retrying... (attempt #{retry_count + 1}/#{@max_retries})",
+          :exception => e, :event => event)
+        retry_count += 1
+        sleep 2 ** retry_count # Exponential backoff
+        retry
+      else
+        @logger.error("Giving up on retrying. Writing to dead letter queue (if it's configured in logstash.yml).",
+         :exception => e, :event => event)
+        @dlq_writer.write(event, e.message)
+      end
+  end # def receive
+end # class LogStash::Outputs::Vespa

data/lib/logstash/outputs/vespa.rb.http2

@@ -0,0 +1,93 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "httpx"
+require "json"
+require "uri"
+require "securerandom"
+
+class LogStash::Outputs::Vespa < LogStash::Outputs::Base
+  config_name "vespa"
+
+  # URL to the Vespa instance
+  config :vespa_url, :validate => :string, :required => true, :default => "http://localhost:8080"
+
+  # Content cluster name. You should see it in the Vespa services.xml file as "id" in the <content> tag
+  config :content_cluster, :validate => :string, :required => true
+
+  # Document type name. You should see it in the Vespa services.xml file as well as in the schema file
+  config :document_type, :validate => :string, :required => true
+
+  # field name to use as the document id. If not present, a UUID will be generated
+  config :id_field, :validate => :string, :default => "id"
+
+  # On failure, retry this many times
+  config :max_retries, :validate => :number, :default => 60
+
+  concurrency :shared
+
+  public
+  def register
+    # initialize a dead letter queue writer
+    @dlq_writer = execution_context.dlq_writer
+
+    @base_uri = URI.parse(@vespa_url)
+  end # def register
+
+  public
+  def multi_receive(events)
+    return if events.empty?
+
+    # HTTPX client with HTTP/2 support and retries
+    http_client = HTTPX.with(:http2).plugin(:retries, max_retries: @max_retries).with(
+      persistent: true,
+      max_concurrent_requests: 100,
+      buffer_size: 64_000,   # 64 KB r/w buffer
+      window_size: 64_000    # 64 KB flow control window
+    )
+
+    # initialize list of requests
+    requests = []
+
+    events.map do |event|
+      # If there's a document "id" field, we should use it as the document id
+      # Otherwise, we generate a UUID
+      id = event.get(@id_field) || SecureRandom.uuid
+  
+      # Build the path from the cluster name, document type, and document id
+      uri = @base_uri.dup
+      uri.path = "/document/v1/#{@content_cluster}/#{@document_type}/docid/#{id}"
+  
+      document = {
+        "fields" => event.to_hash
+      }
+
+      # Build the request. We don't run it yet
+      request = http_client.build_request(:post, uri.to_s, json: document)
+      # add it to the list of requests
+      requests << request
+    end # events.map
+
+    @logger.debug("Sending #{requests.size} requests to Vespa")
+    # Run all requests async
+    responses = http_client.request(*requests)
+
+    # Handle responses
+    responses.each do |response|
+      if response.status != 200
+        # Handle non-200 response by writing to the DLQ
+        # TODO Should we retry some of those?
+        @logger.error("Error sending event to Vespa. Writing to dead letter queue (if configured).",
+                      :response_code => response.status, :response_body => response.body)
+        # TODO fix this, we need to write the corresponding event
+        @dlq_writer.write(event, response.body)
+      end
+    end
+  
+  rescue => e
+    @logger.error("Exception caught while sending events to Vespa. Writing to dead letter queue (if configured).", :exception => e)
+    events.each do |event|
+      @dlq_writer.write(event, e.message)
+    end
+  end # def multi_receive
+end # class LogStash::Outputs::Vespa

data/logstash-output-vespa.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-vespa'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Logstash Output Plugin for Vespa'
+  s.description   = 'Writes documents to Vespa'
+  s.homepage      = 'http://vespa.ai'
+  s.authors       = ['Radu Gheorghe']
+  s.email         = 'radu@vespa.ai'
+  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" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency "httpx"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/vespa_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/vespa"
+require "logstash/codecs/plain"
+
+
+describe LogStash::Outputs::Vespa do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Vespa.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-vespa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Radu Gheorghe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Writes documents to Vespa
+email: radu@vespa.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/vespa.rb
+- lib/logstash/outputs/vespa.rb.http2
+- logstash-output-vespa.gemspec
+- spec/outputs/vespa_spec.rb
+homepage: http://vespa.ai
+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: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Logstash Output Plugin for Vespa
+test_files:
+- spec/outputs/vespa_spec.rb