logstash-codec-protobuf 1.0.5 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a623045ad79469eeefd501735a5fc3284c19eef3
-  data.tar.gz: 1a4b69f9ae131f5abe2b55270073c975edcbeab3
+SHA256:
+  metadata.gz: afe37c419ffac934a07356c24954ab9534d6438363a8cbc3a4a9a9f7b4214cd0
+  data.tar.gz: 775f81231ce4181e43900251e5fea9906027efc5cbff2d65cd82d122b28fd977
 SHA512:
-  metadata.gz: 0e152a7b9675dbd1c430da257a340364944f71b430bd093913705f376971650cc46933395a492f38732dc3665472ca56ebdc3e995d0c5023236b67466a7dc835
-  data.tar.gz: a55114ffbc512e1ee31748093f864c1683e33536f590ded503cbae5ca2ec4f61754e7d518efc722593c9af4040270438f40fa05d3fa03ae27e334d1a61ff520c
+  metadata.gz: 02cff8a64b2bf3324d456b173b8b52761fb6ba8501f87e0011cc02328d75322552c794206fafa574919dc04e7bfe30fbb0f59e804a00f4550c57730913ff80fa
+  data.tar.gz: a431bd7300fa3dae4c16c82fd1dab79eefe8b1ea3552d5b9f9c8af175862867d029bd2ac398c1af445ec67e59cf12d010e61d5f75a3c159cfa64e294f7c1e178

data/CHANGELOG.md

@@ -1,4 +1,23 @@
-## 1.0.5
+## 1.2.5
+  - Encoder bugfix: avoid pipeline crash if encoding failed.
+
+## 1.2.4
+  - Encoder bugfix: avoid pipeline crash if encoding failed.
+
+## 1.2.3
+  - Add oneof information to @metadata (protobuf version 3 only).
+
+## 1.2.2
+  - Add type conversion feature to encoder
+
+## 1.2.1
+  - Keep original data in case of parsing errors
+
+## 1.2.0
+  - Autoload all referenced protobuf classes
+  - Fix concurrency issue when using multiple pipelines
+
+## 1.1.0
   - Add support for protobuf3
 
 ## 1.0.4

data/Gemfile

@@ -8,4 +8,4 @@ use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "
 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
+end

data/LICENSE

@@ -179,7 +179,7 @@
    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 "{}"
+      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
@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (c) 2012-2018 Elasticsearch http://www.elastic.co
+   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.
@@ -200,4 +200,3 @@
    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

