Karafka::Avro::Parser
Karafka Parser for Apache Avro. It uses the great AvroTurf gem by under the hood.
Installation
Add this line to your application's Gemfile:
gem 'karafka-avro-parser'
And then execute:
$ bundle
Usage
Thanks to Karafka's modular design, you only have to define a parser
the moment you draw your consumer groups.
Example with Schema Folder
Karafka::Parsers::Avro.schemas_path = 'app/schemas'
App.consumer_groups.draw do
consumer_group :my_consumer_group do
topic :my_topic do
consumer AvroConsumer
parser Karafka::Parsers::Avro.from_path('schema_name')
end
end
end
Example with a Codec
Karafka::Parsers::Avro.schemas_path = 'app/schemas'
App.consumer_groups.draw do
consumer_group :my_consumer_group do
topic :my_topic do
consumer AvroConsumer
parser Karafka::Parsers::Avro.from_path('schema_name', codec: 'deflate')
end
end
end
Example with Schema Registry
Karafka::Parsers::Avro.registry_url = 'http://my-registry:8081/'
App.consumer_groups.draw do
consumer_group :my_consumer_group do
topic :my_topic do
consumer AvroConsumer
parser Karafka::Parsers::Avro.from_registry('schema_name')
end
end
end
Note: schema_name
is not specifically required when using a schema registry, as the schema id is contained within the message, it can be passed in optionally if you are using one schema per topic
Note on contributions
First, thank you for considering contributing to Karafka! It's people like you that make the open source community such a great community!
Each pull request must pass all the RSpec specs and meet our quality requirements.
To check if everything is as it should be, we use Coditsu that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.
Coditsu will automatically check your work against our quality standards. You can find your commit check results on the builds page of Karafka organization.