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.39 - 2026-09-09
- dual-stack IP registration: prove IPv4/IPv6 via /registration/ip/proof, submit proof tokens
- 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
- register-ip / register-calidus probe healthy SRV edges and fail over on HTTP 5xx
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

Metadata

Release files for openblockperf 0.0.39

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openblockperf 0.0.39
File	Size	Uploaded
openblockperf-0.0.39.tar.gz	67.2 kB	Sep 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for openblockperf 0.0.39
File	Interpreter	ABI	Platform	Reset
openblockperf-0.0.39-py3-none-any.whl 59.2 kB Sep 9, 2026	Python 3	none	any	Details

Total release size: 126.4 kB

Release files / openblockperf-0.0.39.tar.gz

Download URL	openblockperf-0.0.39.tar.gz
Size	67.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`4ebf3721dac31ce948db1c55c64f6629ec85ee3050d940a2cfb6880d53140db7`
BLAKE2b-256 checksum How to use checksums	`716674c644fd6671d9b6cdb845b2bdb2ddace92ca9e4293568cbdab899953167`
Upload date	Sep 9, 2026
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.39-py3-none-any.whl

Download URL	openblockperf-0.0.39-py3-none-any.whl
Size	59.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`44bebe9c8546aa4b318ed5f1fd054b5ced9802a2d347a4cd498898573ccebc9e`
BLAKE2b-256 checksum How to use checksums	`5580d3ef560410c7b2eac6926c0078b493805d4bd0db934f6a68cc1475450e32`
Upload date	Sep 9, 2026
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}`