gao/ljwx-k8s
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
main
ljwx-k8s/OBSERVABILITY-INDEX.md
T
bruno 2a56d7fd6c first commit
2026-02-20 22:50:45 +08:00

9.2 KiB
Raw Permalink Blame History

可观测性文档索引

快速导航 | 完成报告 | 快速参考 | 配置文档 | 集成指南 | 工具脚本 | 示例代码

📖 文档分类

🎯 完成报告

用于了解项目完成情况和验收标准。

文档 用途 阅读时间
DEPLOYMENT-FINAL-SUMMARY.md ⭐ 最终总结 - 完整的部署交付报告 10 分钟
OBSERVABILITY-P0-COMPLETE.md P0 任务报告 - 详细的任务完成情况和验收清单 15 分钟
DEPLOYMENT-SUCCESS.md 部署成功详情 - 包含所有验证结果 8 分钟

🚀 快速参考

快速上手和日常查阅。

文档 用途 阅读时间
OBSERVABILITY-CHEATSHEET.md ⭐⭐⭐ 快速参考卡 - PromQL、kubectl 命令、故障排查 随时查阅
QUICK-START.md ⭐ 快速开始 - 立即访问 Grafana 和 Dashboard 2 分钟
GRAFANA-REMOTE-ACCESS.md Grafana 远程访问配置（Ingress + hosts） 5 分钟
GRAFANA-DASHBOARDS-ACCESS.md Dashboard 访问和使用指南 10 分钟

⚙️ 配置文档

Prometheus、Grafana、告警规则等配置细节。

配置文件 说明
monitoring/prometheus/prometheus-configmap-data-ns.yaml Prometheus 完整配置（带 scrape_configs）
monitoring/prometheus/prometheus-configmap-no-rules.yaml Prometheus 简化配置（当前使用）
monitoring/prometheus/rules/postgres-alerts.yml PostgreSQL 告警规则 (20+ 条)
monitoring/prometheus/rules/redis-alerts.yml Redis 告警规则 (20+ 条)
monitoring/prometheus/rules/k3s-operational-alerts.yml K8s 运营告警 (30+ 条)
monitoring/grafana/datasources-loki-tempo-enhanced.yaml Grafana 数据源（Loki↔Tempo 关联）
monitoring/grafana/grafana-ingress.yaml Grafana Ingress 配置

📚 集成指南

业务应用如何接入 Metrics + Traces + Logs。

文档 技术栈 内容 阅读时间
docs/observability/business-instrumentation-spring-boot.md ⭐ Spring Boot Micrometer + OTel Java Agent + JDBC/Redis 自动注入 15 分钟
docs/observability/business-instrumentation-python.md ⭐ Python Flask prometheus_client + OTel 自动注入 12 分钟
docs/observability/pg-stat-statements-setup.md PostgreSQL pg_stat_statements 慢查询监控配置 8 分钟

🔧 工具脚本

自动化部署、验收和管理。

脚本 用途 使用场景
verify-p0-complete.sh 完整验收 - 验证所有 P0 任务 部署后验收
enable-prometheus-alerts.sh 启用告警 - 挂载告警规则到 Prometheus 需要告警时
deploy-observability-enhancement.sh 部署增强配置 初始部署
verify-observability-enhanced.sh 验证增强配置 部署后验证
monitoring/grafana/dashboards/import-dashboards.sh 导入 Grafana Dashboard Dashboard 导入

💻 示例代码

完整的业务应用示例（可直接部署）。

示例 说明 技术栈
examples/sample-app-with-observability.yaml 完整可观测性集成示例 Spring Boot + Python Flask

🎯 快速场景导航

场景 1: 我是新手，想快速了解整个项目

  1. 读 DEPLOYMENT-FINAL-SUMMARY.md (10分钟) - 了解完整交付内容
  2. 读 QUICK-START.md (2分钟) - 立即访问 Grafana
  3. 收藏 OBSERVABILITY-CHEATSHEET.md - 日常查阅

场景 2: 我要访问 Grafana 监控

  1. 本地访问: 读 QUICK-START.md → 启动端口转发
  2. 远程访问: 读 GRAFANA-REMOTE-ACCESS.md → 配置 hosts

