stacks-network/stacks-core

[Network] /v3/diagnostics endpoint

Open

#5403 aperta il 30 ott 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Rust (758 fork)auto 404
good first issue

Metriche repository

Star
 (3063 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Studia la struttura API HTTP esistente nel codice, in particolare gli endpoint /v2. Progetta uno schema JSON per i dati di diagnostica che esponga lo stato rilevante del nodo (ad esempio connessioni, stato di sincronizzazione, utilizzo della memoria). Implementa una nuova rotta /v3/diagnostics che restituisca dati di esempio.
Tech stack
rust
Dominio
backend api designnetworking
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
RustHTTPJSON
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65