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.
Chuyển đến tài liệu về 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 trường hợp 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. Quá trình này có thể phải diễn ra nhiều lần. Điều này sẽ mất nhiều thời gian hơn và có thể dẫn đến việc chậm trễ trong việc giải quyết vấn đề. Hướng dẫn các phương pháp hay nhất này cho bạn biết những 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 đề

Một 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 vấn đề. Một trường hợp hỗ trợ Apigee hiệu quả phải chứa các thông tin chính sau đây cho từng sản phẩm Apigee:

Thông tin chính Mô tả Apigee Edge cho đám mây công khai Apigee Edge cho đám mây riêng tư
Sản phẩm Sản phẩm Apigee cụ thể đang gặp vấn đề, bao gồm cả thông tin 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 đề, bao gồm cả thông báo lỗi đầy đủ (nếu có).
  • Thông báo lỗi
  • Kết quả 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/lệnh API
  • Thông báo lỗi
  • Kết quả 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/lệnh API
  • 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 lượng của vấn đề.
  • Ngày, giờ và múi giờ xảy ra vấn đề
  • Thời lượng của vấn đề
  • Ngày, giờ và múi giờ xảy ra vấn đề
  • Thời lượng của vấn đề
Thiết lập Thông tin chi tiết về nơi bạn quan sát thấy vấn đề.
  • Tên tổ chức
  • Tên môi trường
  • Tên proxy API
  • Bản sửa đổi
  • Cấu trúc mạng
  • Thành phần Edge không đạt

Các phần sau đây 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 Apigee, Apigee Edge trên đám mây công cộng và Apigee Edge trên đám mây riêng, vì vậy, chúng tôi cần thông tin cụ thể về sản phẩm cụ thể nào đang gặp 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 và thông tin chưa đầy đủ trong cột KHÔNG NÊN:

NÊN VIỆC KHÔNG NÊN LÀM
Không triển khai được proxy API OAuth2 trên tổ chức Public Cloud ...

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 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 Private Cloud.

(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 đề đang được quan sát, bao gồm cả thông báo lỗi (nếu có) và hành vi dự kiến cũng như hành vi thực tế được quan sá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 và thông tin chưa đầy đủ trong cột KHÔNG NÊN:

NÊN VIỆC KHÔNG NÊN LÀM

Proxy edgemicro mới edgemicro_auth không thành công do 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 nào không mong muốn hay không.)

Ứng dụng của chúng tôi gặp lỗi 500 với thông báo lỗi sau 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"}}}

Ứng dụng của chúng tôi gặp lỗi 500 trong khi gửi yêu cầu đến proxy API.

(Việc chỉ truyền tải Lỗi 500 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 thực tế và mã lỗi đang được quan sát.)

Thời gian

Thời gian là một thông tin rất quan trọng. Kỹ sư 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, thời lượng của vấn đề và liệu vấn đề này có còn tiếp diễn hay không.

Kỹ sư hỗ trợ giải quyết vấn đề có thể không ở múi giờ của bạn, vì vậy, các câu lệ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 phát hiện vấn đề.

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

NÊN VIỆC KHÔNG NÊN LÀM
Hôm qua, chúng tôi đã quan sát thấy một lượng lớn 503s trong khoảng thời gian từ 2020-11-06 17:30 PDT đến 2020-11-06 17:35 PDT...

Hôm qua lúc 5:30 chiều, chúng tôi đã quan sát thấy một lượng lớn 503s trong vòng 5 phút.

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

Chúng tôi nhận thấy độ trễ cao trên các Proxy API sau đây từ 09/11/2020 15:30 IST đến 09/11/2020 18:10 IST ...

Chúng tôi nhận thấy độ trễ cao trên một số Proxy API trong tuần trước.

(Không rõ vấn đề này xảy ra vào ngày nào và trong bao lâu trong tuần qua.)

Thiết lập

Chúng tôi cần biết thông tin chi tiết về chính xác vị trí bạn gặp 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 chi tiết khác mà bạn đang quan sát thấy vấn đề:
    • Tên tổ chức và môi trường
    • Tên proxy API và số bản sửa đổi (đối với các lỗi yêu cầu API)
  • Nếu đang sử dụng Đám mây riêng, thì có thể bạn đang sử dụng một trong nhiều cấu hình 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ả 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 và thông tin chưa đầy đủ trong cột KHÔNG NÊN:

NÊN VIỆC KHÔNG NÊN LÀM

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

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

Thông tin chi tiết về API không thành công như sau:
  Tên tổ chức: myorg
  Tên môi trường: test
  Tên proxy API: myproxy
  Số bản sửa đổi: 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.

(Tệp này không cung cấp bất kỳ thông tin nào về sản phẩm đang được sử dụng, thời điểm phát hiện vấn đề hoặc thông tin chi tiết về chế độ 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 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ý Trình xử lý thông báo và cấu trúc 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 cấu phần phần mềm liên quan đến vấn đề sẽ giúp đẩy nhanh quá trình giải quyết, vì điều này giúp chúng tôi hiểu rõ hành vi chính xác mà bạn đang quan sát và nhận được thông tin chi tiết hơn về hành vi đó.

Phần này mô tả một số cấu phần phần mềm hữu ích có thể giúp ích cho tất cả các sản phẩm Apigee:

Cấu phần phần mềm phổ biến cho tất cả các sản phẩm 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 Apigee: Apigee Edge trên đám mây công cộng và Apigee Edge trên đám mây riêng:

Cấu phần phần mềm Mô tả
Kết quả của công cụ theo dõi Kết quả của công cụ Theo dõi chứa thông tin chi tiết về các yêu cầu API chuyể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ế đang được quan sát. Tính năng này rất hữu ích đối với mọi lỗi hoặc vấn đề được quan sát thấy, 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ụ 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 chuyể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à các vấn đề về độ trễ, v.v.

Các cấu phần phần mềm bổ sung cho Apigee Edge cho Private Cloud

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

Cấu phần phần mềm Mô tả
Cấu trúc mạng Sơ đồ cấu trúc liên kết cài đặt Edge mô tả chế độ thiết lập của bạn trên Đám mây riêng tư, 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 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 để 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 đề cài đặt hoặc di chuyển.

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

Điều này rất hữu ích nếu bạn nhận thấy CPU hoặc Tải cao trên một số thành phần Edge nhất định.

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 khai

Mẫu

Phần này cung cấp một mẫu 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 quan sát được. Bao gồm tên và phiên bản sản phẩm (nếu có).>

Thông báo lỗi:

<Cung cấp toàn bộ thông báo lỗi đã quan sát được (nếu có)>

Thời gian bắt đầu sự cố (định dạng ISO 8601):

Thời gian kết thúc sự cố (định dạng ISO 8601):

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

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

<Cung cấp 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 Public Cloud).

Vấn đề:

Chúng tôi đang gặp phải nhiều lỗi 503 Service Unavailable (Dịch vụ không có sẵn) trong tổ chức Đám mây công cộng. Vui lòng xem xét và giải quyết vấn đề này hoặc tư vấn cho chúng tôi cách giải quyết.

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 sự cố (định dạng ISO 8601): 04/10/2020 06:30 IST

Thời gian kết thúc sự cố (định dạng ISO 8601): Vấn đề vẫn đang xảy ra.

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ố bản sửa đổi: 3

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

Chạy lệnh curl sau để 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 mẫu cho Apigee Edge cho đám mây riê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 quan sát được. Bao gồm tên và phiên bản sản phẩm (nếu có).>

Thông báo lỗi:

<Cung cấp toàn bộ thông báo lỗi đã quan sát được (nếu có)>

Thời gian bắt đầu sự cố (định dạng ISO 8601):

Thời gian kết thúc sự cố (định dạng ISO 8601):

Thông tin chi tiết về việc thiết lập Edge Private Cloud:

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

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

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

Thông tin chẩn đoán

<List of files attached>

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 Private Cloud.

Vấn đề:

Trong khi cài đặt Máy chủ quản lý Apigee trên Nút #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 sự cố (định dạng ISO 8601): Sự cố xảy ra bất cứ khi nào chúng ta cài đặt

Thời gian kết thúc sự cố (định dạng ISO 8601): Không áp dụng

Thông tin chi tiết về việc 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 dẫn đến 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 kết quả đầy đủ 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