DiagramPreview
AI BetaAIYAMLExport

可觀測性套件產生器

可觀測性套件產生器:用於開發者文件的線上預覽、校驗與匯出工具。

範例
預覽
產生結果會顯示在這裡。

下一步可以继续

把生成结果带到相关工具里继续预览、转换或排查。

設計規範產生器

產生 Markdown 設計規範、檢查交接缺漏,並以流程圖補充說明。

打开
AI 圖表生成器

用自然語言提示詞生成 Mermaid 圖表。

打开
Mermaid AI 修復器

用 AI 修復 Mermaid 語法並提升圖表可讀性。

打开

使用方法

  1. 1範例: choose a starter example or paste your own source.
  2. 2Review the generated preview and adjust labels, conditions, or configuration details.
  3. 3Copy the source or export the rendered result when it is ready for documentation.

常見場景

README and engineering design docsArchitecture reviews and API documentationAI-generated diagram validation before publishing

常見問題

可以搭配 AI 產生內容使用嗎?

可以。先用 AI 產生初稿,再在這裡預覽、檢查並調整,最後放入文件。

這個工具適合開發者文件、架構說明、維運 runbook、API 規格與 AI 產生圖表後的檢查流程。

可以從範例開始,替換成自己的來源,並把輸出結果和原始文字放在一起,方便後續審查與修改。

正式發布時優先匯出 SVG 或 PNG,同時把來源文字保留在 repository 中,避免圖表變成難維護的截圖。

Demo:生成可观测性 starter pack

看板、告警、架构上下文和 runbook 针对同一个服务生成时最有价值。

  • 先用一个小而完整的示例确认结构,再粘贴完整生产内容。
  • 检查预览是否清楚展示 ownership、结构、标签和风险字段。
  • 保留源码和导出结果,方便后续 reviewer 复现。
Service: checkout-api
Metrics: Prometheus
Logs: Loki
SLO: 99.9% successful checkout requests

可觀測性套件產生器 Review 清单

生成结果先放测试目录,datasource、阈值、labels、severity 都要调。

  • 分享示例前移除 secret、token、客户数据和私有基础设施值。
  • 每次修改输入后,都把渲染结果和原始源码对照。
  • 当预览简化复杂运行时行为时,应把假设写出来。
输入 -> 预览 -> 检查风险字段 -> 修改源码 -> 导出或分享

可觀測性套件產生器 檢查清單

當你需要在文件、PR、事故復盤或交接材料發布前檢查原始內容時,可以使用 可觀測性套件產生器。可觀測性套件產生器:用於開發者文件的線上預覽、校驗與匯出工具。

匯出前建議檢查標籤是否可讀、關係是否和原始內容一致、範例是否包含敏感資訊,以及修改輸入後預覽是否仍然成立。

限制與排查

如果預覽失敗,先把輸入縮小到最小完整範例,確認格式語法,再逐段加回內容。

請把預覽結果視為 review 介面,而不是正式事實來源。進入文件或維運流程前仍需要人工確認。

可測試的範例輸入

  • API service: Generate an observability pack for a checkout API with p95 latency, error rate, saturation, Redis dependency, and payment provider failures.
  • Kubernetes app: Create an observability pack for a Kubernetes web app with ingress, deployment replicas, pod restarts, CPU, memory, logs, and SLO burn alerts.
  • Queue worker: Generate dashboards and alerts for an order worker that consumes Kafka, writes PostgreSQL, and must monitor lag, retries, dead letters, and processing time.

工具完成度

AI Beta

AI 輔助 Beta

此工具會呼叫 AI 產生可編輯原始碼。建議先本機預覽,再調整細節,最後再用於文件或工程流程。

分級不是品質分數,而是說明目前工具更適合穩定匯出、深度除錯、快速解析,或 AI 輔助生成。