Skip to content

Commit

Permalink
Add CHANGELOG and README. (#2)
Browse files Browse the repository at this point in the history
- CHANGELOG
- README
  • Loading branch information
skirushkin authored Dec 19, 2023
1 parent d8f3e2a commit b35286a
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## 0.0.1
- Basic flow for usage.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Yabeda::RabbitMessaging

Built-in metrics for [TableSync](https://github.com/umbrellio/table_sync) out of the box!
Patch [rabbit_messaging](https://github.com/umbrellio/rabbit_messaging) gem.
Works through [Yabeda Framework](https://github.com/yabeda-rb).

## Installation

```ruby
gem "rabbit_messaging"
...
gem "yabeda"
gem "yabeda-rabbit_messaging"
```

And then execute:

```sh
$ bundle
```

After application launch gem patch `Rabbit::Receiving::Job` class to collect the metrics.

## Metrics

Metrics representing state of TableSync receiving jobs processing:

- Total number of executed jobs: `rabbit_messages_total` (segmented by `exchange`, `routing_key` and `success` status)
- Duration of executed jobs: `rabbit_messages_duration` (segmented by `exchange`, `routing_key` and `success` status)

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/table_sync.

## License

Released under MIT License.

## Authors

Team Umbrellio

---

<a href="https://github.com/umbrellio/">
<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg" alt="Supported by Umbrellio" width="439" height="72">
</a>

0 comments on commit b35286a

Please sign in to comment.