feat(observability): Prometheus /metrics 端点——接入 Grafana 生态

Aperta
#236 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
docker-compose, grafana, prometheus, typescript

Direzione di ricerca

Inizia tracciando il percorso esistente del request-logger, le transizioni di stato del circuit-breaker e la logica di ammissione nella coda menzionati nell’issue. Verifica come il servizio TypeScript espone endpoint autenticati e come docker-compose configura il deployment. Il lavoro è completato quando un endpoint /metrics autenticato e abilitabile opzionalmente espone le metriche Prometheus elencate, con cardinalità delle label controllata e senza query al database.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

feature

背景

请求量、错误率、耗时、熔断状态、队列深度等运行数据目前只活在自建面板(dashboard / live pulse / rankings)里,无法接入外部监控生态。生产环境已是 docker-compose 部署,加一个 Prometheus 抓取端点即可挂进 Grafana / Alertmanager 等标准工具链。

方案:/metrics 端点

暴露 Prometheus 文本格式的指标端点,首批指标:

指标 类型 标签
请求总数 / 错误数 counter upstream, capability, status_class
请求耗时 / 首字节耗时 histogram upstream, capability
token 用量(输入/输出) counter upstream, model
熔断器状态 gauge upstream
上游健康状态 gauge upstream
并发占用 / 队列深度 gauge upstream
累计花费 counter upstream
设计要点
  • 指标在进程内存中累计(prom-client 或等价轻量实现),不查库,抓取零成本;进程重启计数归零符合 Prometheus counter 语义。
  • 埋点挂在现有链路节点:request-logger 记录处、熔断状态迁移处、队列准入处,避免新增旁路统计。
  • 端点鉴权:Bearer token(可复用 ADMIN_TOKEN 或独立的 METRICS_TOKEN 环境变量),未配置时端点关闭。
  • 标签基数控制:model 标签需白名单或截断口径,防止任意请求模型名撑爆基数。
  • 上游标签用 ID+名称,注意与“下游响应不携带上游身份”的约束区分——metrics 是管理侧出口,不受该约束,但需鉴权保护。

后续可扩展(本期不做)

  • OpenAI 兼容的 usage/dashboard API,供第三方用量统计工具直读。
  • Grafana dashboard JSON 模板随文档发布。
Lingua principale
TypeScript
Stelle
4
Fork
0
Merge medio
10m
PR unite (30g)
3

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di g1331/AutoRouter

Tutte le issue di g1331/AutoRouter

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.