stacks-network/stacks-core

[Network] /v3/diagnostics endpoint

Open

#5,403 创建于 2024年10月30日

在 GitHub 查看
 (0 评论) (0 反应) (1 负责人)Rust (758 fork)auto 404
good first issue

仓库指标

Star
 (3,063 star)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
研究代码库中现有的HTTP API结构，特别是/v2端点。设计一个诊断数据的JSON模式，暴露相关的节点状态（例如连接、同步状态、内存使用）。实现一个新的路由/v3/diagnostics，返回示例数据。
技术栈
rust
领域
backend api designnetworking
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
RustHTTPJSON
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65