更新日志架构监控架构文档相关问题

[leizhuc]

Summary by CodeRabbit

• Documentation
  • Updated Log Component Selection Guide terminology and clarified status notes; tightened formatting.
  • Revised Log installation guide: added ClickHouse operator prerequisite and comprehensive installation planning (deployment placement, centralization, network-zone instances, dedicated nodes, SSDs); removed outdated cross-cluster/port guidance.
  • Prometheus capacity planning: removed Thanos Sidecar rows across all scales.
  • Architecture component selection: removed inline Prometheus and VictoriaMetrics architecture diagrams; retained other content unchanged.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updates across log and monitoring sections: revised terminology and warnings, added installation planning and ClickHouse operator prerequisite, removed specific capacity rows for Thanos Sidecar, and deleted two architecture flow images. Minor formatting/tidying adjustments in several pages.

Changes

Cohort / File(s)	Summary of changes
Log docs — terminology, warnings, formatting docs/en/observability/log/architecture/component_suggestion.mdx	Updated intro phrasing (“log component”), reworded three warning/status notes to “Now …” forms, removed extra blank lines under architecture images; no content changes elsewhere.
Log installation — prerequisites and planning docs/en/observability/log/install_log.mdx	Replaced prior storage/port warning with new requirements and “Installation Planning”; added prerequisite to upload ClickHouse operator before installing ClickHouse plugin; guidance on deployment location, centralization, zones, dedicated nodes, SSDs.
Monitor capacity planning — Thanos Sidecar removal docs/en/observability/monitor/architecture/capacity_planning.mdx	Removed Thanos Sidecar rows from Small, Medium, Large Prometheus capacity tables; no replacements added.
Monitor component selection — image removals docs/en/observability/monitor/architecture/component_selection_suggestion.mdx	Deleted two inline architecture flow images (Prometheus, VictoriaMetrics) and adjacent blank lines; other content unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• 更新插件安装文档 #146 — Also updates docs/en/observability/log/install_log.mdx with overlapping installation guidance and prerequisites.
• fix: upgrade-doc #56 — Related to ClickHouse log storage plugin install/upgrade documentation changes.

Suggested reviewers

• fanzy618
• chinameok

Poem

A nibble of notes in the docs I hop,
Tidying trails where the log bits drop.
Sidecars vanish, diagrams thin—
ClickHouse queued, let install begin.
On SSD fields I thump with cheer,
Monitoring clear, the signals near. 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3981aa2 and 66e0d31.

📒 Files selected for processing (4)

• docs/en/observability/log/architecture/component_suggestion.mdx (1 hunks)
• docs/en/observability/log/install_log.mdx (1 hunks)
• docs/en/observability/monitor/architecture/capacity_planning.mdx (0 hunks)
• docs/en/observability/monitor/architecture/component_selection_suggestion.mdx (0 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch leizhu/fix_arti

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}