Table of contents
- Caliper Introduction
- Installing Caliper
- Sample Networks
- How to Contribute
Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with custom use cases, and get a set of performance test results.
Supported blockchain solutions
Supported performance metrics
- Transaction/read throughput
- Transaction/read latency (minimum, maximum, average, percentile)
- Resource consumption (CPU, Memory, Network IO, …)
See the PSWG white paper for the exact definitions and corresponding measurement methods.
It helps to have a basic understanding of how Caliper works before diving into the examples. Have a look at the Architecture page!
Head to the Install & Usage page if you want to try Caliper right now. It’s as simple as downloading an NPM package or starting a Docker container!
Sample benchmarks that may be used by Caliper are hosted on a companion GitHub repository.
Performance reports for the provided samples are hosted on the documentation pages of the repository.
Important: make sure that the version/tag of the benchmark repository matches the version of Caliper you are using! For example, if you are using Caliper v0.5.0, then
v0.5.0tag after cloning the benchmark repository. The
mainbranch of the benchmark repository corresponds to the latest
How to Contribute
Every contribution is welcome! See the Contributing page for details.
The Caliper codebase is released under the Apache 2.0 license. Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at http://creativecommons.org/licenses/by/4.0/.