https://github.com/dasch/kafkalogue

A buffered log backed by Apache Kafka
https://github.com/dasch/kafkalogue

Last synced: 24 days ago
JSON representation

A buffered log backed by Apache Kafka

• Host: GitHub
• URL: https://github.com/dasch/kafkalogue
• Owner: dasch
• License: mit
• Created: 2015-09-30T14:49:38.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-30T14:59:16.000Z (about 9 years ago)
• Last Synced: 2024-04-25T14:02:48.134Z (7 months ago)
• Language: Ruby
• Size: 133 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Kafkalogue

A buffered log backed by [Apache Kafka](http://kafka.apache.org/). Kafkalogue is resilient to intermittent connectivity issues, as it buffers messages in memory.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'kafkalogue'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install kafkalogue

## Usage

```ruby

require 'kafkalogue'

# You need a list of Kafka brokers.

brokers = ["kafka1:9092", "kafka2:9092"]

# The Kafka topic that the log should be written to.

topic = "my-app.log"

log = Kafkalogue.new(brokers: brokers, topic: topic)

# Writes are buffered in memory; each entry must be accompanied by a key.

log.write("some data", key: "some-key")

log.write("any string works", key: "some-key")

# Calling flush will cause Kafkalogue to write the entries to the Kafka topic.

log.flush

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dasch/kafkalogue. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).