stacks-network/stacks-core

[Network] /v3/diagnostics endpoint

Open

#5 403 ouverte le 30 oct. 2024

Voir sur GitHub
 (0 commentaires) (0 réactions) (1 assigné)Rust (758 forks)auto 404
good first issue

Métriques du dépôt

Stars
 (3 063 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Étudiez la structure de l'API HTTP existante dans le code, en particulier les points de terminaison /v2. Concevez un schéma JSON pour les données de diagnostic qui expose l'état pertinent du nœud (par exemple, connexions, état de synchronisation, utilisation de la mémoire). Implémentez une nouvelle route /v3/diagnostics qui renvoie des données d'exemple.
Stack technique
rust
Domaine
backend api designnetworking
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
RustHTTPJSON
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65