OpenBlockperf
A CLI tool and systemd service that captures and shares network metrics from a Cardano relay node.
The client collects selected tracer and peering data from a local relay so stake pool operators can contribute to a shared view of block propagation and connectivity. It is intended for relay nodes that sit between a stake pool producer and the rest of the network. Running it on a producer is possible but not recommended. In normal operation it runs as a systemd service.
Release notes
- v0.0.38 - 2026-09-09
- register-ip / register-calidus probe healthy SRV edges and fail over on HTTP 5xx
- service mode fails over on HTTP 5xx (e.g. 503 queue full) to the next edge
- installer checks for an existing install directory before the wizard
- installer retries relay API key registration up to three times
- compact blocksample journal lines: short hash, block number, edge name
- compact peer-event journal lines: remote IP and old > new status
- v0.0.37 - 2026-09-03
- increased submit timouts
- filter private IPs
- installer script improved on regsiter-ip"
- v0.0.36 - 2026-09-02
- improved logging
- use SRV targets by RTT rank and failover;
Installation
You can install the package from PyPI:
pip install openblockperf
A plain pip install only provides the blockperf command. It does not
discover your cardano-node unit, write config.json, or install the systemd
service.
The recommended way on a Linux relay is the installer script. It installs the PyPI package into a dedicated virtualenv and wires it into the existing node installation and network configuration (systemd unit, config file, service user, and CLI wrapper):
curl -fsSL https://raw.githubusercontent.com/cardano-foundation/openblockperf/main/blockperf-install.sh -o blockperf-install.sh
chmod +x blockperf-install.sh
sudo ./blockperf-install.sh
Documentation
Full guides live in the openblockperf GitHub repository:
- Installer Guide for installer modes, options, API key flow, and updates
- Manual Installation Guide for a step-by-step setup that mirrors the installer
- Client Overview for what the client reports and why the shared telemetry matters
- Trace Options Guide for the cardano-node tracer settings the client needs
Release files for openblockperf 0.0.38
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openblockperf-0.0.38.tar.gz | 64.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openblockperf-0.0.38-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 121.4 kB
Release files / openblockperf-0.0.38.tar.gz
| Download URL | openblockperf-0.0.38.tar.gz |
|---|---|
| Size | 64.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e673ca1885bc9d7326cabb39673114a510d4d95fcfa38ca216ae501f741d9796
|
|
BLAKE2b-256 checksum How to use checksums |
fe54350a282f564e0012f128209f035a31f85f84ac990e5c6d64388e2a234210
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / openblockperf-0.0.38-py3-none-any.whl
| Download URL | openblockperf-0.0.38-py3-none-any.whl |
|---|---|
| Size | 57.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f2bd5b0cd954f2b0cd1381e5a84f044762f3ce5dff7c355d04ba17f047c3a10d
|
|
BLAKE2b-256 checksum How to use checksums |
3f4e363844b5d6b666114f002d46fc308c1508e91f0074342b6fe7e33d5a5a19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
