Skip to content

docs(doc-review): daily review 2026-10-29 — RUM chart estimates and exact queries, trend granularity, incident Issue info - #1151

Open
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-10-29T081055Z
Open

flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-10-29T081055Z

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 29, 2026

Copy link
Copy Markdown

Doc Review — 2026-10-29

Mode: diff (since 2026-10-28T08:14:27Z → 2026-10-29T08:10Z)
Findings: 8 total — 1 high, 5 medium, 2 low (4 applied, 2 held, 2 skipped / already covered)

Changes

Finding Type Module Doc Action
f001 missing_coverage rum new zh/rum/analytics/chart-readings.mdx + en/… New page: the 估算 mark on dashboard charts, per-chart 精确查询 (one chart over all data), the 精确/精确计算中…/精确查询失败+重试 states, and that changing the range or filters returns the chart to estimates
f002 missing_coverage rum same new page New section: the overview 用户访问趋势 chart's 聚合粒度 (5 分钟 / 1 小时 / 1 天, unavailable reasons 时间范围过长 / 时间范围过短) and 分时 / 累积 switch, cumulative can't drill down, UV is not additive, 1-day buckets start at the display time zone's midnight
f008 missing_coverage rum same new page The per-account exact-query allowance (2 by default) and the retry wording, plus that a cumulative chart uses the same allowance when it would otherwise have been sampled
f003 missing_coverage on-call `zh en/on-call/incident/search-view-incident.mdx`
f004 missing_coverage monitors `zh en/monitors/quickstart/quickstart.mdx`
f005 missing_coverage derivative `zh en/changelog/changelog.mdx`
— — rum docs.json Registered `zh

Review checklist

  • Verify config field names and defaults match current code
  • Check that feature descriptions accurately reflect user-facing behavior
  • Ensure tone and style match the rest of the docs
  • Reader-fit deletions removed only mechanism, never a limit, default, or behavior the reader relies on

Sources read before writing (all origin/main):
fc-saas-rum pages/Dashboard/components/ChartCard/SamplingMark.tsx, pages/Dashboard/components/TrendChart/{TrendControls,granularity,useTrendSeries}.ts(x), pages/Dashboard/modules/{useDashboardData,useDashboradStore}.ts, pages/Dashboard/locales/{zh_CN,en_US}.json (UI strings reused verbatim in both languages), fc-rum config/config.go, logic/dataquery/limiter.go, cmd/server/controller/data/{types,cache}.go, fc-saas-web pages/Incident/NewDetail/RumIssueInfo.tsx + Overview/RightContainer/index.tsx, monit-webapi types/alert_rule_labels.go, logic/logic_alert_rule_lifecycle_v2.go.

Held

Cross-repo follow-ups (flashduty-website)

None. The window's website changes (flashduty-website e1a5ff6…) are analytics/attribution plumbing (PostHog, entry-referrer, lead form) and the console-link components — no changelog or integrations-catalog gap a docs change would create.

Mapping warnings

  1. fc-event — cmd/engine/controller/notify/ (teams_app.go, teams_inbound.go), logic/onboarding/, cmd/server/controller/onboarding/, structs/ai_sre.go, logic/resource/usage.go, structs/license.go are not mapped. The Teams inbound/AI-SRE ownership change in this window is entirely under cmd/engine/controller/notify/, so a mapping-driven scan misses it. Suggest adding cmd/engine/controller/notify/ to on-call/integration/instant-messaging and structs/ai_sre.go to ai-sre.
  2. fc-foundation-app — the status page console is at src/Packages/saas/pages/StatusPage, but statuspage maps only src/Packages/saas/pages/Dashboard. Also saas/pages/OnboardingOncall, saas/pages/Onboarding, saas/pages/Guide are mapped to no module.
  3. fc-rum — cmd/server/controller/data/ (where this window's sampling / cumulative / time_zone work lives) is not mapped; only logic/ and types/.
  4. flashduty-docs — derivative_surfaces.comparison_page points at zh|en/on-call/quickstart/comparison.mdx, which does not exist (the comparison pages are zh|en/on-call/comparison/vs-pagerduty.mdx and vs-opsgenie.mdx), so that derivative check keeps silently no-op'ing. mcp-server / terraform docs_path are directories (developer/mcp-server/, developer/terraform/) that don't exist; the pages are zh|en/developer/mcp-server.mdx and terraform.mdx.

Skipped

  • Monitors onboarding deeplink now targets docs.flashcat.cloud/zh/monitors/alert-rules (fc-saas-monit pages/onboarding/monitTasks.ts:129, previously …/rule-repository/rule-repository). https://docs.flashduty.com/zh/monitors/alert-rules answers 307 to /zh/monitors/alert-rules/prometheus — not a 404, so nothing to fix here; landing on the Prometheus rule page rather than an overview is a product-side choice.
  • fc-safari benchmark v2 (logic/benchmark/v2, cmd/api/benchmark{,v2}): authenticated with config.C.Benchmark.AccountID, no console entry in any frontend repo (grep benchmark = 0 hits in saas/monit/rum/ai-sre/ai-assistant) → internal eval harness, not a public feature.
  • fc-event license "release limited" removal (structs/license.go, logic/resource/usage.go -141 lines, LicenseReleaseLimitedCount metric dropped): no doc page claims a release quota, so nothing is stale.
  • fc-pgy arrears reminders (logic/charge/arrears.go, reminder emails): internal billing notifications, no user-visible console surface.
  • RUM dashboard internals: preview-column ordering (pages/rule/add/…/preview/previewColumns.ts) and the metric-definition fixes (ANR rate join on ts, crash ranking by view_name, Electron synthetic view excluded from PV/error rate, crash-free - on empty windows) keep the console numbers correct without changing what the docs assert.

Validation

mint broken-links (Node 20.18.0, mint via npm): exit 1 with warnin skipped 36 file(s) that could not be parsed — all 36 are pre-existing parse errors under on-call/integration/alert-integration/alert-sources/, and the log ends with success no broken links found in the files that parsed. comm -12 between this branch's changed files and the 36 skipped files is empty, so every file this PR touches was link-checked. jq empty docs.json passes.

…rend at 3 granularities

- new page zh|en/rum/analytics/chart-readings.mdx (+ docs.json nav): the
  Estimate mark, per-chart Exact query with retry, the per-account exact-query
  allowance, and the trend chart's granularity / cumulative controls
- on-call: the incident detail's new Issue info block for RUM alerts
- monitors: __alert_rule_relate_query_error when a related query fails
- changelog: 2026-10-29 entry for the two RUM dashboard features

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants