logstash-input-elastic_serverless_forwarder 0.1.0-java → 0.1.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4d67fef66d28e6061c6564ff483239a041daad1d220d19a21767f77fa5a0c5f
-  data.tar.gz: d9711d462cae094b59bf056d485658e04418bea487cd7569c264e1c2b84d297e
+  metadata.gz: 14190aec17bc2282d956db77e43a6118fbbe8ed156e53ca295f9064b202706b1
+  data.tar.gz: 2bcb76de61764a863882b3f40d9af35d2ff9867b0d8a00d31346e81a677c00f7
 SHA512:
-  metadata.gz: 1b68f3edbb97a521f726df53e48f1906b5e5d27e275c03557fe15239246be400a6185de4eccfa85949276b01921a52ba5b022e7e9779284fefb47b834d00602d
-  data.tar.gz: b9f3c4a58eed62050a387f6d5008b74000bd336c0e8f1d76e7c4352d57d48e3b759a85479170d61663e57c7e8d2033441db71cd2f4613445f2e08a1c71660e39
+  metadata.gz: db6ad54b41a91e677c45a4b73534499b892b34788abb1dcbba699d30df0fdf389b193f459727bac9af6c3010c82d2b4c30d6afb1eb663da5e61117a4f826feea
+  data.tar.gz: 65f652cf3a00c6a17006c15567b26d5ded49674c31c75ccfa03e6663c9d3494cbcc009f941c3227a36d5af8897853b4ece9a3fc598ad444877c7558594cd0797

data/CHANGELOG.md

