logstash-codec-protobuf 1.3.0-java

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +56 -0
  3. data/CONTRIBUTORS +12 -0
  4. data/DEVELOPER.md +2 -0
  5. data/Gemfile +11 -0
  6. data/LICENSE +202 -0
  7. data/NOTICE.TXT +4 -0
  8. data/README.md +184 -0
  9. data/docs/index.asciidoc +241 -0
  10. data/google-protobuf-lib-update.md +57 -0
  11. data/lib/logstash/codecs/protobuf.rb +804 -0
  12. data/logstash-codec-protobuf.gemspec +33 -0
  13. data/spec/codecs/pb2_spec.rb +236 -0
  14. data/spec/codecs/pb3_decode_spec.rb +665 -0
  15. data/spec/codecs/pb3_encode_spec.rb +243 -0
  16. data/spec/helpers/pb2/ColourTestcase.pb.rb +35 -0
  17. data/spec/helpers/pb2/ColourTestcase.proto +24 -0
  18. data/spec/helpers/pb2/event.pb.rb +19 -0
  19. data/spec/helpers/pb2/event.proto +12 -0
  20. data/spec/helpers/pb2/header/header.pb.rb +16 -0
  21. data/spec/helpers/pb2/header/header.proto +8 -0
  22. data/spec/helpers/pb2/human.pb.rb +26 -0
  23. data/spec/helpers/pb2/unicorn.pb.rb +19 -0
  24. data/spec/helpers/pb2/unicorn_event.pb.rb +24 -0
  25. data/spec/helpers/pb3/FantasyHorse_pb.rb +48 -0
  26. data/spec/helpers/pb3/PhoneDirectory_pb.rb +37 -0
  27. data/spec/helpers/pb3/ProbeResult_pb.rb +26 -0
  28. data/spec/helpers/pb3/ResultListComposerRequest_pb.rb +25 -0
  29. data/spec/helpers/pb3/dnsmessage_pb.rb +82 -0
  30. data/spec/helpers/pb3/events_pb.rb +17 -0
  31. data/spec/helpers/pb3/header/header.proto3 +7 -0
  32. data/spec/helpers/pb3/header/header_pb.rb +12 -0
  33. data/spec/helpers/pb3/integertest_pb.rb +18 -0
  34. data/spec/helpers/pb3/messageA_pb.rb +16 -0
  35. data/spec/helpers/pb3/messageB_pb.rb +15 -0
  36. data/spec/helpers/pb3/rum2_pb.rb +87 -0
  37. data/spec/helpers/pb3/rum3_pb.rb +87 -0
  38. data/spec/helpers/pb3/rum_pb.rb +87 -0
  39. data/spec/helpers/pb3/struct_test_pb.rb +21 -0
  40. data/spec/helpers/pb3/unicorn_pb.rb +31 -0
  41. metadata +175 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f121402a30a05f70dff00bbb88be63b45f379f7fc8e894f7235d3ade8000b2db
