审计发现 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 通过
81 lines
2.8 KiB
Go
81 lines
2.8 KiB
Go
package models
|
||
|
||
import "time"
|
||
|
||
// AuditLog 操作审计日志。
|
||
//
|
||
// 设计参考 /usr/local/src/aiops 的 audit_operation_logs(字段口径一致,
|
||
// 便于两套运维工具链用同一套查询习惯与看板),差异有两点:
|
||
//
|
||
// 1. 多了 Method / Path / Before / After —— aiops 用 gorm 表,LokiStack 用 JSON 文件,
|
||
// 没法靠 SQL 关联,所以把"改了什么"直接落到行上,查询时不用再回表。
|
||
// 2. 不做 Response 全量落盘(Loki 日志响应动辄几百 KB,会撑爆 JSON DB),
|
||
// 只留 Detail 摘要 + 结构化 diff。
|
||
//
|
||
// 敏感字段(password / secretKey / privateKey / token)在写入前统一脱敏,
|
||
// 见 middleware.MaskAuditPayload。
|
||
type AuditLog struct {
|
||
ID uint `json:"id"`
|
||
UserID uint `json:"userId"`
|
||
Username string `json:"username"`
|
||
Role string `json:"role,omitempty"`
|
||
IP string `json:"ip"`
|
||
// UserAgent 截断到 200 字符,避免个别客户端把 DB 撑大
|
||
UserAgent string `json:"userAgent,omitempty"`
|
||
|
||
// Module 业务模块:deployment / collector / storage / host / cluster / user / policy / alert / system / auth
|
||
Module string `json:"module"`
|
||
// Action 动作:create / update / delete / deploy / install / uninstall / login / logout / test / reset
|
||
Action string `json:"action"`
|
||
// Resource 资源类型(中文可读名,如「部署」「采集器」)
|
||
Resource string `json:"resource"`
|
||
// ResourceID 资源 ID 或名称
|
||
ResourceID string `json:"resourceId,omitempty"`
|
||
|
||
Method string `json:"method"`
|
||
Path string `json:"path"`
|
||
Status int `json:"status"`
|
||
// DurationMs 处理耗时(毫秒)
|
||
DurationMs int64 `json:"durationMs"`
|
||
|
||
// Detail 人类可读的一句话说明(如「修改保留天数 7 → 3」)
|
||
Detail string `json:"detail,omitempty"`
|
||
// Before / After 变更前后摘要(仅记录变更字段,已脱敏)
|
||
Before string `json:"before,omitempty"`
|
||
After string `json:"after,omitempty"`
|
||
// Error 失败原因(status >= 400 时填)
|
||
Error string `json:"error,omitempty"`
|
||
|
||
CreatedAt time.Time `json:"createdAt"`
|
||
}
|
||
|
||
// AuditQuery 审计日志查询条件
|
||
type AuditQuery struct {
|
||
Username string
|
||
Module string
|
||
Action string
|
||
ResourceID string
|
||
// Status 0 = 全部;1 = 仅成功(2xx);2 = 仅失败(>=400)
|
||
Status int
|
||
StartTime *time.Time
|
||
EndTime *time.Time
|
||
Page int
|
||
PageSize int
|
||
}
|
||
|
||
// AuditStats 审计统计(给审计页面顶部卡片用)
|
||
type AuditStats struct {
|
||
TodayCount int64 `json:"todayCount"`
|
||
WeekCount int64 `json:"weekCount"`
|
||
FailCount int64 `json:"failCount"`
|
||
TotalCount int64 `json:"totalCount"`
|
||
TopModules []AuditCount `json:"topModules"`
|
||
TopUsers []AuditCount `json:"topUsers"`
|
||
}
|
||
|
||
// AuditCount 分组计数
|
||
type AuditCount struct {
|
||
Name string `json:"name"`
|
||
Count int64 `json:"count"`
|
||
}
|