Google Cloud Apigee 客服案件的最佳做法

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

您正在查看 Apigee X 說明文件。
檢視 Apigee Edge說明文件。

在客服案件中提供詳細的必要資訊後， Google Cloud Apigee 支援團隊可迅速有效地回覆您。何時提供支援服務 案件缺少重要細節，我們需要更多資訊，可能包括 來回切換這項作業所需的時間較長，而且可能導致問題解決速度延遲。 歡迎參閱這份最佳做法指南，瞭解我們需要更多相關資訊，協助您解決技術問題 客服案件

描述問題

問題應包含相關資訊，說明問題詳情 並處理這個情況理想的 Apigee 客服案件 包含下列各項 Apigee 產品的重要資訊：

重要資訊 說明 公用雲端適用的 Apigee Edge 適用於私有雲的 Apigee Edge
產品 觀察到問題的特定 Apigee 產品，包括版本 相關資訊 (如有)。
  • 版本
問題詳細資料 清楚詳盡的問題說明，並概略說明問題，包括完整 錯誤訊息 (如果有的話)。
  • 錯誤訊息
  • 追蹤工具輸出
  • 重現問題的步驟
  • 完成 API 要求/指令
  • 錯誤訊息
  • 追蹤工具輸出
  • 重現問題的步驟
  • 完成 API 要求/指令
  • 元件診斷記錄
時間 問題發生時的確切時間戳記，以及問題持續了多久。
  • 問題發生的日期、時間和時區
  • 問題持續時間
  • 問題發生的日期、時間和時區
  • 問題持續時間
設定 發現問題的詳細資訊。
  • 機構名稱
  • 環境名稱
  • API Proxy 名稱
  • 修訂版本
  • 網路拓撲
  • 失敗邊緣元件

以下各節會詳細說明這些概念。

產品

我們提供不同的 Apigee 產品，例如 Apigee Edge on Public Cloud， Apigee Edge 中的私有雲，因此我們需要 指出有問題的產品。

下表提供了一些範例，當中列出完整資訊 「DOs」欄中的資訊，而 DON's 資料欄：

可採取的行動 建議做法
無法在我們的公有雲機構中部署 API Proxy「OAuth2」...

無法部署 API Proxy

(我們需要瞭解您遇到的問題)。

安裝失敗，我們的 Edge Private Cloud 4.50.00 版出現以下錯誤 ...

無法在 Private Cloud 中設定，

(缺少版本資訊)

問題詳細資料

提供所觀察到問題的確切資訊，包括錯誤訊息 (如果 任何) 及預期和實際的行為。

下表舉例說明「DOs」資料欄內的完整資訊。 注意事項：

可採取的行動 建議做法

新 edgemicro Proxy edgemicro_auth 失敗，並發生以下錯誤：

{"error":"missing_authorization","error_description":"Missing Authorization header"}

今天已建立的新 edgemicro Proxy 無法運作

(Proxy 名稱未知，但無法確認 Proxy 是否傳回錯誤， 非預期的回應)。

我們的用戶端收到 500 項錯誤，錯誤訊息如下 向 API Proxy 發出要求：

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

我們的用戶端在向 API Proxy 提出要求時收到 500 錯誤。

(僅指出 500 錯誤並不會提供足夠的資訊給我們， 調查問題我們需要知道實際發生的錯誤訊息和錯誤代碼 )。

時間

時間是非常重要的資訊支援工程師必須知道 。

解決問題的支援工程師可能與您的時區不同，因此相對陳述 可能使問題難以診斷因此，建議您使用 日期和時間的 ISO 8601 格式 戳記，提供發現問題的確切時間。

下表提供了一些範例，當中顯示了 錯誤欄：

可採取的行動 建議做法
昨天在 2020-11-06 17:30 (太平洋夏令時間) 之間觀察到大量的503s 和 2020-11-06 17:35 (PDT)...

昨天下午 5:30 有 5 分鐘觀察到大量503s。

(我們必須使用默示的日期，而且也不清楚此問題的時區 )。

下列 API Proxy 發生高延遲時間，資料來源為 2020-11-09 15:30 (印度標準時間) 至 2020-11-09 18:10 (印度標準時間) ...

上週某些 API Proxy 的延遲時間偏高。

(我們無法確定在過去一週內注意到這個問題的日期和持續時間。)

設定

我們需要進一步瞭解問題發生的確切位置。根據用途 請提供下列資訊：

  • 如果您使用 Apigee Cloud，可能有多個機構，因此我們的 瞭解問題發生的特定機構及其他詳細資訊：
    • 機構和環境名稱
    • API Proxy 名稱和修訂版本編號 (適用於 API 要求失敗)
  • 如果您使用的是 Private Cloud ，可能是支援的 安裝拓撲。 因此，我們需要瞭解您使用的拓撲，包括設定項目數量等詳細資料 資料中心和節點

下表舉例說明「DOs」資料欄內的完整資訊。 注意事項：

可採取的行動 建議做法

401 自 2020 年 11 月 6 日 9:30 (CST) 起，Edge Public Cloud 的錯誤數已增加。

Edge 設定詳細資料：

失敗的 API 詳細資料如下：
機構名稱：myorg
版本名稱：test
API Proxy 名稱：myproxy
修訂版本編號：3

錯誤：

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

401 個錯誤已增加。

(但並未提供所用產品的任何資訊，因為問題發生當下 「觀察到」或任何設定詳細資料)。