@@ -1,2 +1,8 @@
+## 0.1.2
+  - [DOC] Adds "Technical Preview" call-out to documentation [#4](https://github.com/logstash-plugins/logstash-input-elastic_serverless_forwarder/pull/4)
+
+## 0.1.1
+  - Fixes an issue that prevents this prototype from being instantiated in an actual Logstash pipeline [#3](https://github.com/logstash-plugins/logstash-input-elastic_serverless_forwarder/pull/3)
+
 ## 0.1.0
   - Working Prototype: New input to receive events from Elastic Serverless Forwarder (ESF) over HTTP(S) [#1](https://github.com/logstash-plugins/logstash-input-elastic_serverless_forwarder/pull/1)

data/docs/index.asciidoc

@@ -26,45 +26,58 @@ include::{include_path}/plugin_header.asciidoc[]
 Using this input you can receive events from {esf-name} over http(s) connections to the configured <<plugins-{type}s-{plugin}-port>>.
 
 [id="plugins-{type}s-{plugin}-ext-field"]
-====== Minimum Configuration
+===== Minimum Configuration
 [cols="3a,2a"]
 |=======================================================================================================================
 |SSL Enabled              |SSL Disabled
 
 |
 
-[source,subs="+macros,attributes"]
+[source]
 ----
 input {
-  {plugin} {
-    <<plugins-{type}s-{plugin}-port,port>> => 8080
-    <<plugins-{type}s-{plugin}-ssl_certificate,ssl_certificate>> => "/path/to/logstash.crt"
-    <<plugins-{type}s-{plugin}-ssl_key,ssl_key>> => "/path/to/logstash.key"
+  elastic_serverless_forwarder {
+    port => 8080
+    ssl_certificate => "/path/to/logstash.crt"
+    ssl_key => "/path/to/logstash.key"
   }
 }
 ----
 
 |
 
-[source,subs="+macros,attributes"]
+[source]
 ----
 input {
   elastic_serverless_forwarder {
-    <<plugins-{type}s-{plugin}-port,port>> => 8080
-    <<plugins-{type}s-{plugin}-ssl,ssl>> => false
+    port => 8080
+    ssl => false
   }
 }
 ----
 
 |=======================================================================================================================
 
+.Technical Preview
+****
+This {esf-name} input plugin is part of a _Technical Preview_, which means that both configuration options and implementation details are subject to change in minor releases without being preceded by deprecation warnings.
+
+Before upgrading this plugin or Logstash itself, please pay special attention to this plugin's https://github.com/logstash-plugins/logstash-input-elastic_serverless_forwarder/blob/main/CHANGELOG.md[CHANGELOG.md] to avoid being caught by surprise.
+****
+
+
 [id="plugins-{type}s-{plugin}-enrichment"]
 ==== Enrichment
 
 This input provides _minimal enrichment_ on events, and avoids including information about itself, the client from which it received the data, or about the original event as-decoded from the request.
-If the decoded event has a valid ISO8601-encoded `@timestamp`, it will be used. Otherwise this required field will be populated with the current time.
 
 NOTE: Senders are advised to use care with respect to fields that are {logstash-ref}/processing.html#reserved-fields[reserved in Logstash].
+      ESF sends the Logstash-required `@timestamp` field by default, but if this value is missing it will be populated with the current time.
+
+
+////
+// BEGIN: Elastic-internal implementation details
+//
 
 [id="plugins-{type}s-{plugin}-blocking"]
 ==== Blocking Behavior
@@ -76,6 +89,10 @@ A client that receives an HTTP request timeout is expected to retry the entire r
 When this plugin is blocked, it will reject _new_ requests with HTTP `429 Too Many Requests`.
 Clients that receive `429`-s are expected to wait a moment before retrying the request — exponential back-off is encouraged to ease flood recovery.
 
+//
+// END: Elastic-internal implementation details
+////
+
 [id="plugins-{type}s-{plugin}-security"]
 ==== Security
 
@@ -87,7 +104,7 @@ Additionally, you may wish to authenticate clients using SSL client authenticati
 
 ===== SSL Identity
 
-In order to establish SSL with a client, this input plugin will need to present an SSL certificate that the client trusts and have access to the associated key.
+In order to establish SSL with a client, this input plugin will need to present an SSL certificate that the client trusts, and have access to the associated key.
 These are configurable with <<plugins-{type}s-{plugin}-ssl_certificate>>, <<plugins-{type}s-{plugin}-ssl_key>>, and optionally <<plugins-{type}s-{plugin}-ssl_key_passphrase>>.
 
 ===== SSL Client Authentication
@@ -98,6 +115,8 @@ It can be configured to either request or require client certificates using <<pl
 which often also requires configuring it with a list of <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> to trust.
 When validating a certificate that is presented, <<plugins-{type}s-{plugin}-ssl_verification_mode>> controls how certificates are verified.
 
+NOTE: ESF does not currently support _presenting_ client certificates, so requesting or requiring clients to present identity is only useful when combined with an SSL-terminating proxy.
+
 ===== SSL Advanced Configuration
 
 This plugin exposes several advanced SSL configurations:
@@ -233,7 +252,7 @@ For example, the ChaCha20 family of ciphers is not supported in older versions.
 * Default value is `"none"`
 
 By default the server doesn't do any client authentication.
-This means that connections from clients are private by default, but that this input will allow SSL connections from _any_ client.
+This means that connections from clients are _private_ when SSL is enabled, but that this input will allow SSL connections from _any_ client.
 If you wish to configure this plugin to reject connections from untrusted hosts, you will need to configure this plugin to authenticate clients, and may also need to configure it with a list of `ssl_certificate_authorities`.
 
 [id="plugins-{type}s-{plugin}-ssl_handshake_timeout"]

data/lib/logstash/inputs/elastic_serverless_forwarder.rb

@@ -12,9 +12,6 @@ class LogStash::Inputs::ElasticServerlessForwarder < LogStash::Inputs::Base
 
   config_name "elastic_serverless_forwarder"
 
-  # no-codec
-  config :codec, obsolete: 'The elastic_serverless_forwarder input does not have an externally-configurable codec'
-
   # bind address
   config :host, :validate => :string, :default => "0.0.0.0"
   config :port, :validate => :number, :required => true
@@ -54,6 +51,11 @@ class LogStash::Inputs::ElasticServerlessForwarder < LogStash::Inputs::Base
 
   def initialize(*a)
     super
+
+    if original_params.include?('codec')
+      fail LogStash::ConfigurationError, 'The `elastic_serverless_forwarder` input does not have an externally-configurable `codec`'
+    end
+
     @internal_http = plugin_factory.input('http').new(inner_http_input_options)
   end
 

data/logstash-input-elastic_serverless_forwarder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'logstash-input-elastic_serverless_forwarder'
-  s.version = '0.1.0'
+  s.version = '0.1.2'
   s.licenses = ['Apache License (2.0)']
   s.summary = "Receives events from Elastic Serverless Forwarder over HTTP or HTTPS"
   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"

data/spec/inputs/elastic_serverless_forwarder_spec.rb

@@ -41,6 +41,38 @@ describe LogStash::Inputs::ElasticServerlessForwarder do
       esf_input.stop
     end
 
+
+  end
+
+  context 'no user-defined codec' do
+    let(:config) { super().merge('ssl' => false) } # minimal config
+
+    ##
+    # @codec ivar is required PENDING https://github.com/elastic/logstash/issues/14828
+    context 'codec handling' do
+      it 'has an `@codec` ivar that inherits from `LogStash::Codecs::Base`' do
+        expect(esf_input).to be_instance_variable_defined(:@codec)
+        codec = esf_input.instance_variable_get(:@codec)
+
+        expect(codec).to_not be_nil
+        expect(codec.class).to be < LogStash::Codecs::Base # LogStash::Codecs::Delegator shenanigans
+      end
+    end
+
+    context 'when instantiated with a string codec' do
+      let(:config) { super().merge("codec" => "json_lines") }
+      it 'fails with a helpful configuration error' do
+        expect { described_class.new(config) }.to raise_exception(LogStash::ConfigurationError, a_string_including("codec"))
+      end
+    end
+
+    context 'when instantiated with a codec instance' do
+      let(:codec_instance) { Class.new(LogStash::Codecs::Base) { config_name 'test'}.new("id" => "123") }
+      let(:config) { super().merge("codec" => codec_instance) }
+      it 'fails with a helpful configuration error' do
+        expect { described_class.new(config) }.to raise_exception(LogStash::ConfigurationError, a_string_including("codec"))
+      end
+    end
   end
 
   shared_context "basic request handling" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-elastic_serverless_forwarder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement