跳至主要內容
hs-sql-agent
2.0.3
文件 2.0.3
文件 維運

可觀測性與稽核維運

設定健康檢查、慢查詢門檻、Prometheus、OTLP、稽核資料保留,以及帶簽章的外送通知。

hs-sql-agent 將執行階段的可觀測性與 SQL 控制機制分開。正式環境可以搭配健康檢查、指標、遙測匯出、稽核資料保留,以及告警或 SIEM 外送,不必把資料庫中的稽核資料表當成唯一的維運訊號。

健康檢查與慢查詢監控

範例環境設定提供:

HEALTH_PROBE_ENABLED
HEALTH_PROBE_INTERVAL_SECONDS
HEALTH_PROBE_TIMEOUT_SECONDS
HEALTH_PROBE_MAX_CONCURRENCY
SLOW_QUERY_THRESHOLD_MS

健康探測為選配;SLOW_QUERY_THRESHOLD_MS 則用來定義查詢超過多久後要視為慢查詢並納入監控。

Prometheus 與 OTLP

Prometheus 使用與應用程式 API 分離的監聽端點

PROMETHEUS_ENABLED=false
PROMETHEUS_HOST=0.0.0.0
PROMETHEUS_PORT=9000

也可以選擇匯出 OpenTelemetry:

OTLP_ENDPOINT=
OTEL_SERVICE_NAME=hs-sql-agent

Prometheus 適合由監控系統定期抓取(scrape)指標;如果部署架構中已有 OpenTelemetry Collector,則可透過 OTLP 匯出遙測資料。

告警與 SIEM 外送

伺服器可設定帶簽章的外送目標:

ALERT_WEBHOOK_URL=
ALERT_WEBHOOK_SECRET=
SIEM_WEBHOOK_URL=
SIEM_WEBHOOK_SECRET=
DELIVERY_MAX_ATTEMPTS=6
DELIVERY_MAX_CONCURRENCY=4

目標 URL 留空即可停用該整合。簽章密鑰應和其他部署憑證一樣妥善保存,並確保持久化。

稽核資料保留

資料保留與即時請求處理分開控制。AUDIT_RETENTION_DAYS=0 會停用自動保留處理。目前服務支援 ArchivePurgeArchive 會先把過期紀錄寫入設定的封存路徑,再從線上紀錄中刪除。

相關設定:

AUDIT_RETENTION_DAYS
AUDIT_RETENTION_MODE
AUDIT_ARCHIVE_PATH
AUDIT_FALLBACK_PATH
AUDIT_RETENTION_RUN_HOUR_UTC

備援路徑是處理維運失敗情境的重要保護。若部署流程依賴封存或備援的稽核輸出,對應儲存空間必須具備持久性。