無法在 Edge Private Cloud 4.19.06 版 啟動訊息處理器 額外增加閘道節點

診斷記錄：
附上訊息處理者記錄。

網路拓撲：
附加了含有額外節點的檔案 network-topology.png。

無法在 Edge Private Cloud 4.19.06 版 啟動訊息處理器 額外增加閘道節點

(找不到訊息處理器記錄和網路拓撲。)

有用的資料

提供與問題相關的相關證據，有助於加快解決問題的速度 ，瞭解所觀察到的實際行為，並深入瞭解其狀況。

本節說明一些對所有 Apigee 產品有幫助的實用構件：

所有 Apigee 產品的常見構件

下列構件適用於所有 Apigee 產品：Apigee Edge on Public Cloud 和 Apigee Edge 中的私有雲：

構件 說明
追蹤記錄工具輸出內容 追蹤工具輸出內容包含關於所傳輸 API 要求的詳細資訊 Apigee 產品。這對於任何執行階段錯誤 (例如 4XX、 5XX 和延遲問題
螢幕截圖 螢幕截圖有助於傳達實際行為或錯誤發生的情況。是 。
HAR (HTTP 封存) HAR 是 HTTP 工作階段工具擷取的檔案，用於偵錯任何 UI 相關問題。 你可以使用 Chrome、Firefox 或 Internet Explorer 等瀏覽器擷取這項圖片。
tcpdumps tcpdump 工具會擷取透過 更是如此這對於所有網路相關問題 (例如 TLS 握手失敗)， 502 個錯誤、延遲問題等

Apigee Edge 私有雲的其他構件

對於 Apigee Edge for Private Cloud，我們可能需要其他構件，才能加快速度 問題診斷。

構件 說明
網路拓撲 說明 Private Cloud 設定的 Edge 安裝拓撲圖表，包括 每個節點內安裝的所有資料中心、節點和元件
邊緣元件診斷記錄 與特定 Apigee Edge 元件 (例如 Message) 相關的診斷記錄 處理器、路由器或 Cassandra
安裝設定檔 安裝或升級 Apigee Edge 時使用的無訊息設定檔。

這個檔案適合用於驗證 安裝或遷移問題時遇到。

記憶體快照資料 記憶體快照資料是 Java 記憶體處理程序的數據匯報。如果記憶體容量較大 某些 Edge 元件出現使用率或 OutOfMemory 錯誤。
執行緒傾印 執行緒傾印檔是執行中 Java 程序所有執行緒的快照。

如果在特定 Edge 元件上觀察到高 CPU 或負載量偏高，這項功能就能派上用場。

案件範本和案例範例

本節根據不同的 本文件說明的最佳做法：

公有雲中的 Apigee Edge

範本

本節提供 在公用雲端中使用 Apigee Edge。

問題：

<詳細說明問題或您最終觀察到的行為。 請視情況加入產品名稱和版本。>

錯誤訊息：

<附上您觀察到的完整錯誤訊息 (如果有的話)>

問題開始時間 (ISO 8601 格式)：

問題結束時間 (ISO 8601 格式)：

Apigee 設定詳細資料：
機構名稱：
版本名稱：
API Proxy 名稱：
修訂版本編號：

重現問題的步驟：

<提供步驟以重現問題>

診斷資訊：

<附加檔案清單>

案例範例

本節提供 Apigee Cloud (Google 上的 Apigee 平台) 範例案例 公有雲中的 Cloud/Apigee Edge)。

問題：

我們在公有雲中看到大量 503 Service Unavailable 錯誤 機構。能否請您在調查後解決問題，或提供解決方法？

錯誤訊息：

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

問題開始時間 (ISO 8601 格式)：2020-10-04 06:30 IST

問題結束時間 (ISO 8601 格式)：問題仍未解決。

Apigee Cloud 設定詳細資料：
機構名稱：myorg
版本名稱：dev
API Proxy 名稱：myproxy
修訂版本編號：3

重現問題的步驟：

執行下列 curl 指令來重現問題：

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

診斷資訊：

追蹤工具輸出內容 (trace-503.xml)

適用於私有雲的 Apigee Edge

範本

本節提供 Apigee Edge for Private Cloud。

問題：

<詳細說明問題或您最終觀察到的行為。 請視情況加入產品名稱和版本。>

錯誤訊息：

<附上您觀察到的完整錯誤訊息 (如果有的話)>

問題開始時間 (ISO 8601 格式)：

問題結束時間 (ISO 8601 格式)：

Edge Private Cloud 設定詳細資料：

<請附加說明私有雲設定的網路拓撲，包括 資料中心和節點

重現問題的步驟：

<提供步驟以重現問題>

診斷資訊

<附加檔案清單>

案例範例

本節提供適用於 Private Cloud 的 Apigee Edge 案例範例。

問題：

我們在節點 #10 上安裝 Apigee Management Server Linux RHEL 7.6 上的 Edge Private Cloud 4.19.06，而我們在 。

錯誤訊息：

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

問題開始時間 (ISO 8601 格式)：每當我們安裝

問題結束時間 (ISO 8601 格式)： 不適用

Edge Private Cloud 設定詳細資料：

附加了 network-topology.png 檔案

重現問題的步驟：

產生上述錯誤的指令如下：

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

診斷資訊：

附加了下列檔案：

  • output.txt 包含上述指令的完整輸出內容，包含錯誤訊息
  • 管理伺服器記錄檔和
  • 設定檔 NonProdConfig.txt