以下列舉幾個常見問題,以及 API 中心連接器整合的疑難排解步驟。
API 中繼資料未顯示在 API 中心
- 初始同步時間:初始同步作業可能需要幾小時才會開始,API 資料也會在這段時間後顯示在 API 中心。建議稍候幾小時。
- 外掛程式執行個體狀態:確認 API 中心中的外掛程式執行個體未遭刪除或變更。
- 閘道 ID:請確認 Apigee Edge for Private Cloud API 中心連接器設定中,已正確設定閘道 ID。
- 檢查記錄:檢查 Edge for Private Cloud API 中樞連接器服務記錄
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
中是否有任何錯誤。
已部署 Proxy,但 API Hub 中的資訊不正確
- 傳播延遲:部署的 Proxy 資訊需要幾分鐘才會傳播,並反映在 API 中心。
- 檢查記錄:查看 Edge for Private Cloud API 中樞連接器記錄,瞭解上傳的 Proxy 詳細資料。這有助於判斷系統是否已成功處理 Proxy 更新,以進行同步。
使用者機構停止同步,但 API 中心連接器未進行任何變更
- 外掛程式執行個體狀態 (API 中心端):確認 API 中心內相關聯的外掛程式執行個體是否已取消佈建、刪除或變更。API 中樞端的任何變更,都可能直接影響 API 中樞連接器的同步作業。
- 檢查記錄:查看 Edge for Private Cloud API 中樞連接器記錄,找出可能導致同步程序中斷的錯誤、警告或問題。這可能包括連線問題,或是 API 中心驗證問題。
使用狀態 API (建議已啟用機構使用):
狀態 API 可直接顯示哪些機構已選擇加入並積極同步。
以記錄為基礎的疑難排解
API 中樞連接器記錄檔儲存在哪裡?
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
如何取得已啟用機構的相關資訊?
如要判斷目前已啟用及同步處理的機構,您可以運用狀態 API 並檢查系統記錄。
- 動作:呼叫狀態 API 端點。
- 預期輸出內容:API 回應中的
apiSyncStatus
和analyticsSyncStatus
部分會列出已加入的機構。啟用中繼資料同步處理的機構會顯示在apiSyncStatus
下方,啟用執行階段同步處理的機構則會顯示在analyticsSyncStatus
下方。{ "apiSyncStatus": [ { "organization": "foo", "phase": "Preparing", // ColdTransfer => Preparing "components": [ "proxy": { "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 100, // total proxies known to uapim connector "pendingItems": 90, // pending proxies to upload "completedItems": 6, // completed proxies to upload "failedItems": 4 // proxies failed to upload } }, "environment": { //environment upload status "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 5, // total number of environments "pendingItems": 1, // pending environments to process "completedItems": 3, // completed environment processing "failedItems": 1 // failed environment processing } }] }, { "organization": "bar", "phase": "Processing", // "Streaming" -> "Processing" "components": [ "proxy": { "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 110, // total proxies known to uapim connector "pendingItems": 16, // pending proxies to upload "completedItems": 3, // completed proxies to upload "failedItems": 1 // proxies failed to upload } }, "environment": { "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 5, // total number of environments "pendingItems": 3, // pending environments to process "completedItems": 1, // completed environment processing "failedItems": 1 // failed environment processing } }] }, { "organization": "test", "phase": "Queued", // "Yet to start" -> "Queued" "lastUpdated": "2025-04-16T00:56:45Z" } ], "analyticsSyncStatus": [ { "organization": "test", "environment": "dev", "failedItems": 2, "lastUpdated": "2025-04-16T00:56:45Z" }, { "organization": "test", "environment": "prod", "failedItems": 4, "lastUpdated": "2025-04-16T00:56:45Z" } ] }
- 檢查系統記錄:如要更精細地查看,並確認個別機構的同步設定,可以檢查特定項目的系統記錄。
- 檢查記錄:
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 搜尋指令:使用
grep
或類似的記錄搜尋工具,找出下列記錄行:- 如要同步處理機構中繼資料,請使用以下指令:
grep "Setup metadata sync for organization: metadata-org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 記錄檔程式碼片段範例:
2025-07-10 08:47:09,901 main INFO c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.setupMetadataSync() : Setup metadata sync for organization: metadata-org
- 尋找「為機構設定中繼資料同步」文字,後面會顯示機構名稱。
- 如要同步處理機構執行階段 org 執行階段資料,請執行下列操作:
grep "Setup runtime data sync for organization: runtime-org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 記錄檔程式碼片段範例:
2025-07-10 08:47:09,902 main INFO c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.setupRuntimeSyncData() : Setup runtime data sync for organization: runtime-org
- 找出「為機構設定執行階段資料同步:」文字,後面會顯示機構名稱。
- 如要同步處理機構中繼資料,請使用以下指令:
- 檢查記錄:
如何從記錄中取得所有無法啟用的 (機構、環境) 資訊?
如要瞭解無法啟用機構的原因,請檢查系統記錄中的特定錯誤項目。
- 檢查記錄:
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 搜尋指令:使用
grep
或類似的記錄搜尋工具,找出指出中繼資料同步狀態更新期間發生錯誤的記錄行。- For failed metadata synchronization status updates for org/env failed-org/failed-env:
grep "Error while updating metadata sync status for org: failed-org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 記錄檔程式碼片段範例:
2025-07-15 10:30:15,123 main ERROR c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.updateMetadataSyncStatus() : Error while updating metadata sync status for org: failed-org
- 找出
Error while updating metadata sync status for org/env:
後方接續機構和環境的文字 (例如:failed-org/failed-env)。
- For failed metadata synchronization status updates for org/env failed-org/failed-env:
如何從記錄檔取得機構轉移狀態變更的摘要?
如要查看 (機構、環境) 同步移轉狀態的更新時間摘要,可以檢查系統記錄中的特定項目。
- 檢查記錄:
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 搜尋指令:使用
grep
或類似的記錄搜尋工具,找出指出機構和環境轉移狀態更新的記錄行。- 如要瞭解轉移狀態的最新消息:
grep "Transfer status is updated for org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 記錄檔程式碼片段範例:
2025-07-15 18:35:01,789 main INFO c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.updateTransferStatus() : Transfer status is updated for org: org1 to BULK_TRANSFER 2025-07-10 08:47:11,364 main INFO c.a.u.m.UAPIMMetadataServiceImpl - UAPIMMetadataServiceImpl.updateEnvironmentStatus() : Transfer status is updated for org: org1 to STREAMING
- 請尋找「Transfer status is updated for org/env」這段文字,後面會接上特定機構和環境 (例如 org1/prod) 和狀態。
- 如要瞭解轉移狀態的最新消息:
如要查看與收集及上傳個別 Proxy 的 Proto 資料相關的記錄項目,可以搜尋特定記錄行。
- 記錄檔位置:
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 搜尋指令:使用
grep
或類似的記錄搜尋工具,找出記錄行,指出特定機構和 Proxy 上傳收集到的 Proto 資料。- 成功情境:Proxy proto 會上傳至 API Hub,在此情況下,請搜尋「uploaded collect proto for org: {}, proxy: {},」文字。
grep "uploaded collect proto for org: your-org-name, proxy: your-proxy-name, with messageId:" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- 將
-org-name
替換為實際機構名稱,並將 your-proxy-name 替換為您感興趣的實際 Proxy 名稱。 記錄片段範例:2025-07-10 08:47:11,362 main DEBUG c.a.u.m.UAPIMMetadataServiceImpl - UAPIMMetadataServiceImpl.generateCollectProto() : uploaded collect proto for org: org1, proxy: proxy1, with messageId: message_ids: "15569268426032329"
找出「uploaded collect proto for org: 」文字,後面接著機構名稱,然後是「, proxy: 」和 Proxy 名稱。
- 失敗情境:Proxy proto 上傳至 API 中心失敗,在此情況下,請搜尋「Failed to publish collect proto for org: {}, proxy: {},"」文字。
grep "Failed to publish collect proto for org: your-org-name, proxy: your-proxy-name, " /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
將 your-org-name 替換為實際機構名稱,並將 your-proxy-name 替換為您感興趣的實際 Proxy 名稱。
記錄片段範例:2025-07-10 08:47:11,362 main DEBUG c.a.u.m.UAPIMMetadataServiceImpl - UAPIMMetadataServiceImpl.generateCollectProto() : Failed to publish collect proto for org: org1, proxy: proxy1
找出「failed to publish collect proto for org: 」文字,後面接著機構名稱,然後是「, proxy: 」和 Proxy 名稱。
- 成功情境:Proxy proto 會上傳至 API Hub,在此情況下,請搜尋「uploaded collect proto for org: {}, proxy: {},」文字。
執行階段/分析
記錄無法發布至 NFS
原因:NFS 使用率超過 75%。
驗證方式:grep "Diskspace usage is at more than 75% of the allocated MaxDiskSpace at" /opt/apigee/var/log/edge-message-processor/logs/system.log
原因:API 中樞連接器執行階段同步未啟用或設定錯誤
在 /opt/apigee/customer/application/message-processor.properties:
中檢查下列事項:
conf_message-processor-communication_uapim.enabled.environments=
確認列出的機構和環境正確無誤。
conf_message-processor-communication_uapim.runtime.data.path=
確認指向正確的 NFS 路徑。
如何判斷資料是否已成功發布至 NFS
記錄會儲存在特定 NFS 路徑,例如「/the/nfs/staging」。
您可以直接檢查這個目錄的內容,確認是否有新建立的檔案。如果檔案存在,表示已成功發布至 NFS。
未處理就刪除資料檔案
原因:檔案名稱未包含有效的機構/環境資訊。
記錄檢查:
grep "Skipped and Deleted file" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
缺少機構設定,因此檔案已刪除
原因:找不到機構專屬設定。
記錄檢查:
grep "Deleted file .* due to missing org config" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
檔案因環境無效而遭刪除
原因:從檔案名稱剖析的環境不存在於機構設定中。
記錄檢查:
grep "Deleted file .* due to invalid env" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
無法將檔案上傳至 Pub/Sub
原因:無法建立發布者 (例如服務帳戶或主題設定錯誤)。
記錄檢查:
grep "Failed to create publisher for org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
部分上傳 - 部分記錄上傳失敗
原因:檔案中的部分記錄無法發布。
記錄檢查:
grep "was not completely published" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
檔案已完成處理並刪除
記錄檢查:
grep "File .* completely published to topic" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log