Skip to content

feat!: gather telemetry #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: rc.2
Choose a base branch
from
Draft

feat!: gather telemetry #56

wants to merge 6 commits into from

Conversation

0x009922
Copy link
Contributor

@0x009922 0x009922 commented Apr 7, 2025

TODO:

Overview

  • Accepts list or Torii URLs in the configuration
  • Continuously gather various information for each peer:
    • Its configuration
    • Its online peers
    • Its high-level metrics (requires telemetry feature in irohad)
    • Its geographical location by querying the host name of the peer URL to http://ip-api.com
  • Provide information such as status connection and telemetry support by the peer
  • Serve telemetry via oneshot requests or via a live-stream as updates are available
  • Improve and organise OpenAPI docs

Caveats:

API Changes

  • Removed GET /status
  • Added GET /telemetry/network for network metrics
  • Added GET /telemetry/peers for peers metrics (frequently updated)
  • Added GET /telemetry/peers-info for peers info (less frequently updated)
  • Added GET /telemetry/live for live updates of all abovementioned data via Server-Sent Events

Config Changes

Renamed --torii-url (IROHA_EXPLORER_TORII_URL) to --torii-urls (IROHA_EXPLORER_TORII_URLS) (urls) for comma-separated URLs of peers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant