概述健康檢查指標與監控警報設定請求日誌分散式追蹤 SLA監控儀表板監控工具最佳實踐

API文檔

API監控、指標與健康檢查

透過全面的健康檢查、效能指標與警報機制監控Smart Money API。追蹤運行時間、延遲、錯誤率及SLA合規性。

發佈於2026年3月21日 • 13分鐘閱讀 • 運維

監控概述

Smart Money API提供全面的監控功能，可追蹤服務健康狀態、效能與可靠性。實施這些監控策略以早期發現問題並維持高運行時間。

三層監控架構：

健康檢查 — 端點可用性與基本功能
指標 — 效能數據（延遲、吞吐量、錯誤率）
日誌 — 用於除錯與稽核的請求/回應詳細資訊

目標指標： 99.9%運行時間、<100ms p95延遲、<0.1%錯誤率、<5秒平均問題檢測時間。

健康檢查

API健康端點

健康檢查
// 簡易存活檢查（無需驗證）
GET /health
// 回應
HTTP/1.1 200 OK
{
 "status": "healthy",
 "timestamp": 1709980800000,
 "uptime": 99.95
}

詳細健康狀態

詳細健康檢查
// 包含元件健康狀態的詳細報告
GET /v1/status
  -H "Authorization: Bearer token"
{
 "status": "operational",
 "components": {
 "api": "healthy",
 "database": "healthy",
 "cache": "healthy",
 "exchanges": "healthy"
  },
 "metrics": {
 "p95_latency_ms": 85,
 "error_rate": 0.0012,
 "uptime_percent": 99.95
  }
}

30秒取得API金鑰

準備開發？立即獲取免費API金鑰（每日100次呼叫，免綁卡），開始提取實時巨鯨數據、資金費率與鏈上數據。

取得API金鑰 →

指標與監控

關鍵追蹤指標

指標	目標值	警報閾值
運行時間	99.9%	<99.5%
P95延遲	<100ms	>500ms
錯誤率	<0.1%	>1%
請求數/秒	依情況調整	接近限額
快取命中率	>70%	<50%

指標API端點

指標查詢
// 獲取監控用API指標
GET /v1/metrics?period=1h
  -H "Authorization: Bearer token"
// 返回Prometheus格式指標
# HELP api_requests_total API請求總數
# TYPE api_requests_total counter
api_requests_total{method="GET",status="200"} 4502
api_requests_total{method="GET",status="429"} 12

警報設定

Webhook警報

建立警報
POST /v1/alerts
  -H "Authorization: Bearer token"
  -d '{
 "name": "高錯誤率",
 "condition": "error_rate > 0.01",
 "webhook_url": "https://hooks.slack.com/...",
 "severity": "high"
  }'

警報類型

運行時間警報 — API不可用超過5分鐘
延遲警報 — P95延遲超過閾值
錯誤率警報 — 錯誤率高於1%
速率限制警報 — 接近速率限制
數據新鮮度警報 — 數據延遲超過閾值

請求日誌

日誌級別

日誌範例
// 典型API請求日誌條目
{
 "timestamp": "2026-03-21T14:00:00Z",
 "request_id": "req_abc123def456",
 method: GET,
 path: /v1/whales/btc,
 status: 200,
 duration_ms: 45,
 user_id: acct_12345
}

結構化日誌

所有日誌均為結構化 JSON，便於解析和分析：

ISO 8601 格式的時間戳
用於追踪的請求 ID
HTTP 方法和路徑
回應狀態和延遲
用戶 ID 和 API 金鑰指紋
錯誤訊息（如適用）

分散式追踪

請求 ID 追踪

追踪標頭
// 所有請求均包含追踪標頭
curl -H "X-Request-ID: req-abc123" \
  https://api.smartmoneyapi.com/v1/whales
// 回應包含相同 ID
X-Request-ID: req-abc123
X-Response-Time: 45ms
X-Server: api-prod-01

追踪上下文傳播

使用 W3C 追踪上下文標準進行分散式系統追踪：

W3C 追踪上下文
// 請求包含追踪上下文
traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
tracestate: dd=s:0
// 追踪 ID: 4bf92f3577b34da6a3ce929d0e0e4736
// 跨度 ID: 00f067aa0ba902b7
// 採樣: true (01)

SLA 監控

服務水平目標

方案	運行時間 SLA	回應時間	支援
免費	99%	盡力而為	社群
交易者	99.5%	<200ms p95	電子郵件
專業版	99.95%	<100ms p95	優先
企業版	99.99%	<50ms p95	專屬

SLA 信用額度

如果運行時間低於 SLA，將獲得服務信用額度：

99.0% - 99.5%: 10% 月度信用額度
95.0% - 99.0%: 25% 月度信用額度
< 95.0%: 100% 月度信用額度

監控儀表板

內建儀表板

訪問性能儀表板：https://status.smartmoney.io

自訂儀表板設置

Prometheus 查詢
// 查詢 API 請求率
rate(api_requests_total[5m])
// 查詢錯誤率
rate(api_requests_total{status=~"5.."}[5m])
// 查詢延遲百分位數
histogram_quantile(0.95, api_request_duration_ms)

監控工具整合

支援平台

工具	整合	功能
Prometheus	原生 /metrics 端點	指標抓取
Grafana	資料源插件	自訂儀表板
Datadog	API 整合	APM 追踪
New Relic	代理整合	全面可觀測性
PagerDuty	Webhook 警報	事件管理

監控最佳實踐

1. 監控關鍵指標

專注於直接影響業務的指標：運行時間、延遲、錯誤率。

2. 設置適當的警報

根據症狀警報，而不僅僅是閾值。按嚴重程度路由警報。

3. 使用請求 ID

始終使用唯一 ID 關聯請求以進行端到端追踪。

4. 實施分散式追踪

使用 W3C 追踪上下文以實現跨微服務的可見性。

5. 定期警報測試

每月測試警報通道以確保升級有效。

6. 記錄警報回應

為常見警報創建運行手冊，包含解決步驟。

確保 99.9% 運行時間

使用全面的健康檢查、指標和警報監控 Smart Money API。通過內建的可觀測性工具保持 SLA 合規性。

開始使用

專業版和企業版方案包含專屬支援和 SLA 監控。