Skip to main content

The OpenBlockperf client

Project description

OpenBlockperf - A cli tool to monitor and share network metrics from a cardano-node.

Package version

The OpenBlockperf Client is a cli tool that collects various data points from a local cardano node. If you dont know what a cardano-node is or dont run one yourself, this tool is probably not very usefull for you.


Installation / Get started

Install openblockperf client using our installer script:

curl -fsSL https://raw.githubusercontent.com/cardano-foundation/openblockperf/main/blockperf-install.sh | sudo bash

# Once installed you should have a 'blockperf' executable installed.
$ blockperf version

Usage

To run the client you need to specify which network it is in.

Usage Examples:

  # Use mainnet (default)
  blockperf run

  # Use preprod network
  blockperf run --network preprod

  # Use preview network
  blockperf run -n preview

  # Override API URL for local development
  blockperf run --api-url http://localhost:8000

  # Combine network with custom API URL
  blockperf run --network mainnet --api-url https://custom-api.example.com

  # Or use environment variable
  export OPENBLOCKPERF_NETWORK=preprod
  blockperf run

Registration

To register for an api key, you need to have a calidus key registered on chain. Then use the blockperf register command to start the registration. That You will receive a challenge that you will need to sign with your calidus key. Then submit that signature back to the api to receive the apikey.

blockperf register --

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openblockperf-0.0.25.tar.gz (45.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openblockperf-0.0.25-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

Details for the file openblockperf-0.0.25.tar.gz.

File metadata

  • Download URL: openblockperf-0.0.25.tar.gz
  • Upload date:
  • Size: 45.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.29 {"installer":{"name":"uv","version":"0.9.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for openblockperf-0.0.25.tar.gz
Algorithm Hash digest
SHA256 c9d6f5958105fb7f5b6863191f27eb90544288665d0bdae1f35ac2cf56dbdbcd
MD5 39bc0a072d75da82b0896ec37b0ecc09
BLAKE2b-256 3df0f64188d2950dcc493d595cd9ef11c8bdcbf14e88a18d647813a2739277f1

See more details on using hashes here.

File details

Details for the file openblockperf-0.0.25-py3-none-any.whl.

File metadata

  • Download URL: openblockperf-0.0.25-py3-none-any.whl
  • Upload date:
  • Size: 47.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.29 {"installer":{"name":"uv","version":"0.9.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for openblockperf-0.0.25-py3-none-any.whl
Algorithm Hash digest
SHA256 7aa6b6728bd27ffabf5bf308448e641a61c9c92d085c3445f5785ab619e2b082
MD5 09d4c83d151690b56d97f01c0bdfe557
BLAKE2b-256 1bceecd70199409e1438b6a27585444aec1060d43f176e6a7a69d11acf841557

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page