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