閱讀時間 6 分鐘
概覽
Quicknode 的 Prometheus Exporter 可讓您將平台與基礎架構指標串流至現有的可觀測性架構,以進行即時系統健康狀態監控。
在本指南中,我們將逐步引導您如何利用 QuicknodeAdmin API 對 Prometheus 的支援,建立一個 Grafana 儀表板,以進行進階指標視覺化,從而監控您的 Quicknode 端點。
Quicknode 還為企業方案的平臺和基礎架構提供 14 天的日誌保留服務。如需更多資訊,請參閱我們的定價頁面。
您將負責的工作內容
- 設定 Prometheus 匯出器,並建立 Grafana 儀表板,用以監控您的 RPC 基礎架構
您需要準備的物品
- 一個採用「企業方案」的Quicknode 帳戶
- 您的電腦上已安裝並正在執行Docker Desktop
- Prometheus和Grafana的基礎知識(我們將引導您完成每個步驟)
Quicknode 管理員 API 簡介
Quicknode 管理 API 提供強大的程式化存取功能,可執行使用者儀表板中的所有操作,讓您能更有效地管理基礎架構、監控效能並控制成本。在本指南中,我們將特別著重於如何使用 Prometheus Exporter 存取詳細的系統指標,並透過 Grafana 建立一個全面的監控儀表板。
如果您有興趣了解如何使用 Admin API 進行端點管理,請參閱我們的指南:《如何使用 Quicknode Admin API 管理您的 RPC 基礎架構》。
先決條件
Quicknode 帳戶與 API 金鑰
建立您的 API 金鑰非常簡單。
- 請登入您的Quicknode 帳戶。
- 點擊左上角的頭像圖示,然後選擇「API 金鑰」以進入「API 金鑰」頁面。
- 產生一個具備適當權限的 API 金鑰(您需要
CONSOLE_REST使用 Admin API) 並將其放在手邊,因為你稍後就會用到它。

Docker Desktop
請確保您已安裝 Docker Desktop 已安裝並正在執行。我們將使用 Docker 快速啟動 Prometheus 和 Grafana。
使用 Prometheus Exporter 建立 Grafana 儀表板
在本節中,我們將引導您使用 Docker 設定 Prometheus 和 Grafana,以監控您的 Quicknode 指標。由於我們將使用 Docker,因此您無需分別安裝 Prometheus 和 Grafana。
Prometheus:一款開源監控系統,可將指標以時間序列資料的形式進行收集與儲存,讓您能夠追蹤並分析各項效能指標隨時間的變化。
Grafana:一款強大的開源分析與視覺化工具,可讓您建立動態且具互動性的儀表板,用以視覺化來自 Prometheus 等資料來源的指標。
Docker:一個用於在容器中開發、部署和執行應用程式的平台。在此設定中,我們將使用 Docker 在隔離的容器中執行 Prometheus 和 Grafana,藉此簡化安裝與設定流程。
我們已在 Quicknode 的qn-guide-examples儲存庫中建立了一個資料夾,其中包含 Prometheus 和 Grafana 所需的所有設定檔案。
.
├── docker-compose.yaml # Docker Compose file to launch Prometheus and Grafana
├── grafana
│ ├── dashboards
│ │ │ └── Quicknode Admin API.json # Grafana dashboard JSON file
│ ├── provisioning
│ │ ├── dashboards
│ │ │ └── main.yaml # Configuration for loading dashboards into Grafana
│ │ └── datasources
│ │ └── prometheus-source.yaml # Configuration for connecting Grafana to Prometheus
├── prometheus
│ └── prometheus.yaml # Prometheus configuration file
請按照以下步驟開始操作:
步驟 1:克隆範例專案儲存庫
開啟您的終端機/命令提示字元,並克隆該儲存庫:
git clone https://github.com/quiknode-labs/qn-guide-examples.git
導航至 grafana-dashboard 克隆的儲存庫中的資料夾:
cd qn-guide-examples/admin-api/grafana-dashboard
步驟 2:更新您的 API 金鑰
開啟 prometheus.yaml 位於 普羅米修斯 目錄。
替換 <YOUR_API_KEY> 請替換為您稍早生成的實際 Quicknode API 金鑰:
global:
scrape_interval: 30s
scrape_configs:
- job_name: "quicknode_prometheus_exporter"
metrics_path: "v0/prometheus/metrics"
scheme: "https"
authorization:
type: "bearer"
credentials: "<API_KEY>"
# fallback_scrape_protocol: PrometheusText0.0.4
static_configs:
- targets: ["api.quicknode.com"]
註: 如果您正在使用 Prometheus 3.x, 您可能需要新增 備用抓取協定 欄位至 scrape_configs 區段。
要做到這一點,您只需取消上述範例中標示出的那行註解即可。
步驟 3:使用 Docker 啟動 Prometheus 和 Grafana
我們已預先設定了一個 docker-compose.yaml 檔案以簡化設定流程。您可以在根目錄下執行以下指令,同時啟動 Prometheus 和 Grafana(即, grafana-dashboard):
docker-compose up
新增 -d 此參數用於以獨立模式啟動服務,使其在背景中運行。
步驟 4:開啟 Grafana 並檢視您的儀表板
- 開啟網頁瀏覽器,並前往
http://localhost:3000. - 請使用專案的登入憑證登入(使用者名稱:
管理員, 密碼:密碼) (如在docker-compose.yaml檔案) - 導航至
儀表板. - 找到並點擊Quicknode Admin API儀表板。
現在您應該會看到儀表板顯示來自您的 Quicknode 端點的指標。
注意:若儀表板顯示為空白,表示您的端點目前尚未有任何活動。請務必執行某些操作(例如:向您的端點發送 RPC 請求),以開始產生資料,這些資料隨後將反映在儀表板上。

儀表板提供以下面板,協助您監控 Quicknode 基礎架構:
- Quicknode RPC 請求(計量表):顯示目前發送至您的 Quicknode 端點的 RPC 請求總數。
- Quicknode RPC 積分(計量表):顯示您的 Quicknode 端點已使用的總積分。
- Quicknode RPC 請求總數(過去 30 天):一張顯示過去 30 天 RPC 請求總數的時間序列圖表。
- Quicknode RPC 積分總量(過去 30 天):一張顯示過去 30 天內積分總使用量的時間序列圖表。
- Quicknode 端點回應狀態:顯示您的 Quicknode 端點請求的回應狀態(例如 200、400 等)。
- Quicknode 端點最大回應時間:顯示您的端點的最大回應時間。
您可以隨心所欲地自訂儀表板,例如編輯現有面板、新增面板,或調整時間範圍,以符合您的需求。
若您想直接檢視 Prometheus 所收集的指標,請依照以下步驟操作:
- 開啟網頁瀏覽器,並前往
http://localhost:9090 - 請在 Prometheus 介面中導航至「狀態 > 目標」,以確認 Quicknode 目標是否已列出且處於「UP」狀態。
- 檢查 Quicknode 所提供的關鍵指標:
- 切換至「圖表」索引標籤。
- 在表達式方塊中,請依序輸入以下其中一項指標,然後點擊 執行:
quicknode_rpc_creditsquicknode_rpc_requestsquicknode_rpc_response_statusquicknode_rpc_response_time_max
- 這樣一來,您就能以圖表或表格的形式查看所收集的原始資料。

完成後,您可以執行以下指令來停止這些服務:
docker-compose down
結論
恭喜!🎉 您已成功連線至 Quicknode Prometheus Exporter,從您的 RPC 基礎架構擷取進階指標,並建立了一個 Grafana 儀表板來監控系統健康狀態。此設定能為您提供有關 RPC 基礎架構的寶貴即時洞察,讓您能夠優化效能並維持可視性。
如果您有任何疑問、想法或建議,請直接與我們聯繫。此外,歡迎在X上追蹤我們,並加入我們的Discord和Telegram 公告頻道,以掌握最新動態。
我們 ❤️ 您的回饋!
如果您有任何意見回饋或對新主題的建議,請告訴我們。我們非常樂意聽取您的意見。
