stacks-network/stacks-core

[Network] /v3/diagnostics endpoint

Open

#5.403 geöffnet am 30. Okt. 2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Rust (758 Forks)auto 404
good first issue

Repository-Metriken

Stars
 (3.063 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

We spend a lot of time trawling logs for the same kinds of data. Instead, the node could just make the data available in a machine-readable form (e.g. JSON) over an RPC endpoint (proposing /v3/diagnostics). The API doesn't need to be stable, but it should provide a view into the node's state that's relevant to debugging common issues.

Contributor Guide

Research-Richtung
Studieren Sie die vorhandene HTTP API Struktur im Code, insbesondere die /v2 Endpunkte. Entwerfen Sie ein JSON Schema für Diagnosedaten, das den relevanten Knotenstatus (z. B. Verbindungen, Synchronisierungsstatus, Speichernutzung) offenlegt. Implementieren Sie eine neue Route /v3/diagnostics, die Beispieldaten zurückgibt.
Tech Stack
rust
Domain
backend api designnetworking
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
RustHTTPJSON
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65