@@ -3,73 +3,180 @@
 This is a codec plugin for [Logstash](https://github.com/elastic/logstash) to parse protobuf messages.
 
 # Prerequisites and Installation
- 
-* prepare your ruby versions of the protobuf definitions, for example using the ruby-protoc compiler from https://github.com/codekitchen/ruby-protocol-buffers
+
+* prepare your Ruby versions of the Protobuf definitions:
+  * For protobuf 2 use the [ruby-protoc compiler](https://github.com/codekitchen/ruby-protocol-buffers).
+  * For protobuf 3 use the [official google protobuf compiler](https://developers.google.com/protocol-buffers/docs/reference/ruby-generated).
 * install the codec: `bin/logstash-plugin install logstash-codec-protobuf`
-* use the codec in your logstash config file. See details below.
+* use the codec in your Logstash config file. See details below.
 
 ## Configuration
 
-include_path  (required): an array of strings with filenames or directory names where logstash can find your protobuf definitions. Please provide absolute paths. For directories it will only try to import files ending on .rb
+There are two ways to specify the locations of the ruby protobuf definitions:
+* specify each class and their loading order using the configurations `include_path`. This option will soon be deprecated in favour of the autoloader.
+* specify the path to the main protobuf class, and a folder from which to load its dependencies, using `class_file`  and `protobuf_root_directory`. The codec will detect the dependencies of each file and load them automatically.
 
-class_name    (required): the name of the protobuf class that is to be decoded or encoded.
+`include_path`  (optional): an array of strings with filenames where logstash can find your protobuf definitions. Requires absolute paths. Please note that protobuf v2 files have the ending `.pb.rb` whereas files compiled for protobuf v3 end in `_pb.rb`.  Cannot be used together with `protobuf_root_directory` or `class_file`.
 
-## Usage example: decoder
+`protobuf_root_directory` (optional): Only to be used in combination with `class_file`. Absolute path to the directory that contains all compiled protobuf files. Cannot be used together with `include_path`.
 
-Use this as a codec in any logstash input. Just provide the name of the class that your incoming objects will be encoded in, and specify the path to the compiled definition.
-Here's an example for a kafka input:
+`class_file`  (optional): Relative path to the ruby file that contains class_name. Only to be used in combination with `protobuf_root_directory`. Cannot be used together with `include_path`.
 
-	kafka 
-  	{
-      zk_connect => "127.0.0.1"
-      topic_id => "unicorns_protobuffed"
-      codec => protobuf 
-      {
-        class_name => "Unicorn"
-        include_path => ['/my/path/to/compiled/protobuf/definitions/UnicornProtobuf.pb.rb']
-      }
-  	}   
+`class_name`    (required): the name of the protobuf class that is to be decoded or encoded. For protobuf 2 separate the modules with ::. For protobuf 3 use single dots.
 
-### Example with referenced definitions
+`protobuf_version` (optional): set this to 3 if you want to use protobuf 3 definitions. Defaults to 2.
 
-Imagine you have the following protobuf relationship: class Cheese lives in namespace Foods::Dairy and uses another class Milk. 
+`stop_on_error` (optional): Decoder only: will stop the entire pipeline upon discovery of a non decodable message. Deactivated by default.
 
-	module Foods
-  		module Dairy
-    		class Cheese
-    			set_fully_qualified_name "Foods.Dairy.Cheese"
-			    optional ::Foods::Cheese::Milk, :milk, 1
-			    optional :int64, :unique_id, 2
-			    # here be more field definitions
+`pb3_encoder_autoconvert_types` (optional): Encoder only: will try to fix type mismatches between the protobuf definition and the actual data. Available for protobuf 3 only. Activated by default.
 
-Make sure to put the referenced Milk class first in the include_path:
+## Usage example: decoder
 
-	include_path => ['/path/to/protobuf/definitions/Milk.pb.rb','/path/to/protobuf/definitions/Cheese.pb.rb']
+Use this as a codec in any logstash input. Just provide the name of the class that your incoming objects will be encoded in, and specify the path to the compiled definition.
+Here's an example for a kafka input with protobuf 2:
+
+```ruby
+kafka
+{
+  topic_id => "..."
+  key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+
+  codec => protobuf
+  {
+    class_name => "Animals::Mammals::Unicorn"
+    include_path => ['/path/to/pb_definitions/Animal.pb.rb', '/path/to/pb_definitions/Unicorn.pb.rb']
+  }
+}
+```
+
+Example for protobuf 3, manual class loading specification (deprecated):
+
+```ruby
+kafka
+{
+  topic_id => "..."
+  key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  codec => protobuf
+  {
+    class_name => "Animals.Mammals.Unicorn"
+    include_path => ['/path/to/pb_definitions/Animal_pb.rb', '/path/to/pb_definitions/Unicorn_pb.rb']
+    protobuf_version => 3
+  }
+}
+```
+
+Example for protobuf 3, automatic class loading specification:
+
+```ruby
+kafka
+{
+  topic_id => "..."
+  key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  codec => protobuf
+  {
+    class_name => "Animals.Mammals.Unicorn"
+    class_file => '/path/to/pb_definitions/some_folder/Unicorn_pb.rb'
+    protobuf_root_directory => "/path/to/pb_definitions/"
+    protobuf_version => 3
+  }
+}
+```
+In this example, all protobuf files must live in a subfolder of `/path/to/pb_definitions/`.
+
+For version 3 class names check the bottom of the generated protobuf ruby file. It contains lines like this:
+
+```ruby
+Animals.Unicorn = Google::Protobuf::DescriptorPool.generated_pool.lookup("Animals.Unicorn").msgclass
+```
+
+Use the parameter for the lookup call as the class_name for the codec config.
+
+If you're using a kafka input please also set the deserializer classes as shown above.
+
+### Class loading order
+
+Imagine you have the following protobuf version 2 relationship: class Unicorn lives in namespace Animal::Horse and uses another class Wings.
+
+```ruby
+module Animal
+  module Mammal
+    class Unicorn
+      set_fully_qualified_name "Animal.Mammal.Unicorn"
+      optional ::Bodypart::Wings, :wings, 1
+      optional :string, :name, 2
+      ...
+```
+
+Make sure to put the referenced wings class first in the include_path:
+
+```ruby
+include_path => ['/path/to/pb_definitions/wings.pb.rb','/path/to/pb_definitions/unicorn.pb.rb']
+```
 
 Set the class name to the parent class:
-	
-	class_name => "Foods::Dairy::Cheese"
+
+```ruby
+class_name => "Animal::Mammal::Unicorn"
+```
+
+for protobuf 2. For protobuf 3 use
+
+```ruby
+class_name => "Animal.Mammal.Unicorn"
+```
 
 ## Usage example: encoder
 
-The configuration of the codec for encoding logstash events for a protobuf output is pretty much the same as for the decoder input usage as demonstrated above. There are some constraints though that you need to be aware of:
-* the protobuf definition needs to contain all the fields that logstash typically adds to an event, in the corrent data type. Examples for this are @timestamp (string), @version (string), host, path, all of which depend on your input sources and filters aswell. If you do not want to add those fields to your protobuf definition then please use a [modify filter](https://www.elastic.co/guide/en/logstash/current/plugins-filters-mutate.html) to [remove](https://www.elastic.co/guide/en/logstash/current/plugins-filters-mutate.html#plugins-filters-mutate-remove_field) the undesired fields.
-* object members starting with @ are somewhat problematic in protobuf definitions. Therefore those fields will automatically be renamed to remove the at character. This also effects the important @timestamp field. Please name it just "timestamp" in your definition.
+The configuration of the codec for encoding logstash events for a protobuf output is pretty much the same as for the decoder input usage as demonstrated above, with the following exception: when writing to the Kafka output,
+* do not set the `value_deserializer_class` or the `key_deserializer_class`.
+* do set the serializer class like so: `value_serializer => "org.apache.kafka.common.serialization.ByteArraySerializer"`.
 
+Please be aware of the following:
+* the protobuf definition needs to contain all the fields that logstash typically adds to an event, in the corrent data type. Examples for this are `@timestamp` (string), `@version` (string), `host`, `path`, all of which depend on your input sources and filters aswell. If you do not want to add those fields to your protobuf definition then please use a [modify filter](https://www.elastic.co/guide/en/logstash/current/plugins-filters-mutate.html) to [remove](https://www.elastic.co/guide/en/logstash/current/plugins-filters-mutate.html#plugins-filters-mutate-remove_field) the undesired fields.
+* object members starting with `@` are somewhat problematic in protobuf definitions. Therefore those fields will automatically be renamed to remove the at character. This also effects the important `@timestamp` field. Please name it just "timestamp" in your definition.
+* fields with a nil value will automatically be removed from the event. Empty fields will not be removed.
+* it is recommended to set the config option `pb3_encoder_autoconvert_types` to true. Otherwise any type mismatch between your data and the protobuf definition will cause an event to be lost. The auto typeconversion does not alter your data. It just tries to convert obviously identical data into the expected datatype, such as converting integers to floats where floats are expected, or "true" / "false" strings into booleans where booleans are expected.
+
+```ruby
+  kafka
+    {
+      codec => protobuf
+      {
+        class_name => "Animals.Mammals.Unicorn"
+        class_file => '/path/to/pb_definitions/some_folder/Unicorn_pb.rb'
+        protobuf_root_directory => "/path/to/pb_definitions/"
+        protobuf_version => 3
+      }
+      ...
+      value_serializer => "org.apache.kafka.common.serialization.ByteArraySerializer"
+    }
+  }
+```
 
 ## Troubleshooting
 
-### "uninitialized constant SOME_CLASS_NAME"
+### Decoder: Protobuf 2
+#### "uninitialized constant SOME_CLASS_NAME"
+
+If you include more than one definition class, consider the order of inclusion. This is especially relevant if you include whole directories. A definition might refer to another definition that is not loaded yet. In this case, please specify the files in the `include_path` variable in reverse order of reference. See 'Example with referenced definitions' above.
+
+#### no protobuf output
+
+Maybe your protobuf definition does not fullfill the requirements and needs additional fields. Run logstash with the `--debug` flag and search for error messages.
 
-If you include more than one definition class, consider the order of inclusion. This is especially relevant if you include whole directories. A definition might refer to another definition that is not loaded yet. In this case, please specify the files in the include_path variable in reverse order of reference. See 'Example with referenced definitions' above.
+### Decoder: Protobuf 3
 
-### no protobuf output
+#### NullPointerException
 
-Maybe your protobuf definition does not fullfill the requirements and needs additional fields. Run logstash with the --debug flag and grep for "error 2".
+Check for missing imports. There's a high probability that one of the imported classes has dependencies of its own and those are not being fully satisfied. To avoid this, consider using the autoloader feature by setting the configurations for `protobuf_root_directory` and `class_file`.
 
+### Encoder: Protobuf 3
 
-## Limitations and roadmap
+#### NullPointerException
 
-* maybe add support for setting undefined fields from default values in the decoder
+Check for missing imports. There's a high probability that one of the imported classes has dependencies of its own and those are not being fully satisfied. To avoid this, consider using the autoloader feature by setting the configurations for `protobuf_root_directory` and `class_file`.
 
 

data/docs/index.asciidoc

@@ -20,21 +20,70 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-This codec converts protobuf encoded messages into logstash events and vice versa. 
+This codec converts protobuf encoded messages into logstash events and vice versa. It supports the protobuf versions 2 and 3.
 
-Requires the protobuf definitions as ruby files. You can create those using the [ruby-protoc compiler](https://github.com/codekitchen/ruby-protocol-buffers).
+The plugin requires the protobuf definitions to be compiled to ruby files. +
+For protobuf 2 use the https://github.com/codekitchen/ruby-protocol-buffers[ruby-protoc compiler]. +
+For protobuf 3 use the https://developers.google.com/protocol-buffers/docs/reference/ruby-generated[official google protobuf compiler].
 
-The following shows a usage example for decoding events from a kafka stream:
+The following shows a usage example (protobuf v2) for decoding events from a kafka stream:
 [source,ruby]
-kafka 
+kafka
 {
- zk_connect => "127.0.0.1"
- topic_id => "your_topic_goes_here"
- codec => protobuf 
- {
-   class_name => "Animal::Unicorn"
-   include_path => ['/path/to/protobuf/definitions/UnicornProtobuf.pb.rb']
- }
+  topic_id => "..."
+  key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  codec => protobuf
+  {
+    class_name => "Animals::Mammals::Unicorn"
+    class_file => '/path/to/pb_definitions/some_folder/Unicorn.pb.rb'
+    protobuf_root_directory => "/path/to/pb_definitions/"
+  }
+}
+
+Decoder usage example for protobuf v3:
+[source,ruby]
+kafka
+{
+  topic_id => "..."
+  key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
+  codec => protobuf
+  {
+    class_name => "Animals.Mammals.Unicorn"
+    class_file => '/path/to/pb_definitions/some_folder/Unicorn_pb.rb'
+    protobuf_root_directory => "/path/to/pb_definitions/"
+    protobuf_version => 3
+  }
+}
+
+
+The codec can be used in input and output plugins. +
+When using the codec in the kafka input plugin please set the deserializer classes as shown above. +
+When using the codec in an output plugin:
+
+* make sure to include all the desired fields in the protobuf definition, including timestamp.
+  Remove fields that are not part of the protobuf definition from the event by using the mutate filter. Encoding will fail if the event has fields which are not in the protobuf definition.
+* the `@` symbol is currently not supported in field names when loading the protobuf definitions for encoding. Make sure to call the timestamp field `timestamp`
+  instead of `@timestamp` in the protobuf file. Logstash event fields will be stripped of the leading `@` before conversion.
+* fields with a nil value will automatically be removed from the event. Empty fields will not be removed.
+* it is recommended to set the config option `pb3_encoder_autoconvert_types` to true. Otherwise any type mismatch between your data and the protobuf definition will cause an event to be lost. The auto typeconversion does not alter your data. It just tries to convert obviously identical data into the expected datatype, such as converting integers to floats where floats are expected, or "true" / "false" strings into booleans where booleans are expected.
+* When writing to Kafka: set the serializer class: `value_serializer => "org.apache.kafka.common.serialization.ByteArraySerializer"`
+
+Encoder usage example (protobufg v3):
+
+[source,ruby]
+kafka
+  {
+    codec => protobuf
+    {
+      class_name => "Animals.Mammals.Unicorn"
+      class_file => '/path/to/pb_definitions/some_folder/Unicorn_pb.rb'
+      protobuf_root_directory => "/path/to/pb_definitions/"
+      protobuf_version => 3
+    }
+    value_serializer => "org.apache.kafka.common.serialization.ByteArraySerializer"
+  }
 }
 
 
@@ -45,62 +94,145 @@ kafka
 |=======================================================================
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-class_name>> |<<string,string>>|Yes
-| <<plugins-{type}s-{plugin}-include_path>> |<<array,array>>|Yes
+| <<plugins-{type}s-{plugin}-class_file>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-protobuf_root_directory>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-include_path>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-protobuf_version>> |<<number,number>>|Yes
+| <<plugins-{type}s-{plugin}-stop_on_error>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-pb3_encoder_autoconvert_types>> |<<boolean,boolean>>|No
 |=======================================================================
 
 &nbsp;
 
 [id="plugins-{type}s-{plugin}-class_name"]
-===== `class_name` 
+===== `class_name`
 
   * This is a required setting.
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-Name of the class to decode.
-If your protobuf definition contains modules, prepend them to the class name with double colons like so:
+Fully qualified name of the class to decode.
+Please note that the module delimiter is different depending on the protobuf version. For protobuf v2, use double colons:
+[source,ruby]
+class_name => "Animals::Mammals::Unicorn"
+
+For protobuf v3, use single dots:
 [source,ruby]
-class_name => "Foods::Dairy::Cheese"
+class_name => "Animals.Mammals.Unicorn"
 
-This corresponds to a protobuf definition starting as follows:
+For protobuf v3, you can copy the class name from the Descriptorpool registrations at the bottom of the generated protobuf ruby file. It contains lines like this:
 [source,ruby]
-module Foods
-   module Dairy
-       class Cheese
-           # here are your field definitions.
+Animals.Mammals.Unicorn = Google::Protobuf::DescriptorPool.generated_pool.lookup("Animals.Mammals.Unicorn").msgclass
+
+If your class references other definitions: you only have to add the name of the main class here.
+
+[id="plugins-{type}s-{plugin}-class_file"]
+===== `class_file`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Absolute path to the directory that contains all compiled protobuf files. If the protobuf definitions are spread across multiple folders, this needs to point to the folder containing all those folders.
+
+[id="plugins-{type}s-{plugin}-protobuf_root_directory"]
+===== `protobuf_root_directory`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Absolute path to the root directory that contains all referenced/used dependencies of the main class (`class_name`) or any of its dependencies. Must be used in combination with the `class_file` setting, and can not be used in combination with the legacy loading mechanism `include_path`.
+
+Example:
+
+[source]
+ pb3
+   ├── header
+   │   └── header_pb.rb
+   ├── messageA_pb.rb
+
+In this case `messageA_pb.rb` has an embedded message from `header/header_pb.rb`.
+If `class_file` is set to `messageA_pb.rb`, and `class_name` to `MessageA`, `protobuf_root_directory` must be set to `/path/to/pb3`, which includes both definitions.
 
-If your class references other definitions: you only have to add the main class here.
 
 [id="plugins-{type}s-{plugin}-include_path"]
-===== `include_path` 
+===== `include_path`
 
-  * This is a required setting.
   * Value type is <<array,array>>
   * There is no default value for this setting.
 
-List of absolute pathes to files with protobuf definitions. 
-When using more than one file, make sure to arrange the files in reverse order of dependency so that each class is loaded before it is 
+Legacy protobuf definition loading mechanism for backwards compatibility:
+List of absolute pathes to files with protobuf definitions.
+When using more than one file, make sure to arrange the files in reverse order of dependency so that each class is loaded before it is
 refered to by another.
 
-Example: a class _Cheese_ referencing another protobuf class _Milk_
+Example: a class _Unicorn_ referencing another protobuf class _Wings_
 [source,ruby]
-module Foods
-  module Dairy
-        class Cheese
-           set_fully_qualified_name "Foods.Dairy.Cheese"
-           optional ::Foods::Cheese::Milk, :milk, 1
-           optional :int64, :unique_id, 2
-           # here be more field definitions
+module Animal
+  module Mammal
+    class Unicorn
+      set_fully_qualified_name "Animal.Mammal.Unicorn"
+      optional ::Bodypart::Wings, :wings, 1
+      optional :string, :name, 2
+      ...
 
 would be configured as
 [source,ruby]
-include_path => ['/path/to/protobuf/definitions/Milk.pb.rb','/path/to/protobuf/definitions/Cheese.pb.rb']
+include_path => ['/path/to/pb_definitions/wings.pb.rb','/path/to/pb_definitions/unicorn.pb.rb']
+
+Please note that protobuf v2 files have the ending `.pb.rb` whereas files compiled for protobuf v3 end in `_pb.rb`.
+
+Cannot be used together with `protobuf_root_directory` or `class_file`.
+
+[id="plugins-{type}s-{plugin}-protobuf_version"]
+===== `protobuf_version`
+
+  * Value type is <<number,number>>
+  * Default value is 2
+
+Protocol buffers version. Valid settings are 2, 3.
+
+[id="plugins-{type}s-{plugin}-stop_on_error"]
+===== `stop_on_error`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is false
+
+Stop entire pipeline when encountering a non decodable message.
 
-When using the codec in an output plugin: 
-* make sure to include all the desired fields in the protobuf definition, including timestamp. 
-  Remove fields that are not part of the protobuf definition from the event by using the mutate filter.
-* the @ symbol is currently not supported in field names when loading the protobuf definitions for encoding. Make sure to call the timestamp field "timestamp" 
-  instead of "@timestamp" in the protobuf file. Logstash event fields will be stripped of the leading @ before conversion.
- 
+[id="plugins-{type}s-{plugin}-pb3_encoder_autoconvert_types"]
+===== `pb3_encoder_autoconvert_types`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is true
+
+Convert data types to match the protobuf definition (if possible).
+The protobuf encoder library is very strict with regards to data types. Example: an event has an integer field but the protobuf definition expects a float. This would lead to an exception and the event would be lost.
+
+This feature tries to convert the datatypes to the expectations of the protobuf definitions, without modifying the data whatsoever. Examples of conversions it might attempt:
+
+  `"true" :: string => true :: boolean`
+
+  `17 :: int => 17.0 :: float`
+
+  `12345 :: number => "12345" :: string`
+
+Available only for protobuf version 3.
+
+[id="plugins-{type}s-{plugin}-pb3_set_oneof_metainfo"]
+===== `pb3_set_oneof_metainfo`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is false
+
+Add meta information to `[@metadata][pb_oneof]` about which classes were chosen for [oneof](https://developers.google.com/protocol-buffers/docs/proto3#oneof) fields. A new field of name `[@metadata][pb_oneof][FOO]` will be added, where `FOO` is the name of the `oneof` field.
+
+Example values: for the protobuf definition
+[source,ruby]
+    oneof :horse_type do
+      optional :unicorn, :message, 2, "UnicornType"
+      optional :pegasus, :message, 3, "PegasusType"
+    end
 
+the field `[@metadata][pb_oneof][horse_type]` will be set to either `pegasus` or `unicorn`.
+Available only for protobuf version 3.