DiagramPreview
AI BetaAIYAMLExport

可观测性套件生成器

可观测性套件生成器：用于开发者文档的在线预览、校验和导出工具。

示例
预览
生成结果会显示在这里。

下一步可以继续

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

AI 图表生成器

用自然语言生成可编辑 Mermaid 图表，并在导出前完成预览和 review。

打开
Mermaid AI 修复器

用 AI 修复 Mermaid 语法错误，并在发布前检查图表语义和可读性。

打开
架构图生成器

用 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 图表生成器

用自然语言生成可编辑 Mermaid 图表，并在导出前完成预览和 review。

Mermaid AI 修复器

用 AI 修复 Mermaid 语法错误，并在发布前检查图表语义和可读性。

架构图生成器

用 AI 从产品或系统说明生成 Mermaid 架构图。

常见问题

可以配合 AI 生成内容使用吗？

可以。先用 AI 生成初稿，再在这里预览、检查和调整，最后放进文档。

这个工具适合开发者文档、架构说明、运维 runbook、API 规范和 AI 生成图表后的检查流程。

可以从示例开始，替换成自己的源码，并把输出结果和原始文本放在一起，方便后续评审和修改。

正式发布时优先导出 SVG 或 PNG，同时把源文本保留在仓库中，避免图表变成难维护的截图。

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 辅助生成。