4
+ data.tar.gz: 0e80f22fc253f825b2f88bdbe08639ea3a17f8da11f890ddb5bb77ed0a67b38d
5
+ SHA512:
6
+ metadata.gz: 5da0eebe88f1b488d8ec039777b327739111651fa0e660e1ad8d9f4ff82266e38682a45e7cd2c18932ce5f61cc12cdb53f3eea658927e80a364a7c99dd30ff03
7
+ data.tar.gz: 1e09074170a1362145d5b58ea28fd6f8de9511a136dc0e9355a5d40250ddb69ba950223d947c2c00c29e05d0d028ce7ddb16413ae9fa2375973ed26f6f3a4a38
data/CHANGELOG.md ADDED
@@ -0,0 +1,56 @@
1
+ ## 1.3.0
2
+ - Enforce XOR between options for one-of
3
+ - fix incorrect detection of metadata for one-of fields
4
+ - Update protobuf library to 3.23.4
5
+
6
+ ## 1.2.10
7
+ - Update gem platform to be "java" instead of "jruby" [#67](https://github.com/logstash-plugins/logstash-codec-protobuf/pull/67)
8
+
9
+ ## 1.2.9
10
+ - Fix decoding of structs
11
+
12
+ ## 1.2.8
13
+ - Update protobuf library to 3.22.2
14
+
15
+ ## 1.2.7
16
+ - TODO
17
+
18
+ ## 1.2.6
19
+ - [DOC] Fixed link format (from MD to asciidoc) [#61](https://github.com/logstash-plugins/logstash-codec-protobuf/pull/61)
20
+
21
+ ## 1.2.5
22
+ - Encoder bugfix: avoid pipeline crash if encoding failed.
23
+
24
+ ## 1.2.4
25
+ - Encoder bugfix: avoid pipeline crash if encoding failed.
26
+
27
+ ## 1.2.3
28
+ - Add oneof information to @metadata (protobuf version 3 only).
29
+
30
+ ## 1.2.2
31
+ - Add type conversion feature to encoder
32
+
33
+ ## 1.2.1
34
+ - Keep original data in case of parsing errors
35
+
36
+ ## 1.2.0
37
+ - Autoload all referenced protobuf classes
38
+ - Fix concurrency issue when using multiple pipelines
39
+
40
+ ## 1.1.0
41
+ - Add support for protobuf3
42
+
43
+ ## 1.0.4
44
+ - Update gemspec summary
45
+
46
+ ## 1.0.3
47
+ - Fix some documentation issues
48
+
49
+ ## 1.0.1
50
+ - Speed improvement, better exception handling and code refactoring
51
+
52
+ ## 1.0.0
53
+ - Update to v5.0 API
54
+
55
+ ## 0.1.2
56
+ - First version of this plugin
data/CONTRIBUTORS ADDED
@@ -0,0 +1,12 @@
1
+ The following is a list of people who have contributed ideas, code, bug
2
+ reports, or in general have helped logstash along its way.
3
+
4
+ Contributors:
5
+ * Inga Feick (ingafeick)
6
+ * Nicolai Schulten (krakenfuss)
7
+
8
+
9
+ Note: If you've sent us patches, bug reports, or otherwise contributed to
10
+ Logstash, and you aren't on the list above and want to be, please let us know
11
+ and we'll make sure you're here. Contributions from folks like you are what make
12
+ open source awesome.
data/DEVELOPER.md ADDED
@@ -0,0 +1,2 @@
1
+ # logstash-codec-protobuf
2
+ No special instructions!
data/Gemfile ADDED
@@ -0,0 +1,11 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
6
+ use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
7
+
8
+ if Dir.exist?(logstash_path) && use_logstash_source
9
+ gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
10
+ gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
11
+ end
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2020 Elastic and contributors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/NOTICE.TXT ADDED
@@ -0,0 +1,4 @@
1
+ Copyright (c) 2012-2016 Elasticsearch
2
+
3
+ This product includes software developed by The Apache Software
4
+ Foundation (http://www.apache.org/).
data/README.md ADDED
@@ -0,0 +1,184 @@
1
+ # Logstash protobuf codec
2
+
3
+ This is a codec plugin for [Logstash](https://github.com/elastic/logstash) to parse protobuf messages.
4
+
5
+ # Prerequisites and Installation
6
+
7
+ * prepare your Ruby versions of the Protobuf definitions:
8
+ * For protobuf 2 use the [ruby-protoc compiler](https://github.com/codekitchen/ruby-protocol-buffers).
9
+ * For protobuf 3 use the [official google protobuf compiler](https://developers.google.com/protocol-buffers/docs/reference/ruby-generated).
10
+ * install the codec: `bin/logstash-plugin install logstash-codec-protobuf`
11
+ * use the codec in your Logstash config file. See details below.
12
+
13
+ Note: the latest supported jruby version of Google's protobuf library is 3.22.2. If you need to use a more current version, please find instructions [here](google-protobuf-lib-update.md).
14
+
15
+ ## Configuration
16
+
17
+ There are two ways to specify the locations of the ruby protobuf definitions:
18
+ * specify each class and their loading order using the configurations `include_path`. This option will soon be deprecated in favour of the autoloader.
19
+ * 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.
20
+
21
+ `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`.
22
+
23
+ `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`.
24
+
25
+ `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`.
26
+
27
+ `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.
28
+
29
+ `protobuf_version` (optional): set this to 3 if you want to use protobuf 3 definitions. Defaults to 2.
30
+
31
+ `stop_on_error` (optional): Decoder only: will stop the entire pipeline upon discovery of a non decodable message. Deactivated by default.
32
+
33
+ `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.
34
+
35
+ ## Usage example: decoder
36
+
37
+ 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.
38
+ Here's an example for a kafka input with protobuf 2:
39
+
40
+ ```ruby
41
+ kafka
42
+ {
43
+ topic_id => "..."
44
+ key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
45
+ value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
46
+
47
+ codec => protobuf
48
+ {
49
+ class_name => "Animals::Mammals::Unicorn"
50
+ include_path => ['/path/to/pb_definitions/Animal.pb.rb', '/path/to/pb_definitions/Unicorn.pb.rb']
51
+ }
52
+ }
53
+ ```
54
+
55
+ Example for protobuf 3, manual class loading specification (deprecated):
56
+
57
+ ```ruby
58
+ kafka
59
+ {
60
+ topic_id => "..."
61
+ key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
62
+ value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
63
+ codec => protobuf
64
+ {
65
+ class_name => "Animals.Mammals.Unicorn"
66
+ include_path => ['/path/to/pb_definitions/Animal_pb.rb', '/path/to/pb_definitions/Unicorn_pb.rb']
67
+ protobuf_version => 3
68
+ }
69
+ }
70
+ ```
71
+
72
+ Example for protobuf 3, automatic class loading specification:
73
+
74
+ ```ruby
75
+ kafka
76
+ {
77
+ topic_id => "..."
78
+ key_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
79
+ value_deserializer_class => "org.apache.kafka.common.serialization.ByteArrayDeserializer"
80
+ codec => protobuf
81
+ {
82
+ class_name => "Animals.Mammals.Unicorn"
83
+ class_file => '/path/to/pb_definitions/some_folder/Unicorn_pb.rb'
84
+ protobuf_root_directory => "/path/to/pb_definitions/"
85
+ protobuf_version => 3
86
+ }
87
+ }
88
+ ```
89
+ In this example, all protobuf files must live in a subfolder of `/path/to/pb_definitions/`.
90
+
91
+ For version 3 class names check the bottom of the generated protobuf ruby file. It contains lines like this:
92
+
93
+ ```ruby
94
+ Animals.Unicorn = Google::Protobuf::DescriptorPool.generated_pool.lookup("Animals.Unicorn").msgclass
95
+ ```
96
+
97
+ Use the parameter for the lookup call as the class_name for the codec config.
98
+
99
+ If you're using a kafka input please also set the deserializer classes as shown above.
100
+
101
+ ### Class loading order
102
+
103
+ Imagine you have the following protobuf version 2 relationship: class Unicorn lives in namespace Animal::Horse and uses another class Wings.
104
+
105
+ ```ruby
106
+ module Animal
107
+ module Mammal
108
+ class Unicorn
109
+ set_fully_qualified_name "Animal.Mammal.Unicorn"
110
+ optional ::Bodypart::Wings, :wings, 1
111
+ optional :string, :name, 2
112
+ ...
113
+ ```
114
+
115
+ Make sure to put the referenced wings class first in the include_path:
116
+
117
+ ```ruby
118
+ include_path => ['/path/to/pb_definitions/wings.pb.rb','/path/to/pb_definitions/unicorn.pb.rb']
119
+ ```
120
+
121
+ Set the class name to the parent class:
122
+
123
+ ```ruby
124
+ class_name => "Animal::Mammal::Unicorn"
125
+ ```
126
+
127
+ for protobuf 2. For protobuf 3 use
128
+
129
+ ```ruby
130
+ class_name => "Animal.Mammal.Unicorn"
131
+ ```
132
+
133
+ ## Usage example: encoder
134
+
135
+ 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,
136
+ * do not set the `value_deserializer_class` or the `key_deserializer_class`.
137
+ * do set the serializer class like so: `value_serializer => "org.apache.kafka.common.serialization.ByteArraySerializer"`.
138
+
139
+ Please be aware of the following:
140
+ * 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.
141
+ * 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.
142
+ * fields with a nil value will automatically be removed from the event. Empty fields will not be removed.
143
+ * 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.
144
+
145
+ ```ruby
146
+ kafka
147
+ {
148
+ codec => protobuf
149
+ {
150
+ class_name => "Animals.Mammals.Unicorn"
151
+ class_file => '/path/to/pb_definitions/some_folder/Unicorn_pb.rb'
152
+ protobuf_root_directory => "/path/to/pb_definitions/"
153
+ protobuf_version => 3
154
+ }
155
+ ...
156
+ value_serializer => "org.apache.kafka.common.serialization.ByteArraySerializer"
157
+ }
158
+ }
159
+ ```
160
+
161
+ ## Troubleshooting
162
+
163
+ ### Decoder: Protobuf 2
164
+ #### "uninitialized constant SOME_CLASS_NAME"
165
+
166
+ 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.
167
+
168
+ #### no protobuf output
169
+
170
+ Maybe your protobuf definition does not fullfill the requirements and needs additional fields. Run logstash with the `--debug` flag and search for error messages.
171
+
172
+ ### Decoder: Protobuf 3
173
+
174
+ #### NullPointerException
175
+
176
+ 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`.
177
+
178
+ ### Encoder: Protobuf 3
179
+
180
+ #### NullPointerException
181
+
182
+ 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`.
183
+
184
+