Các phương pháp hay nhất dành cho yêu cầu hỗ trợ của Google Cloud Apigee

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X.
thông tin

Bạn đang xem tài liệu về Apigee X.
Xem tài liệu về Apigee Edge.

Việc cung cấp thông tin chi tiết và bắt buộc trong trường hợp hỗ trợ sẽ giúp nhóm Hỗ trợ Apigee của Google Cloud dễ dàng phản hồi bạn một cách nhanh chóng và hiệu quả. Khi yêu cầu hỗ trợ của bạn thiếu thông tin quan trọng, chúng tôi cần yêu cầu bạn cung cấp thêm thông tin. Điều này có thể khiến chúng tôi phải trao đổi qua lại nhiều lần. Việc này tốn nhiều thời gian hơn và có thể dẫn đến chậm trễ trong việc giải quyết vấn đề. Hướng dẫn về các phương pháp hay này cho bạn biết thông tin chúng tôi cần để giải quyết yêu cầu hỗ trợ kỹ thuật của bạn nhanh hơn.

Mô tả vấn đề

Vấn đề phải chứa thông tin giải thích chi tiết về những gì đã xảy ra so với những gì dự kiến sẽ xảy ra, cũng như thời điểm và cách thức xảy ra. Một yêu cầu hỗ trợ hiệu quả cho Apigee phải chứa những thông tin chính sau đây cho từng sản phẩm của Apigee:

Thông tin chính Mô tả Apigee Edge cho Đám mây công cộng Apigee Edge cho Đám mây riêng tư
Sản phẩm Sản phẩm cụ thể của Apigee mà vấn đề đang xảy ra, bao gồm cả thông tin về phiên bản (nếu có).
  • Phiên bản
Thông tin chi tiết về vấn đề Nội dung mô tả rõ ràng và chi tiết về vấn đề, trong đó nêu rõ vấn đề, bao gồm cả thông báo lỗi đầy đủ (nếu có).
  • Thông báo lỗi
  • Đầu ra của công cụ theo dõi
  • Các bước tái hiện vấn đề
  • Hoàn tất yêu cầu API/lệnh
  • Thông báo lỗi
  • Đầu ra của công cụ theo dõi
  • Các bước tái hiện vấn đề
  • Hoàn tất yêu cầu API/lệnh
  • Nhật ký chẩn đoán thành phần
Thời gian Dấu thời gian cụ thể khi vấn đề bắt đầu và thời gian vấn đề kéo dài.
  • Ngày, giờ và múi giờ xảy ra vấn đề
  • Thời gian xảy ra vấn đề
  • Ngày, giờ và múi giờ xảy ra vấn đề
  • Thời gian xảy ra vấn đề
Thiết lập Thông tin chi tiết về nơi bạn nhận thấy vấn đề.
  • Tên tổ chức
  • Tên Env
  • Tên proxy API
  • Bản sửa đổi
  • Cấu trúc liên kết mạng
  • Thành phần Edge không đạt

Các phần sau đây sẽ mô tả chi tiết hơn về những khái niệm này.

Sản phẩm

Có nhiều sản phẩm của Apigee, Apigee Edge trên Đám mây công cộngApigee Edge trên Đám mây riêng tư, vì vậy, chúng tôi cần thông tin cụ thể về sản phẩm gặp phải vấn đề.

Bảng sau đây cung cấp một số ví dụ cho thấy thông tin đầy đủ trong cột NÊN LÀM và thông tin chưa đầy đủ trong cột KHÔNG NÊN LÀM:

NÊN NHỮNG ĐIỀU KHÔNG NÊN LÀM
Không triển khai được proxy API OAuth2 trên tổ chức Đám mây công khai của chúng tôi ...

Không triển khai được proxy API

(Chúng tôi cần biết sản phẩm Apigee mà bạn đang gặp vấn đề.)

Không cài đặt được do lỗi sau đây trên Edge Private Cloud phiên bản 4.50.00 ...

Không cài đặt được trên chế độ thiết lập Đám mây riêng của chúng tôi.

(Thiếu thông tin phiên bản)

Thông tin chi tiết về vấn đề

Cung cấp thông tin chính xác về vấn đề bạn gặp phải, bao gồm cả thông báo lỗi (nếu có) cũng như hành vi dự kiến và hành vi thực tế mà bạn nhận thấy.

Bảng sau đây cung cấp một số ví dụ cho thấy thông tin đầy đủ trong cột NÊN LÀM và thông tin chưa đầy đủ trong cột KHÔNG NÊN LÀM:

NÊN NHỮNG ĐIỀU KHÔNG NÊN LÀM

edgemicro proxy edgemicro_auth mới đang gặp lỗi sau:

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

Proxy edgemicro mới được tạo hôm nay không hoạt động

(Không xác định được tên proxy. Không rõ liệu proxy có trả về lỗi hay bất kỳ phản hồi không mong muốn nào hay không.)

Khách hàng của chúng tôi gặp lỗi 500 với thông báo lỗi sau đây trong khi đưa ra yêu cầu cho proxy API:

{"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"}}}

Khách hàng của chúng tôi gặp phải Lỗi 500 khi đưa ra yêu cầu đối với proxy API.

(Chỉ truyền đạt 500 Lỗi không cung cấp đủ thông tin để chúng tôi điều tra vấn đề. Chúng tôi cần biết thông báo lỗi và mã lỗi thực tế mà bạn đang gặp phải.)

Thời gian

Thời gian là một thông tin rất quan trọng. Nhân viên hỗ trợ cần biết thời điểm bạn nhận thấy vấn đề này lần đầu tiên, vấn đề kéo dài bao lâu và liệu vấn đề có còn tiếp diễn hay không.

Kỹ sư hỗ trợ giải quyết vấn đề có thể không ở cùng múi giờ với bạn, vì vậy, những câu nói mang tính tương đối về thời gian sẽ khiến vấn đề khó chẩn đoán hơn. Do đó, bạn nên sử dụng định dạng ISO 8601 cho dấu ngày và giờ để cung cấp thông tin chính xác về thời điểm vấn đề được phát hiện.

Bảng sau đây cung cấp một số ví dụ cho thấy thời gian và khoảng thời gian chính xác mà vấn đề xảy ra trong cột NÊN LÀM, cũng như thông tin mơ hồ hoặc không rõ ràng về thời điểm vấn đề xảy ra trong cột KHÔNG NÊN LÀM:

NÊN NHỮNG ĐIỀU KHÔNG NÊN LÀM
Hôm qua, có rất nhiều 503s trong khoảng thời gian từ 17:30 ngày 6 tháng 11 năm 2020 theo giờ PDT đến 17:35 ngày 6 tháng 11 năm 2020 theo giờ PDT...

Đã có rất nhiều 503s vào lúc 17:30 hôm qua trong 5 phút.

(Chúng tôi buộc phải sử dụng ngày ngầm định và cũng không rõ vấn đề này xảy ra ở múi giờ nào.)

Đã ghi nhận độ trễ cao trên các API Proxy sau đây từ 15:30 ngày 9 tháng 11 năm 2020 (giờ IST) đến 18:10 ngày 9 tháng 11 năm 2020 (giờ IST) ...

Đã ghi nhận độ trễ cao trên một số API Proxy trong tuần trước.

(Không rõ ngày và thời lượng xảy ra vấn đề này trong tuần qua.)

Thiết lập

Chúng tôi cần biết thông tin chi tiết về vị trí chính xác mà bạn gặp phải vấn đề. Tuỳ thuộc vào sản phẩm bạn đang sử dụng, chúng tôi cần những thông tin sau:

  • Nếu đang sử dụng Apigee Cloud, bạn có thể có nhiều tổ chức. Vì vậy, chúng tôi cần biết tổ chức cụ thể và các thông tin khác nơi bạn đang gặp vấn đề:
    • Tên tổ chức và môi trường
    • Tên và số phiên bản của proxy API (đối với các yêu cầu API không thực hiện được)
  • Nếu đang sử dụng Đám mây riêng tư , bạn có thể đang sử dụng một trong nhiều cấu trúc liên kết cài đặt được hỗ trợ. Vì vậy, chúng tôi cần biết bạn đang sử dụng cấu trúc liên kết nào, bao gồm cả các thông tin chi tiết như số lượng trung tâm dữ liệu và nút.

Bảng sau đây cung cấp một số ví dụ cho thấy thông tin đầy đủ trong cột NÊN LÀM và thông tin chưa đầy đủ trong cột KHÔNG NÊN LÀM:

NÊN NHỮNG ĐIỀU KHÔNG NÊN LÀM

401 Số lỗi đã tăng trên Đám mây công cộng Edge kể từ 09:30 ngày 6 tháng 11 năm 2020 theo giờ CST.

Thông tin chi tiết về chế độ thiết lập Edge:

Sau đây là thông tin chi tiết về API không thành công:
  Tên tổ chức: myorg
  Tên môi trường: test
  Tên proxy API: myproxy
  Số phiên bản: 3

Lỗi:

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

401 Số lỗi đã tăng lên.

(Không cung cấp thông tin nào về sản phẩm đang được sử dụng, kể từ khi vấn đề được quan sát hoặc bất kỳ thông tin chi tiết nào về việc thiết lập.)

Không thể khởi động Trình xử lý thông báo trên Edge Private Cloud phiên bản 4.19.06 sau khi thêm các nút cổng bổ sung.

Nhật ký chẩn đoán:
Đính kèm nhật ký của Trình xử lý thông báo.

Cấu trúc liên kết mạng:
Đã đính kèm tệp network-topology.png chứa các nút bổ sung.

Không thể khởi động Trình xử lý thông báo trên Edge Private Cloud phiên bản 4.19.06 sau khi thêm các nút cổng bổ sung.

(Thiếu Nhật ký bộ xử lý thông báo và cấu trúc liên kết mạng.)

Cấu phần phần mềm hữu ích

Việc cung cấp cho chúng tôi các thông tin liên quan đến vấn đề sẽ giúp chúng tôi giải quyết vấn đề nhanh hơn, vì việc này giúp chúng tôi hiểu rõ hành vi chính xác mà bạn đang gặp phải và có thêm thông tin chi tiết về vấn đề đó.

Phần này mô tả một số cấu phần phần mềm hữu ích cho tất cả các sản phẩm của Apigee:

Cấu phần phần mềm chung cho tất cả các sản phẩm của Apigee

Các cấu phần phần mềm sau đây hữu ích cho tất cả các sản phẩm của Apigee: Apigee Edge trên Đám mây công khaiApigee Edge trên Đám mây riêng tư:

Cấu phần phần mềm Mô tả
Đầu ra của công cụ theo dõi Đầu ra của công cụ Theo dõi chứa thông tin chi tiết về các yêu cầu API truyền qua các sản phẩm Apigee. Điều này hữu ích cho mọi lỗi thời gian chạy, chẳng hạn như 4XX, 5XX và các vấn đề về độ trễ.
Ảnh chụp màn hình Ảnh chụp màn hình giúp truyền tải bối cảnh của hành vi hoặc lỗi thực tế mà bạn quan sát được. Thông tin này hữu ích cho mọi lỗi hoặc vấn đề bạn gặp phải, chẳng hạn như trong giao diện người dùng hoặc Analytics.
HAR (Http ARchive) HAR là một tệp được các công cụ trong phiên HTTP ghi lại để gỡ lỗi mọi vấn đề liên quan đến giao diện người dùng. Bạn có thể chụp ảnh màn hình bằng các trình duyệt như Chrome, Firefox hoặc Internet Explorer.
tcpdumps Công cụ tcpdump ghi lại các gói TCP/IP được truyền hoặc nhận qua mạng. Điều này hữu ích cho mọi vấn đề liên quan đến mạng, chẳng hạn như lỗi bắt tay TLS, lỗi 502 và vấn đề về độ trễ, v.v.

Các cấu phần phần mềm bổ sung cho Apigee Edge cho Đám mây riêng tư

Đối với Apigee Edge cho Đám mây riêng tư, chúng tôi có thể cần thêm một số cấu phần phần mềm để chẩn đoán vấn đề nhanh hơn.

Cấu phần phần mềm Mô tả
Cấu trúc liên kết mạng Sơ đồ cấu trúc liên kết cài đặt Edge mô tả chế độ thiết lập Đám mây riêng của bạn, bao gồm tất cả các trung tâm dữ liệu, nút và thành phần được cài đặt trong mỗi nút.
Nhật ký chẩn đoán của thành phần Edge Nhật ký chẩn đoán liên quan đến thành phần Apigee Edge cụ thể, chẳng hạn như Trình xử lý thông báo, Bộ định tuyến hoặc Cassandra.
Tệp cấu hình cài đặt Tệp cấu hình im lặng được dùng khi cài đặt hoặc nâng cấp Apigee Edge.

Tệp này hữu ích trong việc xác thực xem tất cả các chế độ cài đặt có chính xác hay không trong trường hợp gặp phải vấn đề về việc cài đặt hoặc di chuyển.

Tệp báo lỗi Tệp kết xuất vùng nhớ khối xếp là ảnh chụp nhanh của quy trình bộ nhớ Java. Điều này hữu ích nếu bạn thấy mức sử dụng bộ nhớ cao hoặc lỗi OutOfMemory trên một số thành phần của Edge.
Tệp kết xuất luồng Tệp kết xuất luồng là ảnh chụp nhanh của tất cả các luồng của một quy trình Java đang chạy.

Điều này sẽ hữu ích nếu bạn nhận thấy CPU hoặc Mức sử dụng cao trên một số thành phần Edge.

Mẫu trường hợp và trường hợp mẫu

Phần này cung cấp các mẫu trường hợp và trường hợp mẫu cho nhiều sản phẩm dựa trên các phương pháp hay nhất được mô tả trong tài liệu này:

Apigee Edge trên Đám mây công cộng

Mẫu

Phần này cung cấp một mẫu cho Apigee Edge trên Đám mây công cộng.

Vấn đề:

<Cung cấp nội dung mô tả chi tiết về vấn đề hoặc hành vi mà bạn nhận thấy. Nếu có thể, hãy thêm tên và phiên bản sản phẩm.>

Thông báo lỗi:

<Include the complete error message observed (if any)>

Thời gian bắt đầu vấn đề (định dạng ISO 8601):

Thời gian kết thúc vấn đề (định dạng ISO 8601):

Thông tin chi tiết về chế độ thiết lập Apigee:
  Tên tổ chức:
  Tên môi trường:
  Tên proxy API:
  Số phiên bản:

Các bước để tái hiện:

<Nêu các bước để tái hiện vấn đề (nếu có thể)>

Thông tin chẩn đoán:

<Danh sách tệp đính kèm>

Trường hợp mẫu

Phần này cung cấp một trường hợp mẫu cho Apigee Cloud (Apigee trên Google Cloud/Apigee Edge trên Đám mây công cộng).

Vấn đề:

Chúng tôi nhận thấy có nhiều lỗi 503 (Dịch vụ không có sẵn) trong tổ chức Đám mây công khai của chúng tôi. Bạn có thể xem xét vấn đề này và giải quyết hoặc tư vấn cho chúng tôi cách giải quyết không?

Thông báo lỗi:

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

Thời gian bắt đầu xảy ra vấn đề (định dạng ISO 8601): 2020-10-04 06:30 IST

Thời gian kết thúc vấn đề (định dạng ISO 8601): Vấn đề vẫn tiếp diễn.

Thông tin chi tiết về việc thiết lập Apigee Cloud:
  Tên tổ chức: myorg
  Tên môi trường: dev
  Tên proxy API: myproxy
  Số phiên bản: 3

Các bước để tái hiện:

Chạy lệnh curl sau đây để tái hiện vấn đề:

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

Thông tin chẩn đoán:

Đầu ra của công cụ theo dõi (trace-503.xml)

Apigee Edge cho Đám mây riêng tư

Mẫu

Phần này cung cấp một mẫu cho Apigee Edge cho Đám mây riêng tư.

Vấn đề:

<Cung cấp nội dung mô tả chi tiết về vấn đề hoặc hành vi mà bạn nhận thấy. Nếu có thể, hãy thêm tên và phiên bản sản phẩm.>

Thông báo lỗi:

<Include the complete error message observed (if any)>

Thời gian bắt đầu vấn đề (định dạng ISO 8601):

Thời gian kết thúc vấn đề (định dạng ISO 8601):

Thông tin chi tiết về chế độ thiết lập Edge Private Cloud:

<Đính kèm cấu trúc liên kết mạng mô tả chế độ thiết lập Đám mây riêng của bạn, bao gồm cả trung tâm dữ liệu và các nút>

Các bước để tái hiện:

<Nêu các bước để tái hiện vấn đề (nếu có thể)>

Thông tin chẩn đoán

<Danh sách tệp đính kèm>

Trường hợp mẫu

Phần này cung cấp một trường hợp mẫu cho Apigee Edge cho Đám mây riêng.

Vấn đề:

Trong khi cài đặt Apigee Management Server trên Node #10 trong Edge Private Cloud 4.19.06 trên Linux RHEL 7.6, chúng tôi gặp phải lỗi sau.

Thông báo lỗi:

<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

Thời gian bắt đầu có vấn đề (định dạng ISO 8601): Vấn đề xảy ra bất cứ khi nào chúng tôi cài đặt

Thời gian kết thúc vấn đề (định dạng ISO 8601): Không áp dụng

Thông tin chi tiết về chế độ thiết lập Edge Private Cloud:

Đã đính kèm tệp network-topology.png

Các bước để tái hiện:

Sau đây là lệnh gây ra lỗi ở trên:

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

Thông tin chẩn đoán:

Đính kèm các tệp sau:

  • output.txt chứa đầu ra hoàn chỉnh của lệnh trên, bao gồm cả thông báo lỗi
  • Nhật ký máy chủ quản lý và
  • Tệp cấu hình NonProdConfig.txt