feat(observability): Prometheus /metrics 端点——接入 Grafana 生态
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 45/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- docker-compose, grafana, prometheus, typescript
- 領域
- backend, devops, observability
調査の方向性
まず、issue で言及されている既存の request-logger の経路、circuit-breaker の状態遷移、キューへの受け入れロジックを追跡します。TypeScript サービスが認証済みエンドポイントをどのように公開しているか、また docker-compose がデプロイをどのように構成しているかを確認します。認証済みで任意に有効化できる /metrics エンドポイントが、制御されたラベルカーディナリティで、データベースクエリなしに、一覧にある Prometheus メトリクスを公開できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
背景
请求量、错误率、耗时、熔断状态、队列深度等运行数据目前只活在自建面板（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 模板随文档发布。
- 主要言語
- TypeScript
- スター
- 4
- フォーク
- 0
- 平均マージ
- 10分
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
g1331/AutoRouter のほかの issue
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
g1331/AutoRouter#235 ·
メンテナーはふだん 1 日以内に返信
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 42/100
g1331/AutoRouter#234 ·
メンテナーはふだん 1 日以内に返信
g1331/AutoRouter の issue をすべて見る
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 86/100
g1331/phantom-circuit#93 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
compiler
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
HerringtonDarkholme/hd-lang#1699 ·
メンテナーはふだん 1 日以内に返信
-
account bug communication lecture
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信