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 về yêu cầu hỗ trợ sẽ giúp Nhóm hỗ trợ Google Cloud Apigee 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 cung cấp thêm thông tin và việc này có thể cần phải trả lời lại nhiều lần. Việc này có thể mất nhiều thời gian hơn và có thể khiến việc giải quyết vấn đề bị chậm trễ. Hướng dẫn về các phương pháp hay nhất này sẽ cho bạn biết thông tin mà 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ợ tốt về Apigee phải có những thông tin quan trọng sau đây về từng sản phẩm Apigee:

Thông tin chính Nội dung mô tả Apigee Edge cho đám mây công cộng Apigee Edge dành 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 gian xảy ra vấn đề.
  • Ngày, giờ và múi giờ xảy ra sự cố
  • Thời gian xảy ra vấn đề
  • Ngày, giờ và múi giờ xảy ra sự cố
  • Thời gian xảy ra vấn đề
Thiết lập Thông tin chi tiết về nơi xảy ra sự cố.
  • Tên tổ chức
  • Tên môi trường
  • Tên proxy API
  • Bản sửa đổi
  • Cấu trúc liên kết mạng
  • Thành phần Không đạt chuẩn

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 Apigee là Apigee Edge on Public Cloud và Apigee Edge on Private Cloud. Vì vậy, chúng tôi cần thông tin cụ thể về sản phẩm cụ thể đ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 không đầy đủ trong cột KHÔNG NÊN:

VIỆC NÊN LÀM VIỆC KHÔNG NÊN
Không triển khai được proxy API OAuth2 trên tổ chức Public Cloud 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 phải vấn đề.)

Không cài đặt được với lỗi sau trên Edge Private Cloud phiên bản 4.50.00 của chúng tôi ...

Không cài đặt được trong quá trình thiết lập Đám mây riêng tư.

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

Thông tin chi tiết về sự cố

Cung cấp thông tin chính xác về vấn đề phát hiện được, 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ế quan sát được.

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 không đầy đủ trong cột KHÔNG NÊN:

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

Proxy edgemicro mới edgemicro_auth đang không thành công với 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

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

Máy khách của chúng tôi gặp phải thông báo lỗi 500 với thông báo lỗi sau đây khi gửi yêu cầu tới 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 500 Lỗi khi gửi yêu cầu proxy API.

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

Thời gian

Thời gian là một loại thông tin rất quan trọng. Điều quan trọng là Kỹ sư hỗ trợ phải biết được thời điểm bạn phát hiện vấn đề này lần đầu, thời gian tồn tại 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 ở trong múi giờ của bạn. Vì vậy, những thông báo tương đối về thời gian sẽ khiến việc chẩn đoán sự cố trở nên khó khă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 gian tại thời điểm phát hiện thấy vấ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 xảy ra vấn đề trong cột DO, cũng như thông tin mơ hồ hoặc không rõ ràng về thời điểm xảy ra vấn đề trong cột KHÔNG NÊN:

VIỆC NÊN LÀM VIỆC KHÔNG NÊN
Đã quan sát được số lượng lớn 503s vào ngày hôm qua trong khoảng thời gian từ 2020-11-06 17:30 PDT đến 2020-11-06 17:35 PDT...

Một số lượng lớn 503s đã được quan sát trong 5 phút ngày hôm qua lúc 5:30 chiều.

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

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

Đã quan sát thấy độ trễ cao trên một số Proxy API vào tuần trước.

(Không rõ vấn đề này xảy ra vào ngày và khoảng thời gian nào trong tuần trước.)

Thiết lập

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

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

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

401 Lỗi đã tăng trên Edge Public Cloud kể từ 09/11/2020 09:30 CST.

Thông tin thiết lập cạnh:

Thông tin chi tiết về API không đạt 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"}}}

Đã tăng 401 lỗi.

(Báo cáo 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, vì thời điểm phát hiện thấy vấn đề hoặc bất kỳ thông tin thiết lập nào.)

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ý Trình xử lý tin nhắn.

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 cấu phần phần mềm liên quan đến vấn đề sẽ đẩy nhanh quá trình giải quyết, vì việc này sẽ giúp chúng tôi hiểu chính xác hành vi mà bạn đang quan sát và thu thập thêm thông tin chi tiết về hành vi đó.

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

Các cấu phần phần mềm phổ biến cho tất 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 on Public Cloud và Apigee Edge on Private Cloud:

Cấu phần phần mềm Nội dung mô tả
Kết quả của công cụ theo dõi Kết quả đầ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 sẽ 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 chuyển tiếp ngữ 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 đề phát hiện được, chẳng hạn như 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 sự cố liên quan đến giao diện người dùng. Bạn có thể chụp ảnh này 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. Thao tác này sẽ hữu ích đối với 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ấu phần phần mềm bổ sung cho Apigee Edge dành cho đám mây riêng tư

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

Cấu phần phần mềm Nội dung 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ả cách thiết lập Đám mây riêng tư 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 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ư Bộ xử lý tin nhắn, 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 rất hữu ích trong việc xác thực xem tất 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ề cài đặt hoặc di chuyển.

Tệp báo lỗi Tệp báo lỗi là thông tin tổng quan nhanh về quy trình bộ nhớ Java. Việc này rất hữu ích nếu bạn nhậ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 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.

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 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 thấy ở phía bạn. Cung cấp tên và phiên bản sản phẩm (nếu có).>

Thông báo lỗi:

<Bao gồm thông báo lỗi đầy đủ 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):

Chi tiết thiết lập API:
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 sự cố:

<Đưa ra các bước để tái hiện vấn đề nếu có thể>

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

<Danh sách các 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 thấy rất nhiều lỗi 503 Service Không khả dụng trong tổ chức của chúng tôi Đám mây công cộng. Bạn có thể xem xét vấn đề và giải quyết vấn đề này hoặc cho chúng tôi biết 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 sự cố (định dạng ISO 8601): 2020-10-04 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.

Chi tiết thiết lập API Apigee:
Tên tổ chức: myorg
Tên gói dịch vụ: dev
Tên proxy API: myproxy
Số bản sửa đổi: 3

Các bước tái hiện sự cố:

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:

Kết quả của công cụ theo dõi (trace-503.xml)

Apigee Edge dành 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 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 quan sát thấy ở phía bạn. Cung cấp tên và phiên bản sản phẩm (nếu có).>

Thông báo lỗi:

<Bao gồm thông báo lỗi đầy đủ 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 Đám mây riêng tư Edge:

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

Các bước tái hiện sự cố:

<Đưa ra các bước để tái hiện vấn đề nếu có thể>

Thông tin chẩn đoán

<Danh sách các 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 về Apigee Edge trong đám mây riêng tư.

Vấn đề:

Trong quá trình 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): Điều này xảy ra bất cứ khi nào chúng tôi 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 Đám mây riêng tư Edge:

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

Các bước tái hiện sự cố:

Dưới đâ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 có chứa kết quả hoàn chỉnh của lệnh trên, bao gồm cả thông báo lỗi
  • Quản lý nhật ký máy chủ và
  • Tệp cấu hình NonProdConfig.txt