logstash-output-vespa 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d52921a31026d0ec3211b06fe3c79d8d0244253015bb74695ea3aaf80ec93f
-  data.tar.gz: b8b69aea8f790482f799574e73ac00496d1dfd95b2ea9a97ba56b50665ff5c7a
+  metadata.gz: 41c0e438716ffaaa72e96627a14c74d4f312dcbf39917e7f75ab59b6f5aec6ae
+  data.tar.gz: 25278f341f1f723611c4027ff39ab4fa3b9c6d72b9bd933f0a0ee2771faaefa9
 SHA512:
-  metadata.gz: b5644a86918bb0f72e9b7656ae4a6c864c12afb00979603366175d42728d1816d1285088a2a652543d6de703430e345d2dc6c658fc2203e19a97ab4aa13fe567
-  data.tar.gz: 2b4c7e6922a94efda2923fc8af562e1c9ae5f78a62e326922f3c02406a9f270ffd899b152fcc6d74a476766c738ba182bfeac9e0ef207e721dbc3f9eb2d5e3ea
+  metadata.gz: 748862347e49001a6176f5ad169757eec674037552bf1f6b02057ad4387c6caf005078a32d9aaf9ce8f5467e4830eb6d1fe8eed2c6ad90917f3dc2eb3fd5cc79
+  data.tar.gz: 9bc3f31f0da3ac7811cd238a1d018f7f33aef97151ecc64caa84e9ed4e0a7c721dae732cbf355bc4831de22247f9aa03538e0cf56df64b44a2d48d7e16230277

data/README.md

@@ -4,83 +4,32 @@ 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
+## Installation
 
-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
+If you're developing it, then:
 ```
-
-#### Test
-
-- Update your dependencies
-
-```sh
+# get the dependencies
 bundle install
+# build the gem
+gem build logstash-output-vespa.gemspec
+# 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
 ```
 
-- Run tests
-
-```sh
-bundle exec rspec
-```
+## Usage
 
-### 2. Running your unpublished Plugin in Logstash
+In your Logstash config:
 
-#### 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.
+output {
+  vespa {
+    vespa_url => "http://localhost:8080"
+    namespace => "used_car"
+    document_type => "used_car"
+    id_field => "id"
+    max_retries => 60
+  }
+}
+```

data/lib/logstash/outputs/vespa.rb

@@ -9,9 +9,9 @@ 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"
+  config :vespa_url, :validate => :string, :default => "http://localhost:8080"
 
-  # Namespace. You should see it in the Vespa services.xml file as "id" in the <content> tag
+  # Vespa namespace. A logical grouping of documents in Vespa
   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

data/logstash-output-vespa.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-output-vespa'
-  s.version       = '0.1.0'
+  s.version       = '0.1.1'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Logstash Output Plugin for Vespa'
   s.description   = 'Writes documents to Vespa'
@@ -20,6 +20,5 @@ Gem::Specification.new do |s|
   # 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

@@ -12,6 +12,7 @@ describe LogStash::Outputs::Vespa do
     output.register
   end
 
+  ## TODO add tests :)
   describe "receive message" do
     subject { output.receive(sample_event) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-vespa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Radu Gheorghe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !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
@@ -74,12 +60,10 @@ 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

data/DEVELOPER.md

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

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

@@ -1,93 +0,0 @@
-# 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