Add encoding selector option (base64 or binary)

[andsel]

Release notes

Add encoding option to select the encoding of Avro payload between base64 (default) and binary

What does this PR do?

Adds encoding set option to choose the encoding of Avro payload.
By default it's set to base64.

Why is it important/What is the impact to the user?

Let the user to decide whether to use binary or base64 encoding.

Checklist

• My code follows the style guidelines of this project
• [ ] I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• [ ] I have made corresponding change to the default configuration files (and/or docker env variables)
• I have added tests that prove my fix is effective or that my feature works

Author's Checklist

• run this gem in Logstash

How to test this PR locally

• clone this branch and configure Gemfile
• execute the pipeline:

input {
  generator {
    message => '{"id": "my account", "amount": 5.0}'
    count => 1 
    codec => json
  }
}

output {
  stdout {
    codec => avro {
      schema_uri => "/tmp/avro_schema_payment.asvc"
      base64_encoding => false
    }
  }
}

• Avro schema to save in /tmp/avro_schema_payment.asvc

{"namespace": "io.confluent.examples.clients.basicavro",
 "type": "record",
 "name": "Payment",
 "fields": [
     {"name": "id", "type": "string"},
     {"name": "amount", "type": "double"}
 ]
}

Related issues

• Closes [WIP] Add option to encode as binary RubyString instead of base64 #30

Use cases

As user I want to receive the binary Avro payload without base64 encoding.

[andsel]

I would ask if @karenzone could give a quick check to the documentation change

[yaauie]

I would prefer we avoid adding boolean options tied to the current implementation detail of there being two options, instead opting for a name that is descriptive of what the option controls and a value that is descriptive of what is being done. This allows us to leave room for additional options in the future, such as alternate encodings that may be introduced upstream.

In this case, something like:

encoding with values base64 and binary.

[karenzone]

+1 on previous comment. If you take this suggestion, the doc will need to be reworded. Please ping me and I'll review/retest doc then. :-)

[andsel]

Thanks for suggesting it. I've applied the hint, so it's ready for a review :-)

[karenzone]

I left a suggestion inline to streamline and simplify the wording. Otherwise, LGTM

[yaauie]

In general, LGTM. I've left two optional nitpick suggestions.

[andsel]

Published with https://rubygems.org/gems/logstash-codec-avro/versions/3.4.0-java