Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CHANGELOG and README. #2

Merged
merged 2 commits into from
Dec 19, 2023
Merged

Add CHANGELOG and README. #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
811eb75
dev.
Dec 19, 2023
1044364
dev.
Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
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
View file
Open in desktop
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>
Loading