RSK node bandwidth consumption monitor

bguiz commented 3 years ago

RSK node bandwidth consumption monitor

Prize Bounty

0.02570 RBTC

(approximately 1600 USD at time of posting)

Challenge Description

Create a tool which instruments RSKj to collect and export bandwidth consumption data.

The bandwidth consumption should be categorised by wire message type (all message types must be processed).

The block synchronisation should distinguish between:

blockchain tip synchronization, and
old data synchronization.

This will be distinguished by logging the current bestchain height, and comparing the block heights of blocks received and sent to to the best block height, in a separate application that parses the log (not required for this issue).

It should measure in-bound and out-bound bandwidth separately.

Log in a separated JSON file or CSV file (in a format that allows it to be displayed in a browser-based charting library) the following information:

Unix time
Character I if the message is Inbound or character O if the message is outbound.
Message size
Message command (code) or BEST_BLOCK_CHANGE in the case of extending the best chain by one block
When sending a block, receiving a block or extending the best chain, log the block height

Relevant code in RSKJ:

MessageVisitor >> apply(BlockMessage message) MessageCodec >> decodeMessage(List frames)

Submission Requirements

The submission should

Be an external diagnostic tool
Not require any modifications to the RSK blockchain node software (RSKj)
Perform the tasks detailed in "Challenge Description"
Include a link to a public Github repo
Use the same software licence as RSKj (GPL-3.0)

Note that integration/ implementation of a UI that renders the chart is optional, and this bounty only requires one to state which charting library can accept the exported JSON or CSV. Bonus points for submissions that do include this.

Note that if you assess that modifications to RSKj are needed, please get in touch with us to discuss beforehand.

Judging Criteria

Only one submission allowed per participant. Where a participant wishes to resubmit, update the original submission instead of submitting a separate entry.
If the submission involves a graphical user interface of any variety, please include a video recording of it in action.
If the submission involves a command line interface of any variety, please include a text file of it in action (including outputs).
Test coverage for any implementation is viewed favourably: More test coverage is better.
In cases where the bounty requires a Github PR on an existing repo, and that repo has continuous integration (CI) set up, the PR should not fail on the CI steps.
Documentation is viewed favourably: Include specific instructions on how to set up and use your submission. Optionally, include any explanations of architectural/ design choices that went into the submission.
The easier it is for the reviewer to run and understand the submission, the better, so be sure to consider this in your submissions!

Winner Announcement Date

This bounty is part of a hackathon, and there are three significant dates:
- Start date: 15/04/2021
- End date: 14/05/2021
- Results date: 15/06/2021
Submissions are welcome between the start date and the end date.
Reviews will be conducted between the end date and the results date.
All submissions must be submitted prior to the end date in order to be eligible for a bounty award.
Submissions submitted or resubmitted after the end date may not be awarded any bounty.
All submissions must be reviewed and accepted (successfully pass the review) prior to the results date in order to be eligible for a bounty award.
The bounty will be awarded on the Gitcoin platform to the best submission among all eligible submissions for this bounty.

More information

For questions related to this bounty, and other bounties in this hackathon, please join the RSK Slack, and check out the #gitcoin2021 channel.
To learn more about RSK and RIF technologies, check out our Developer Portal.

gitcoinbot commented 3 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

This issue now has a funding of 0.0257 RBTC (1595.87 USD @ $62096.0/RBTC) attached to it.

If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
- Want to chip in? Add your own contribution here.
- Questions? Checkout Gitcoin Help or the Gitcoin's Discord
- $2,125,907.18 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 3 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work has been started.

These users each claimed they can complete the work by 3 days, 5 hours from now. Please review their action plans below:

1) sladecek has started work.

rsk-nbc 2) fletch575 has started work.

Bandwidth monitor testing

Learn more on the Gitcoin Issue Details page.

gitcoinbot commented 3 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 0.0257 RBTC (1276.54 USD @ $48919.0/RBTC) has been submitted by:

Learn more on the Gitcoin Issue Details page
Want to chip in? Add your own contribution here.
Questions? Checkout Gitcoin Help or the Gitcoin's Discord
$2,374,290.37 more funded OSS Work available on the Gitcoin Issue Explorer

rsksmart / rsk-gitcoin-hackathon-2021