场景 3: 我要接入业务应用监控

  1. Spring Boot: 读 business-instrumentation-spring-boot.md
  2. Python: 读 business-instrumentation-python.md
  3. 参考示例: 看 sample-app-with-observability.yaml
  4. 查阅命令: 用 OBSERVABILITY-CHEATSHEET.md

场景 4: 我要查询 Prometheus 指标

直接查阅 OBSERVABILITY-CHEATSHEET.md 的 PromQL 章节

场景 5: 我要启用告警

运行 ./enable-prometheus-alerts.sh

场景 6: 我要配置 pg_stat_statements

读 pg-stat-statements-setup.md

场景 7: 我遇到问题需要排查

查阅 OBSERVABILITY-CHEATSHEET.md 的故障排查章节

场景 8: 我要验收部署是否成功

运行 ./verify-p0-complete.sh

📊 文档关系图

DEPLOYMENT-FINAL-SUMMARY.md (最终总结)
    ├── OBSERVABILITY-P0-COMPLETE.md (P0 任务详情)
    ├── QUICK-START.md (快速访问)
    ├── GRAFANA-REMOTE-ACCESS.md (远程配置)
    ├── OBSERVABILITY-CHEATSHEET.md (日常参考)
    │
    ├── 集成指南
    │   ├── business-instrumentation-spring-boot.md
    │   ├── business-instrumentation-python.md
    │   └── pg-stat-statements-setup.md
    │
    ├── 配置文件
    │   ├── prometheus-configmap-*.yaml
    │   ├── prometheus rules/*.yml
    │   └── grafana datasources-*.yaml
    │
    ├── 工具脚本
    │   ├── verify-p0-complete.sh
    │   ├── enable-prometheus-alerts.sh
    │   └── deploy-*.sh
    │
    └── 示例代码
        └── sample-app-with-observability.yaml

🔍 按角色推荐阅读

DevOps / SRE

必读:

  1. DEPLOYMENT-FINAL-SUMMARY.md
  2. OBSERVABILITY-CHEATSHEET.md
  3. GRAFANA-REMOTE-ACCESS.md

可选:

  • enable-prometheus-alerts.sh - 启用告警
  • verify-p0-complete.sh - 验收脚本

后端开发 (Spring Boot)

必读:

  1. QUICK-START.md
  2. business-instrumentation-spring-boot.md

参考:

后端开发 (Python)

必读:

  1. QUICK-START.md
  2. business-instrumentation-python.md

参考:

DBA

必读:

  1. QUICK-START.md - 访问 PostgreSQL Dashboard
  2. pg-stat-statements-setup.md

参考:

项目经理 / 技术负责人

必读:

  1. DEPLOYMENT-FINAL-SUMMARY.md - 了解交付内容
  2. OBSERVABILITY-P0-COMPLETE.md - 了解完成度

⭐ 推荐收藏

最常用的文档（建议收藏浏览器书签）:

  1. OBSERVABILITY-CHEATSHEET.md ⭐⭐⭐

    • 日常工作必备参考

  2. QUICK-START.md ⭐⭐

    • 快速访问 Grafana

  3. 业务集成文档 ⭐⭐

📱 访问地址速查

# Grafana (远程)
http://grafana.omniverseai.net:31080
用户名: admin
密码: admin123

# Grafana Dashboards
PostgreSQL: http://grafana.omniverseai.net:31080/d/000000039/postgresql-database
Redis:      http://grafana.omniverseai.net:31080/d/xDLNRKUWz/4b82829
Kubernetes: http://grafana.omniverseai.net:31080/d/k8s_views_pods/kubernetes-views-pods

# Prometheus (本地端口转发)
kubectl port-forward -n monitoring svc/prometheus 9090:9090
http://localhost:9090

🆘 需要帮助？

  1. 快速问题: 查阅 OBSERVABILITY-CHEATSHEET.md
  2. 配置问题: 查看对应的配置文件文档
  3. 集成问题: 参考业务集成指南
  4. 验收问题: 运行 ./verify-p0-complete.sh

文档索引最后更新: 2025-12-21

Reference in New Issue View Git Blame Copy Permalink