libp2p / libp2p/test-plans

Create test to show libp2p's performance compared to http

Open
#27 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
65
Forks
82
PR merge metrics
No merged PRs in 30d

Description

Done Criteria

We have benchmarks that shows the performance of libp2p using various transports/muxers in real world conditions compared to something standard in the web2 world like HTTP.

Why Important

Questions come in on, "why use libp2p and protocols build on top instead of something like http? Isn't http faster?" Ideally we should have data showing where libp2p transports/muxers stand.

User/Customer

Developers determining whether libp2p will be placing performance overhead, which can affect their decision to adopt libp2p as a whole.

Notes

  1. Initial focus is on go-libp2p but ideally other libp2p implementations can be added.
  2. https://github.com/filecoin-project/data-transfer-benchmark is likely a good place to start from.
  3. Minimum set of results is:
  • http
  • http over libp2p using TCP/Yamux
  • http over libp2p using QUIC
  1. When tests are run locally, we need to make sure an appropriate MTU is set: https://github.com/testground/testground/issues/1385
  2. Ideally though tests can be run against two distinct nodes sending traffic over the internet, which is the real world conditions we want to compare against. https://github.com/testground/testground/pull/1425 or https://github.com/testground/testground/issues/1392 is needed for this.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the data-transfer-benchmark project and the Testground issue #1385 plus PR #1425 or issue #1392. Define benchmark runs for HTTP, HTTP over libp2p TCP/Yamux, and HTTP over libp2p QUIC, using an appropriate MTU locally and distinct internet-connected nodes where supported. Done means reproducible results covering the requested transports and real-world conditions.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
networking, performance, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.