stacks-network/stacks-core

[Network] /v3/diagnostics endpoint

Open

#5.403 aberto em 30 de out. de 2024

Ver no GitHub
 (0 comments) (0 reactions) (1 assignee)Rust (758 forks)auto 404
good first issue

Métricas do repositório

Stars
 (3.063 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Estude a estrutura existente da API HTTP no código, especialmente os endpoints /v2. Projete um esquema JSON para dados de diagnóstico que exponha o estado relevante do nó (por exemplo, conexões, status de sincronização, uso de memória). Implemente uma nova rota /v3/diagnostics que retorne dados de exemplo.
Pilha de tecnologia
rust
Domain
backend api designnetworking
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
RustHTTPJSON
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65