Name: logstash-codec-protobuf
Owner: Logstash Plugins
Description: Codec plugin for parsing Protobuf messages
Created: 2016-04-29 21:47:47.0
Updated: 2018-04-18 08:14:09.0
Pushed: 2018-04-23 16:46:14.0
Homepage: null
Size: 62
Language: Ruby
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This is a codec plugin for Logstash to parse protobuf messages.
bin/logstash-plugin install logstash-codec-protobuf
include_path (required): an array of strings with filenames where logstash can find your protobuf definitions. Please provide absolute paths. For directories it will only try to import files ending on .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. See examples below.
protobuf_version (optional): set this to 3 if you want to use protobuf 3 definitions. Defaults to 2.
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:
kafka
{
zk_connect => "127.0.0.1"
topic_id => "unicorns_protobuffed"
codec => protobuf
{
class_name => "Animals::Unicorn"
include_path => ['/path/to/pb_definitions/Animal.pb.rb', '/path/to/pb_definitions/Unicorn.pb.rb']
}
}
Example for protobuf 3:
kafka
{
zk_connect => "127.0.0.1"
topic_id => "unicorns_protobuffed"
codec => protobuf
{
class_name => "Animals.Unicorn"
include_path => ['/path/to/pb_definitions/Animal_pb.rb', '/path/to/pb_definitions/Unicorn_pb.rb']
protobuf_version => 3
}
}
Imagine you have the following protobuf version 2 relationship: class Unicorn lives in namespace Animal::Horse and uses another class Wings.
module Animal
module Horse
class Unicorn
set_fully_qualified_name "Animal.Horse.Unicorn"
optional ::Animal::Bodypart::Wings, :wings, 1
optional :string, :name, 2
# here be more field definitions
Make sure to put the referenced wings class first in the include_path:
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 => "Animal::Horse::Unicorn"
for protobuf 2. For protobuf 3 use
class_name => "Animal.Horse.Unicorn"
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:
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.
Maybe your protobuf definition does not fullfill the requirements and needs additional fields. Run logstash with the –debug flag and search for error messages.
Tba.