docs(gateway): gateway 剩余文件注释改中文(逐行 1:1,代码零字节改动)
主人 2026-10-03 拍板「注释一律中文」;gateway 至此整包注释中文化完成(本会话共 3 批: 已推库 16 个文件 + 本批剩余文件)。 校验:机械校验(非注释改动行)= 空;剥注释后代码文本逐行比对全等(不一致文件数 0); 全树 go test ./... 58 包 ok / 0 FAIL;交叉编译绿。
This commit is contained in:
1 parent
91e8d7a029
commit
074ffc4ebf
73 files changed
+2529
-2529
No files matched your search
@@ -11,16 +11,16 @@ import (
|
||||
"git.yeij.top/AskaEth/Cyrene_v2/internal/logger"
|
||||
)
|
||||
|
||||
// Log-tail endpoint tuning. Compile-time constants (project rule §10).
|
||||
// 日志尾部端点的调参。编译期常量(项目规范 §10)。
|
||||
const (
|
||||
defaultLogLimit = 200
|
||||
maxLogLimit = 1000
|
||||
)
|
||||
|
||||
// AdminLogEntry is the wire shape of one entry in
|
||||
// GET /api/v1/admin/observability/logs: {time,level,source,msg}. `time` is
|
||||
// RFC3339 UTC (matching trace/audit); `level` ∈ debug|info|warn|error; `source`
|
||||
// is the record's provenance tag, empty when the record carried none.
|
||||
// AdminLogEntry 是 GET /api/v1/admin/observability/logs 中一个条目的
|
||||
// 线上结构:{time,level,source,msg}。`time` 是
|
||||
// RFC3339 UTC(与 trace/audit 一致);`level` ∈ debug|info|warn|error;`source`
|
||||
// 是记录的来源标签,记录未携带时为空。
|
||||
type AdminLogEntry struct {
|
||||
Time string `json:"time"`
|
||||
Level string `json:"level"`
|
||||
@@ -28,10 +28,10 @@ type AdminLogEntry struct {
|
||||
Msg string `json:"msg"`
|
||||
}
|
||||
|
||||
// SetLogBuffer injects the process-wide log ring buffer behind
|
||||
// GET /api/v1/admin/observability/logs. The composition root calls it once the
|
||||
// gateway exists (the logger is built before the gateway); until then the
|
||||
// endpoint answers 501. It is safe to call concurrently.
|
||||
// SetLogBuffer 注入 GET /api/v1/admin/observability/logs 背后的
|
||||
// 进程级日志环形缓冲。组合根在网关存在后调用它
|
||||
// (logger 先于网关构建);在那之前该
|
||||
// 端点返回 501。并发调用是安全的。
|
||||
func (s *Server) SetLogBuffer(buf *logger.RingBuffer) {
|
||||
if s == nil || s.obs == nil {
|
||||
return
|
||||
@@ -39,7 +39,7 @@ func (s *Server) SetLogBuffer(buf *logger.RingBuffer) {
|
||||
s.obs.logBuf.Store(buf)
|
||||
}
|
||||
|
||||
// logBuffer returns the injected log ring buffer, or nil when none was injected.
|
||||
// logBuffer 返回已注入的日志环形缓冲,未注入时为 nil。
|
||||
func (s *Server) logBuffer() *logger.RingBuffer {
|
||||
if s == nil || s.obs == nil {
|
||||
return nil
|
||||
@@ -47,10 +47,10 @@ func (s *Server) logBuffer() *logger.RingBuffer {
|
||||
return s.obs.logBuf.Load()
|
||||
}
|
||||
|
||||
// adminObservabilityLogs returns the most recent backend log records, newest
|
||||
// first, optionally filtered to a minimum level (admin read). It is the backend
|
||||
// behind the panel's log tail: the records come from the logger's own ring
|
||||
// buffer and nothing is re-rendered or fabricated.
|
||||
// adminObservabilityLogs 返回最近的后端日志记录,最新
|
||||
// 优先,可选按最低级别过滤(管理读)。它是面板日志
|
||||
// 尾部背后的后端:记录来自 logger 自身的环形
|
||||
// 缓冲,没有任何东西被重新渲染或编造。
|
||||
func (s *Server) adminObservabilityLogs(w http.ResponseWriter, r *http.Request) {
|
||||
minLevel, filtered, ok := parseLogLevel(r.URL.Query().Get("level"))
|
||||
if !ok {
|
||||
@@ -85,7 +85,7 @@ func (s *Server) adminObservabilityLogs(w http.ResponseWriter, r *http.Request)
|
||||
writeJSON(w, http.StatusOK, out)
|
||||
}
|
||||
|
||||
// adminLogOf maps a captured log entry to the camelCase admin wire shape.
|
||||
// adminLogOf 把捕获的日志条目映射为驼峰式管理线上结构。
|
||||
func adminLogOf(e logger.Entry) AdminLogEntry {
|
||||
return AdminLogEntry{
|
||||
Time: e.Time.UTC().Format(time.RFC3339),
|
||||
@@ -95,9 +95,9 @@ func adminLogOf(e logger.Entry) AdminLogEntry {
|
||||
}
|
||||
}
|
||||
|
||||
// parseLogLevel resolves the ?level= filter. An empty value disables filtering
|
||||
// (filtered=false); debug/info/warn/error select that level and above; anything
|
||||
// else is rejected with ok=false so the handler answers 400.
|
||||
// parseLogLevel 解析 ?level= 过滤器。空值关闭过滤
|
||||
// (filtered=false);debug/info/warn/error 选中该级别及以上;其他任何
|
||||
// 取值都以 ok=false 拒绝,使 handler 返回 400。
|
||||
func parseLogLevel(raw string) (min slog.Level, filtered, ok bool) {
|
||||
switch strings.ToLower(strings.TrimSpace(raw)) {
|
||||
case "":
|
||||
@@ -115,8 +115,8 @@ func parseLogLevel(raw string) (min slog.Level, filtered, ok bool) {
|
||||
}
|
||||
}
|
||||
|
||||
// parseLogLimit parses the ?limit= query param, clamping to [1, maxLogLimit] and
|
||||
// selecting defaultLogLimit when absent or invalid.
|
||||
// parseLogLimit 解析 ?limit= 查询参数,夹取到 [1, maxLogLimit] 并在
|
||||
// 缺失或非法时选用 defaultLogLimit。
|
||||
func parseLogLimit(r *http.Request) int {
|
||||
n, err := strconv.Atoi(r.URL.Query().Get("limit"))
|
||||
if err != nil || n <= 0 {
|
||||
|
||||
Reference in new issue
Block a user