Skip to content

docs: 补充 CI workflow 速率预算口径与一期告警内容 - #39

Merged
TangJia025 merged 2 commits into
mainfrom
docs/2061-ci-rate-budget-repos
Oct 26, 2026
Merged

TangJia025 merged 2 commits into
mainfrom
docs/2061-ci-rate-budget-repos

Conversation

@TangJia025

@TangJia025 TangJia025 commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

说明《可观测接入指南》5.4.1「速率预算」表中「21 仓」的统计口径,并补齐 A / B / B+ 各系数的推导。

变更内容

  • 21 仓是开通了 ARC runner 的仓库数,不是集群数也不是 scale set 数:取自 opensourceways/ascend-ci-deployment 仓 projects/<org>/<repo>/ 下存在 values.yaml 的目录,按 <org>/<repo> 去重(一个仓可以有多个 scale set,只算一次),快照 commit 26ca84d1(2026-10-20)。
  • 集群文档站 Cluster Map 由同一份部署配置自动生成,页面标注「21 Projects」,两边一致,可交叉核对;部署新增仓库时按实际仓数线性重算。
  • 补充系数说明:A 的 60 = 每分钟一轮 × 60 分钟;B 的 12 = 每 5 分钟一轮 × 12,两条列表指 queued 与 in_progress;B+ 的 12 同理,基数是在途 run 数(实测 20~40)。

告警内容(5.3.1)

新增「5.3.1 告警内容」,把一期两类面向人的告警写进文档,含规则模板与用户收到的邮件样式:

  • 失败告警 CIWorkflowRunFailing:只对门禁类 run(schedule / push / workflow_dispatch)逐次告警;PR 触发的失败不逐次报(实测单仓约 1 次/小时,且作者侧 GitHub 已有红叉)。
  • 排队过久告警 CIWorkflowQueueBacklog:按仓聚合 ci_workflow_oldest_queued_age_seconds > 1800,附时延(约 7 分钟)。
  • 附中心 Alertmanager 模板约束:cluster 标签不能缺(否则主题出现空括号)、warning 默认进黑洞、repo / workflow 不在邮件表格中渲染需写进 description、runbook 必填、group_by 需加维度。

背景

这部分说明在 PR #38 合入后才写好,原 commit(45cb223)推送时 PR 已是 MERGED,未进入 main。本 PR 是从 main 切分支后 cherry-pick 的结果(1211b3c),内容一致。

Resolves https://github.com/opensourceways/backlog/issues/2061

🤖 Generated with Claude Code

AI 使用声明

当前 PR 是否有 AI 参与:

  • 否
  • 是
    1. AI Agent 平台:Claude Code
    2. AI 模型:deepseek-v4-flash
    3. Prompt 上下文:追问速率预算表中「21 仓」的统计口径;据 ascend-ci-deployment 与集群文档站核对后补进文档

- 21 仓取自 ascend-ci-deployment 的 projects/<org>/<repo> 去重目录(快照 commit 26ca84d1)
- 与集群文档站 Cluster Map 的「21 Projects」同源,可交叉核对
- 补充 A/B/B+ 各系数的推导(轮询周期 × 每小时轮数、两条列表、在途 run 数)

Co-Authored-By: Claude Code <noreply@anthropic.com>
@opensourceways-bot

Copy link
Copy Markdown

Welcome To opensourceways Community

Hey @TangJia025 , thanks for your contribution to the community.

Bot Usage Manual

I'm the Bot here serving you. You can find the instructions on how to interact with me at Here . That means you can comment below every pull request or issue to trigger Bot Commands.

Contact Guide

If you have any questions, please contact the SIG: infratructure ,
and any of the maintainers: @GeorgeCao-hw, @TangJia025, @pkking, @zhongjun2 ,
and any of the committers: @GeorgeCao-hw, @TangJia025, @pkking, @zkhzkhz .

@opensourceways-bot

Copy link
Copy Markdown

CLA Signature Pass

TangJia025, thanks for your pull request. All authors of the commits have signed the CLA. 👍

- 失败告警只覆盖门禁类 run(schedule/push/workflow_dispatch),PR 触发不逐次报
- 排队告警按仓聚合 oldest_queued_age_seconds,阈值 30 分钟
- 附中心 Alertmanager 模板约束:cluster 标签不能缺、warning 进黑洞、
  repo/workflow 不在表格中渲染、runbook 必填、group_by 维度

Co-Authored-By: Claude Code <noreply@anthropic.com>
@TangJia025 TangJia025 changed the title docs: 说明 CI workflow 速率预算中 21 仓的来源与口径 docs: 补充 CI workflow 速率预算口径与一期告警内容 Oct 26, 2026
@TangJia025
TangJia025 merged commit b4dbd45 into main Oct 26, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants