Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cortze/looking-up-ipfs
Test the lookup performance (sequentially and concurrently) of IPFS's DHT
https://github.com/cortze/looking-up-ipfs
Last synced: 16 days ago
JSON representation
Test the lookup performance (sequentially and concurrently) of IPFS's DHT
- Host: GitHub
- URL: https://github.com/cortze/looking-up-ipfs
- Owner: cortze
- License: mit
- Created: 2023-09-13T12:02:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-03T14:18:01.000Z (about 1 year ago)
- Last Synced: 2024-10-18T16:38:35.925Z (2 months ago)
- Language: Go
- Size: 108 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# looking-up-ipfs
Wondering how well does IPFS' DHT code perform doing multiple operations concurrently? Multiple provides and retreivals? This repo contains the tools that you really need!
## Features
- Basic command line cli to configure the study.
- Custom Fork of `go-libp2p-kad-dht` to extract metrics from the most common used operations.
- Basic `csv` exporter for the individual operations + the aggragation of the jobs.
- Simple visualization scripts in Jupyter Notebook.
## Installation
You can install **looking-up-ipfs** using `make`:
```bash
make dependencies
make build
```
## Usage
Here's how you can use the tool from the command line:
```shell
NAME:
looking-up-ipfs - benchmarks the concurrency performance of IPFS DHT
USAGE:
looking-up-ipfs [subcommands] [arguments]
COMMANDS:
run
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
```
Example:
```shell
mkdir results
./build/looking-up-ipfs run --lookups 75 --jobs 100 --output results/test
```
will produce something like this:
```
results/
├── 100_jobs_indv_provide_summary.csv
├── 100_jobs_indv_retrieval_summary.csv
├── 100_jobs_provide_jobs_summary.csv
└── 100_jobs_retrieval_jobs_summary.csv
```
## Contributing
If you want to contribute to this project, please follow these guidelines:
- Fork the repository
- Create a new branch
- Make your changes
- Submit a pull request
- Bugs and Issues
If you encounter any bugs or issues, please report them here.
## Contact
Author: Mikel Cortes ([@cortze](https://github.com/cortze))
Feel free to reach out if you have any questions or suggestions!
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/cortze/looking-up-ipfs/blob/main/LICENSE) file for details.