opsx
b49677f6a6
审计发现 5 处硬伤（/metrics 空壳、零备份、prod 双副本数据分裂、零审计、资源偏紧），
本轮全部落地。
=== P0-1 真实 /metrics（原来是空壳）===
原实现只返回一行注释 `# LokiStack Metrics`，注释却写着"可被 Prometheus 抓取"，
平台挂了/DB 写不进去/告警引擎卡死都只能靠用户反馈。
现接入 prometheus/client_golang，四层指标：
HTTP : lokistack_http_requests_total / _duration_seconds / _in_flight_requests
存储 : lokistack_db_size_bytes / _db_save_duration_seconds / _db_save_total / _db_records
业务 : lokistack_deployments{status,mode} / lokistack_collectors{status,type,run_mode}
后台任务: lokistack_alert_evaluations_total / _duration_seconds / lokistack_loki_queries_total
+ go_* / process_*（GoCollector、ProcessCollector）
关键点：path 标签用 c.FullPath() 路由模板，不用原始 URL —— 否则 117 个 Deployment
会把 Prometheus 基数炸掉。指标定义下沉 pkg/metrics 叶子包，避开
services ↔ repository 循环依赖。
=== P0-2 备份与恢复（原来 0 处代码）===
平台全部状态在 /app/data/opsxloki.json（51KB）+ kubeconfigs/ + known_hosts/，
DB 丢了 = 失去"这些资源是谁建的"的映射，从此无法管理/卸载/升级在跑的 Loki。
CLI : lokistack backup --output <path> / restore <pkg> / self-check / version
API : GET /system/backup（下载）/ POST /system/restore（校验暂存）/
POST /system/restore/apply（确认应用）/ GET /system/backups
K8s : kubernetes/pdb-backup.yaml —— 每日 03:30 CronJob，保留最近 7 份
安全设计：
- manifest.json 记录 ENCRYPTION_KEY 的 sha256 前 16 位**指纹**，用于恢复时
校验"这把钥匙能不能解开这份备份"，不泄露密钥本身
- 恢复分两步（校验暂存 → 确认应用），应用前自动把当前 DB 备份为
opsxloki.json.before-restore.<时间戳>
- 包内不含明文密钥（kubeconfig 本就是加密态）
=== P0-3 prod compose 双副本 → 单副本 ===
lokistack-1 / lokistack-2 各挂独立数据卷 + nginx 轮询 = 数据分裂：
页面刷新两次可能看到不同结果，写操作只落一个副本。不是高可用。
已改单实例（nginx 仅做反代），文件顶部与 nginx.conf 都写明原因。
=== P0-4 操作审计日志（借鉴 /usr/local/src/aiops 的字段口径）===
aiops 是每个 controller 各写 recordXxxAudit()；本平台有 60+ 写接口，
逐个埋点必然漏，漏掉的那个恰好最危险（删集群、改存储凭证）。
改为 **gin 中间件统一记录** + handler 通过 SetAudit 补充业务语义：
models/audit.go : 字段对齐 aiops，另加 Method/Path/Before/After
services/audit.go : 写入 + 90 天/2 万条自动裁剪 + 脱敏 + diff 生成
middleware/audit.go : 自动识别 module/action/resource，跳过只读接口
controllers/audit.go: 列表/详情/统计（仅 admin）
敏感字段（password/secretKey/privateKey/token）写入前统一替换为 ***。
=== P1 稳定性 ===
- 平台资源 1C/1Gi → 4C/4Gi 限（500m/512Mi 请求）：JSON DB 全量读写 +
每分钟告警评估 + 批量发布并发，1Gi 会 OOM
- terminationGracePeriodSeconds: 30 —— 收到 SIGTERM 要等 DB 完整落盘，
否则 kubelet SIGKILL 会把 JSON 写一半（全库丢失）
- liveness timeoutSeconds 10s（默认 1s 写盘时会被误杀）
- PDB minAvailable: 0 —— 让 kubectl drain 正确等待重建，不卡维护
- DB schemaVersion + migrateSchema() 版本递进迁移（原先加字段全靠零值兜底）
- scripts/release.sh —— 不可变 tag <版本>-<日期>-<commit> + IfNotPresent，
根治 latest 并发构建互相覆盖导致的静默回滚（本项目已实际踩过）
- PVC 保持 30Gi（按长期增长预留，云盘单价低，不做在线扩容）
=== P2 易用性 ===
- 一键自检 GET /system/self-check + 仪表盘自检卡：真实探活 Loki /ready、
集群凭据解密、磁盘空间、主机状态、近 24h 失败操作
- 审计日志页 /audit：统计卡 + 用户名/模块/结果筛选 + 变更前后 diff 弹窗
- 菜单收敛 13 → 7（页内 tab 切换，URL 全部不变）：
资源接入 = 集群 + 主机 + 存储
日志服务 = Loki 实例 + 采集器
日志 = 查询 + 分析
系统管理 = 用户 + 审计 + 设置
新增 GroupTabs 组件 + meta.group/groupKey，侧栏按分组去重并正确高亮
测试：go vet 通过、go test 全绿、tsc 通过
281 lines
11 KiB
Go
281 lines
11 KiB
Go
package routers
|
||
|
||
import (
|
||
"net/http"
|
||
"os"
|
||
"path/filepath"
|
||
"strings"
|
||
"time"
|
||
|
||
"lokistack/controllers"
|
||
"lokistack/middleware"
|
||
"lokistack/pkg/metrics"
|
||
|
||
"github.com/gin-contrib/cors"
|
||
"github.com/gin-gonic/gin"
|
||
)
|
||
|
||
func SetupRouter() *gin.Engine {
|
||
// 用 gin.New() 而不是 gin.Default()：Default 自带文本格式的 gin.Logger()，
|
||
// 这里换成结构化 JSON 访问日志（middleware.AccessLog），便于 Promtail→Loki
|
||
// 按字段过滤，同时跳过健康检查/静态资源，避免探针轮询把日志量刷满。
|
||
// Recovery 必须显式加回来（Default 里包含它），否则 panic 会打挂进程。
|
||
r := gin.New()
|
||
// AuditLog 放在最外层：它依赖的 userId/username 由 group 内的 JWTAuth 写入，
|
||
// 但中间件的后置逻辑在 c.Next() 返回后才执行，那时已就绪（见 middleware/audit.go）。
|
||
r.Use(middleware.AccessLog(), middleware.AuditLog(), middleware.Metrics(), gin.Recovery())
|
||
|
||
// CORS
|
||
cfg := cors.DefaultConfig()
|
||
cfg.AllowAllOrigins = true
|
||
cfg.AllowHeaders = []string{"Origin", "Content-Type", "Accept", "Authorization", "X-Requested-With"}
|
||
cfg.AllowMethods = []string{"GET", "POST", "PUT", "DELETE", "OPTIONS", "PATCH"}
|
||
r.Use(cors.New(cfg))
|
||
|
||
// Controllers
|
||
authCtrl := controllers.NewAuthController()
|
||
clusterCtrl := controllers.NewClusterController()
|
||
hostCtrl := controllers.NewHostController()
|
||
storageCtrl := controllers.NewStorageController()
|
||
deploymentCtrl := controllers.NewDeploymentController()
|
||
collectorCtrl := controllers.NewCollectorController()
|
||
userCtrl := controllers.NewUserController()
|
||
ldapCtrl := controllers.NewLdapController()
|
||
logsCtrl := controllers.NewLogsController()
|
||
alertsCtrl := controllers.NewAlertsController()
|
||
auditCtrl := controllers.NewAuditController()
|
||
systemCtrl := controllers.NewSystemController()
|
||
registryCtrl := controllers.NewImageRegistryController()
|
||
|
||
// API v1
|
||
api := r.Group("/api/v1")
|
||
|
||
// 健康检查（公开访问，用于负载均衡和监控）
|
||
api.GET("/health", func(c *gin.Context) {
|
||
c.JSON(http.StatusOK, gin.H{
|
||
"status": "ok",
|
||
"timestamp": time.Now().Unix(),
|
||
"version": "2.0.0",
|
||
})
|
||
})
|
||
|
||
// Prometheus metrics 端点（真实指标，见 services/metrics.go）
|
||
// 原实现只返回一行注释却声称"可被 Prometheus 抓取"，平台自身等于不可观测。
|
||
api.GET("/metrics", gin.WrapH(metrics.Handler()))
|
||
|
||
// Public（登录接口挂 IP 限流防爆破：20 次/分钟）
|
||
api.POST("/auth/login", middleware.LoginRateLimit(20, time.Minute), authCtrl.Login)
|
||
api.POST("/auth/refresh", authCtrl.RefreshToken)
|
||
|
||
// Auth required
|
||
authorized := api.Group("")
|
||
authorized.Use(middleware.JWTAuth())
|
||
|
||
// Auth routes
|
||
authorized.GET("/auth/user", authCtrl.GetUser)
|
||
authorized.POST("/auth/password", authCtrl.ChangePassword)
|
||
|
||
// 日志查询:数据源管理 + Loki 代理查询
|
||
logs := authorized.Group("/logs")
|
||
{
|
||
logs.GET("/sources", logsCtrl.ListSources)
|
||
logs.POST("/sources", middleware.AdminAuth(), logsCtrl.CreateSource)
|
||
logs.PUT("/sources/:id", middleware.AdminAuth(), logsCtrl.UpdateSource)
|
||
logs.DELETE("/sources/:id", middleware.AdminAuth(), logsCtrl.DeleteSource)
|
||
logs.POST("/sources/test", middleware.AdminAuth(), logsCtrl.TestSource)
|
||
logs.GET("/policy-groups", middleware.AdminAuth(), logsCtrl.ListPolicyGroups)
|
||
logs.POST("/policy-groups", middleware.AdminAuth(), logsCtrl.CreatePolicyGroup)
|
||
logs.PUT("/policy-groups/:id", middleware.AdminAuth(), logsCtrl.UpdatePolicyGroup)
|
||
logs.DELETE("/policy-groups/:id", middleware.AdminAuth(), logsCtrl.DeletePolicyGroup)
|
||
logs.POST("/query", logsCtrl.Query)
|
||
logs.POST("/context", logsCtrl.Context)
|
||
logs.GET("/labels", logsCtrl.Labels)
|
||
logs.GET("/label/:name/values", logsCtrl.LabelValues)
|
||
logs.GET("/my-scope", logsCtrl.MyScope)
|
||
logs.POST("/histogram", logsCtrl.Histogram)
|
||
// 总量统计（index/stats）：只读索引，用于算总页数
|
||
logs.POST("/stats", logsCtrl.Stats)
|
||
logs.POST("/metrics", middleware.AdminAuth(), logsCtrl.Metrics)
|
||
logs.GET("/health", logsCtrl.Health)
|
||
}
|
||
|
||
// 镜像源(国内加速/海外/私有仓库)
|
||
authorized.GET("/settings/image-registry", registryCtrl.Get)
|
||
authorized.PUT("/settings/image-registry", middleware.AdminAuth(), registryCtrl.Save)
|
||
|
||
// 告警:飞书通知配置 + 告警规则
|
||
alertNotify := authorized.Group("/alerts")
|
||
{
|
||
alertNotify.GET("/notify-config", alertsCtrl.GetNotifyConfig)
|
||
alertNotify.PUT("/notify-config", middleware.AdminAuth(), alertsCtrl.UpdateNotifyConfig)
|
||
alertNotify.POST("/notify-config/test", middleware.AdminAuth(), alertsCtrl.TestNotifyConfig)
|
||
alertNotify.GET("/rules", alertsCtrl.ListRules)
|
||
alertNotify.POST("/rules", middleware.AdminAuth(), alertsCtrl.CreateRule)
|
||
alertNotify.PUT("/rules/:id", middleware.AdminAuth(), alertsCtrl.UpdateRule)
|
||
alertNotify.DELETE("/rules/:id", middleware.AdminAuth(), alertsCtrl.DeleteRule)
|
||
alertNotify.POST("/check", middleware.AdminAuth(), alertsCtrl.CheckNow)
|
||
alertNotify.GET("/deliveries", alertsCtrl.Deliveries)
|
||
alertNotify.GET("/channels", alertsCtrl.ListChannels)
|
||
alertNotify.POST("/channels", middleware.AdminAuth(), alertsCtrl.SaveChannel)
|
||
alertNotify.PUT("/channels/:id", middleware.AdminAuth(), alertsCtrl.SaveChannel)
|
||
alertNotify.DELETE("/channels/:id", middleware.AdminAuth(), alertsCtrl.DeleteChannel)
|
||
alertNotify.POST("/channels/test", middleware.AdminAuth(), alertsCtrl.TestChannel)
|
||
}
|
||
|
||
// LDAP 配置(admin 读写;查询供用户页判断导入按钮显隐,登录用户即可读)
|
||
authorized.GET("/settings/ldap", middleware.AdminAuth(), ldapCtrl.GetConfig)
|
||
authorized.PUT("/settings/ldap", middleware.AdminAuth(), ldapCtrl.UpdateConfig)
|
||
authorized.POST("/settings/ldap/test", middleware.AdminAuth(), ldapCtrl.TestConnection)
|
||
authorized.POST("/settings/ldap/users", middleware.AdminAuth(), ldapCtrl.ListUsers)
|
||
|
||
// Users（admin 专用）
|
||
// 系统运维：备份 / 恢复 / 一键自检（仅管理员）
|
||
system := authorized.Group("/system")
|
||
system.Use(middleware.AdminAuth())
|
||
{
|
||
system.GET("/backup", systemCtrl.Backup)
|
||
system.POST("/restore", systemCtrl.Restore)
|
||
system.POST("/restore/apply", systemCtrl.RestoreApply)
|
||
system.GET("/backups", systemCtrl.Backups)
|
||
system.GET("/self-check", systemCtrl.Health)
|
||
}
|
||
|
||
// 审计日志：仅管理员可查（含他人操作记录）
|
||
audit := authorized.Group("/audit-logs")
|
||
audit.Use(middleware.AdminAuth())
|
||
{
|
||
audit.GET("", auditCtrl.List)
|
||
audit.GET("/stats", auditCtrl.Stats)
|
||
audit.GET("/:id", auditCtrl.Get)
|
||
}
|
||
|
||
users := authorized.Group("/users")
|
||
users.Use(middleware.AdminAuth())
|
||
{
|
||
users.GET("", userCtrl.List)
|
||
users.POST("", userCtrl.Create)
|
||
users.DELETE("/:id", userCtrl.Delete)
|
||
users.POST("/batch-delete", userCtrl.BatchDelete)
|
||
users.POST("/:id/reset-password", userCtrl.ResetPassword)
|
||
users.POST("/batch-import-ldap", userCtrl.BatchImportLDAP)
|
||
}
|
||
// 普通用户仅可访问日志查询及自己的账号接口；管理资源统一在服务端保护。
|
||
authorized.Use(middleware.AdminAuth())
|
||
|
||
// Clusters
|
||
authorized.GET("/clusters", clusterCtrl.List)
|
||
authorized.GET("/clusters/:id", clusterCtrl.Get)
|
||
authorized.POST("/clusters", clusterCtrl.Create)
|
||
authorized.PUT("/clusters/:id", clusterCtrl.Update)
|
||
authorized.DELETE("/clusters/:id", clusterCtrl.Delete)
|
||
authorized.POST("/clusters/:id/validate", clusterCtrl.Validate)
|
||
authorized.GET("/clusters/:id/info", clusterCtrl.GetInfo)
|
||
authorized.GET("/clusters/:id/namespaces", clusterCtrl.Namespaces)
|
||
authorized.GET("/clusters/:id/namespaces/:namespace/deployments", clusterCtrl.Deployments)
|
||
|
||
// Hosts
|
||
authorized.GET("/hosts", hostCtrl.List)
|
||
authorized.GET("/hosts/:id", hostCtrl.Get)
|
||
authorized.POST("/hosts", hostCtrl.Create)
|
||
authorized.PUT("/hosts/:id", hostCtrl.Update)
|
||
authorized.DELETE("/hosts/:id", hostCtrl.Delete)
|
||
authorized.POST("/hosts/:id/validate", hostCtrl.Validate)
|
||
authorized.GET("/hosts/:id/info", hostCtrl.GetInfo)
|
||
|
||
// Storage
|
||
authorized.GET("/storages", storageCtrl.List)
|
||
authorized.GET("/storages/:id", storageCtrl.Get)
|
||
authorized.POST("/storages", storageCtrl.Create)
|
||
authorized.POST("/storages/test", storageCtrl.TestConnection)
|
||
authorized.PUT("/storages/:id", storageCtrl.Update)
|
||
authorized.DELETE("/storages/:id", storageCtrl.Delete)
|
||
authorized.GET("/storages/default", storageCtrl.GetDefault)
|
||
|
||
// Deployments
|
||
authorized.GET("/deployments", deploymentCtrl.List)
|
||
authorized.GET("/deployments/:id", deploymentCtrl.Get)
|
||
authorized.POST("/deployments", deploymentCtrl.Create)
|
||
authorized.PUT("/deployments/:id", deploymentCtrl.Update)
|
||
authorized.POST("/deployments/:id/retention", deploymentCtrl.UpdateRetention)
|
||
authorized.GET("/deployments/:id/config", middleware.AdminAuth(), deploymentCtrl.GetLiveConfig)
|
||
authorized.DELETE("/deployments/:id", deploymentCtrl.Delete)
|
||
authorized.POST("/deployments/:id/deploy", deploymentCtrl.Deploy)
|
||
authorized.POST("/deployments/:id/stop", deploymentCtrl.Stop)
|
||
authorized.POST("/deployments/:id/restart", deploymentCtrl.Restart)
|
||
authorized.GET("/deployments/:id/logs", deploymentCtrl.GetLogs)
|
||
// 资源用量（CPU/内存/限流），页面用来判断是否要扩容
|
||
authorized.GET("/deployments/:id/usage", deploymentCtrl.GetUsage)
|
||
authorized.GET("/deployments/stats", deploymentCtrl.GetStats)
|
||
authorized.GET("/deployments/preflight", deploymentCtrl.Preflight)
|
||
authorized.GET("/deployments/:id/ready", deploymentCtrl.Ready)
|
||
authorized.GET("/deployments/versions", deploymentCtrl.GetVersions)
|
||
|
||
// Collectors
|
||
authorized.GET("/collectors", collectorCtrl.List)
|
||
authorized.GET("/collectors/:id", collectorCtrl.Get)
|
||
authorized.POST("/collectors", collectorCtrl.Create)
|
||
authorized.PUT("/collectors/:id", collectorCtrl.Update)
|
||
authorized.DELETE("/collectors/:id", collectorCtrl.Delete)
|
||
authorized.POST("/collectors/:id/install", collectorCtrl.Install)
|
||
authorized.POST("/collectors/:id/uninstall", collectorCtrl.Uninstall)
|
||
authorized.POST("/collectors/:id/preview", collectorCtrl.Preview)
|
||
authorized.GET("/collectors/:id/logs", collectorCtrl.Logs)
|
||
|
||
// Static files - use executable directory as base
|
||
distPath := findDistPath()
|
||
|
||
if distPath != "" {
|
||
r.Static("/assets", filepath.Join(distPath, "assets"))
|
||
|
||
// favicon：NoRoute 会把所有非 /api/ 请求回退到 index.html，
|
||
// 故此处显式注册 /favicon.svg 与 /favicon.ico，否则浏览器请求图标只会拿到 HTML。
|
||
faviconSVG := filepath.Join(distPath, "favicon.svg")
|
||
serveFavicon := func(c *gin.Context) {
|
||
if _, err := os.Stat(faviconSVG); err != nil {
|
||
c.Status(404)
|
||
return
|
||
}
|
||
c.Header("Content-Type", "image/svg+xml")
|
||
c.File(faviconSVG)
|
||
}
|
||
r.GET("/favicon.svg", serveFavicon)
|
||
r.GET("/favicon.ico", serveFavicon)
|
||
|
||
r.NoRoute(func(c *gin.Context) {
|
||
if strings.HasPrefix(c.Request.URL.Path, "/api/") {
|
||
c.JSON(404, gin.H{"code": 404, "message": "API endpoint not found"})
|
||
return
|
||
}
|
||
c.File(filepath.Join(distPath, "index.html"))
|
||
})
|
||
}
|
||
|
||
return r
|
||
}
|
||
|
||
// findDistPath finds the frontend dist directory
|
||
func findDistPath() string {
|
||
// Try relative to executable
|
||
if ex, err := os.Executable(); err == nil {
|
||
execDir := filepath.Dir(ex)
|
||
// If running via "go run", executable is in temp dir - fall through
|
||
if !strings.Contains(execDir, "/tmp/go-build") {
|
||
for _, rel := range []string{"dist", "../dist", "../../dist"} {
|
||
p := filepath.Join(execDir, rel)
|
||
if _, err := os.Stat(filepath.Join(p, "index.html")); err == nil {
|
||
return p
|
||
}
|
||
}
|
||
}
|
||
}
|
||
// Try working directory relative paths
|
||
for _, p := range []string{"./dist", "../dist", "/app/dist"} {
|
||
if abs, err := filepath.Abs(p); err == nil {
|
||
if _, err := os.Stat(filepath.Join(abs, "index.html")); err == nil {
|
||
return abs
|
||
}
|
||
}
|
||
}
|
||
return ""
|
||
}
|