Google Cloud Apigee 지원 케이스 권장사항

Apigee Edge 문서입니다.
Apigee X 문서로 이동 정보

Apigee X 문서입니다.
Apigee Edge 문서 보기

지원 케이스에 세부정보 및 필수 정보를 제공하면 Google Cloud Apigee 지원팀에서 더 빠르고 효율적으로 응답하기가 쉽습니다. 지원 케이스에 중요한 세부정보가 누락되어 있으면 지원팀에서 여러 번 반복하여 정보를 요청할 수 있습니다. 이렇게 하면 시간이 오래 걸리고 문제 해결이 지연될 수 있습니다. 이 권장사항 가이드에서는 Google이 기술 지원 케이스를 빠르게 확인하는 데 필요한 정보를 설명합니다.

문제 설명

문제에는 예상 동작과 실제 동작의 차이와 언제 어떻게 발생했는지에 대한 세부정보를 설명하는 정보가 포함되어야 합니다. 올바른 Apigee 지원 케이스에는 각 Apigee 제품에 대한 다음과 같은 주요 정보가 포함되어야 합니다.

키 정보 설명 퍼블릭 클라우드용 Apigee Edge Private Cloud용 Apigee Edge
제품 문제가 관찰되는 특정 Apigee 제품(해당하는 경우 버전 정보 포함)
  • 버전
문제 세부정보 문제에 대한 명확하고 자세한 설명(오류 메시지가 있는 경우 포함)
  • 오류 메시지
  • trace 도구 출력
  • 문제를 재현하기 위한 단계
  • 전체 API 요청/명령어
  • 오류 메시지
  • trace 도구 출력
  • 문제를 재현하기 위한 단계
  • 전체 API 요청/명령어
  • 구성요소 진단 로그
시간 문제가 시작된 구체적인 타임스탬프 및 지속 시간
  • 문제가 발생한 날짜, 시간, 표준 시간대
  • 문제가 지속된 기간
  • 문제가 발생한 날짜, 시간, 표준 시간대
  • 문제가 지속된 기간
설정 문제가 관찰되는 자세한 정보
  • 조직 이름
  • 환경 이름
  • API 프록시 이름
  • 버전
  • 네트워크 토폴로지
  • 실패하는 Edge 구성요소

다음 섹션에서 이러한 개념을 보다 자세히 설명합니다.

제품

퍼블릭 클라우드용 Apigee Edge 및 프라이빗 클라우드용 Apigee Edge 등 다양한 Apigee 제품이 있으므로 문제가 발생하는 특정 제품에 대한 구체적인 정보가 필요합니다.

다음 표에서는 권장사항 열에 전체 정보를 보여주고 금지사항 열에 불완전한 정보를 보여주는 몇 가지 예시를 제공합니다.

권장사항 금지사항
퍼블릭 클라우드 조직에서 API 프록시 OAuth2 배포에 실패했습니다.

API 프록시 배포 실패

(Google에서는 문제가 발생한 Apigee 제품을 알아야 함)

Edge Private Cloud 버전 4.50.00에서 다음 오류로 인해 설치에 실패했습니다.

프라이빗 클라우드 설정에서 설치 실패

(버전 정보 누락)

문제 세부정보

오류 메시지(해당하는 경우)와 예상 동작 및 관찰된 실제 동작을 포함하여 관찰되는 문제에 대한 정확한 정보를 제공합니다.

다음 표에서는 권장사항 열에 전체 정보를 보여주고 금지사항 열에 불완전한 정보를 보여주는 몇 가지 예시를 제공합니다.

권장사항 금지사항

새 edgemicro 프록시 edgemicro_auth가 다음 오류와 함께 실패합니다.

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

오늘 만든 새 edgemicro 프록시가 작동하지 않음

(프록시 이름은 알 수 없습니다. 프록시가 오류를 반환하는지 또는 예기치 못한 응답을 반환하는지 명확하지 않습니다.)

API 프록시에 요청을 수행하는 동안 클라이언트에 다음 오류 메시지와 함께 500 오류가 발생합니다.

{"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 프록시에 요청을 수행하는 동안 클라이언트에 500 오류가 발생합니다.

(500 오류를 전달하는 것만으로는 문제를 조사하기에 충분한 정보가 제공되지 않습니다. 관찰되는 실제 오류 메시지와 오류 코드를 알아야 합니다.)

시간

시간은 매우 중요한 정보입니다. 지원 엔지니어는 이 문제를 처음 관찰한 시점, 지속된 시간, 현재 문제 지속 여부를 파악하는 것이 중요합니다.

이 문제를 해결하는 지원 엔지니어가 고객과 같은 시간대에 있지 않을 수 있으므로 시간에 대해 상대적 문구를 사용하면 문제를 진단하기가 더 어렵습니다. 따라서 날짜 및 시간 스탬프에 ISO 8601 형식을 사용하여 문제가 발견된 정확한 시간 정보를 제공하는 것이 좋습니다.

다음 표에서는 권장사항 열에 문제가 발생한 정확한 시간 및 기간을 보여주고 금지사항 열에 문제가 발생한 시기에 대해 모호하거나 분명하지 않은 정보를 보여주는 몇 가지 예시를 제공합니다.

권장사항 금지사항
어제 2020-11-06 17:30 PDT와 2020-11-06 17:35 PDT 사이에 대량의 503s가 관찰되었습니다.

대량의 503s이 어제 오후 5시 30분에 5분 동안 관찰되었습니다.

(암시적 날짜를 사용해야 하므로 이 문제가 관찰된 시간대를 알 수 없습니다.)

2020-11-09 15:30 IST와 2020-11-09 18:10 IST 사이에 다음 API 프록시에서 긴 지연시간이 관찰되었습니다.

지난주에 일부 API 프록시에서 긴 지연시간이 관찰되었습니다.

(지난주에 이 문제가 발생한 요일과 기간은 명확하지 않습니다.)

설정

정확히 어디에서 문제가 발생했는지에 대해 자세히 알아야 합니다. 사용 중인 제품에 따라 다음 정보가 필요합니다.

  • Apigee Cloud를 사용하는 경우 조직이 둘을 초과하여 있을 수 있으므로 문제를 관찰하는 특정 조직 및 기타 세부정보를 알아야 합니다.
    • 조직 및 환경 이름
    • API 프록시 이름 및 버전 번호(API 요청 실패의 경우)
  • 프라이빗 클라우드를 사용하는 경우 지원되는 여러 설치 토폴로지 중 하나를 사용할 수 있습니다. 따라서 Google에서는 데이터 센터 및 노드 수 같은 세부정보를 비롯해 사용 중인 토폴로지를 알아야 합니다.

다음 표에서는 권장사항 열에 전체 정보를 보여주고 금지사항 열에 불완전한 정보를 보여주는 몇 가지 예시를 제공합니다.

권장사항 금지사항

2020-11-06 09:30 CST 이후 Edge Public Cloud에서 401 오류가 증가했습니다.

Edge 설정 세부정보:

실패한 API의 세부정보는 다음과 같습니다.
  조직 이름: myorg
  환경 이름: test
   API 프록시 이름: 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 에서 메시지 프로세서를 시작할 수 없습니다.

(메시지 프로세서 로그와 네트워크 토폴로지가 누락되어 있습니다.)

유용한 아티팩트

문제와 관련된 아티팩트를 Google에 제공하면 해결 속도가 빨라집니다. 관찰하는 정확한 동작을 파악하여 더 많은 유용한 정보를 파악할 수 있기 때문입니다.

이 섹션에서는 모든 Apigee 제품에 유용한 몇 가지 유용한 아티팩트를 설명합니다.

모든 Apigee 제품의 일반 아티팩트

다음 아티팩트는 퍼블릭 클라우드용 Apigee Edge 및 프라이빗 클라우드용 Apigee Edge의 모든 Apigee 제품에 유용합니다.

아티팩트 설명
trace 도구 출력 trace 도구 출력에는 Apigee 제품을 통해 전송되는 API 요청에 대한 자세한 정보가 포함됩니다. 이는 4XX, 5XX, 지연 시간 문제와 같은 모든 런타임 오류에 유용합니다.
스크린샷 스크린샷은 실제 동작이나 관찰되는 오류의 컨텍스트를 릴레이하는 데 도움이 됩니다. UI 또는 애널리틱스와 같이 관찰된 모든 오류나 문제에 유용합니다.
HAR(Http ARchive) HAR은 모든 UI 관련 문제를 디버깅하기 위해 HTTP 세션 도구에서 캡처한 파일입니다. Chrome, Firefox, Internet Explorer 등의 브라우저를 사용하여 캡처할 수 있습니다.
tcpdumps tcpdump 도구는 네트워크를 통해 전송되거나 수신되는 TCP/IP 패킷을 캡처합니다. 이는 TLS 핸드셰이크 실패, 502 오류, 지연 시간 문제와 같은 네트워크 관련 문제에 유용합니다.

Private Cloud용 Apigee Edge의 추가 아티팩트

Private Cloud용 Apigee Edge의 경우 문제를 더 빨리 진단하는 데 도움이 되는 추가 아티팩트가 필요할 수 있습니다.

아티팩트 설명
네트워크 토폴로지 각 노드에 설치된 모든 데이터 센터, 노드, 구성요소를 포함한 프라이빗 클라우드 설정을 설명하는 Edge 설치 토폴로지 다이어그램입니다.
Edge 구성요소 진단 로그 메시지 프로세서, 라우터 또는 Cassandra와 같은 특정 Apigee Edge 구성요소와 관련된 진단 로그입니다.
설치 구성 파일 Apigee Edge를 설치하거나 업그레이드할 때 사용되는 무음 구성 파일입니다.

이 파일은 설치 또는 마이그레이션 문제가 발생하는 경우 모든 설정이 올바른지 확인하는 데 유용합니다.

힙 덤프 힙 덤프는 자바 메모리 프로세스의 스냅샷입니다. 이는 특정 Edge 구성요소에 많은 메모리 사용량 또는 OutOfMemory 오류가 발생하는 경우에 유용합니다.
스레드 덤프 스레드 덤프는 실행 중인 자바 프로세스의 모든 스레드에 대한 스냅샷입니다.

이는 특정 Edge 구성요소에서 고성능 CPU 또는 부하가 관찰되는 경우 유용합니다.

케이스 템플릿 및 샘플 케이스

이 섹션에서는 이 문서에 설명된 권장사항을 기반으로 다양한 제품의 케이스 템플릿 및 샘플 케이스를 제공합니다.

퍼블릭 클라우드의 Apigee Edge

템플릿

이 섹션에서는 퍼블릭 클라우드용 Apigee Edge용 샘플 템플릿을 제공합니다.

문제:

<고객 측에서 관찰되는 문제 또는 동작에 대한 자세한 설명을 제공합니다. 해당하는 경우 제품 이름 및 버전을 포함합니다.>

오류 메시지:

<확인된 전체 오류 메시지 포함(있는 경우)>

문제 시작 시간 (ISO 8601 형식):

문제 종료 시간 (ISO 8601 형식):

Apigee 설정 세부정보:
  조직 이름:
  환경 이름:
  API 프록시 이름:
  버전 번호:

재현 단계:

<가능한 경우 문제를 재현하기 위한 단계 제공>

진단 정보:

<첨부 파일 목록>

샘플 케이스

이 섹션에서는 Apigee Cloud(Google Cloud의 Apigee/Public Cloud의 Apigee Edge)용 샘플 케이스를 제공합니다.

문제:

퍼블릭 클라우드 조직에서 많은 수의 503 서비스를 사용할 수 없음 오류가 표시됩니다. 문제를 살펴보고 해결하거나 아니면 해결하는 방법에 대한 조언을 얻을 수 있나요?

오류 메시지:

{"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 프록시 이름: myproxy
  버전 번호: 3

재현 단계:

다음 curl 명령어를 실행하여 문제를 재현합니다.

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

진단 정보:

trace 도구 출력(trace-503.xml)

Private Cloud용 Apigee Edge

템플릿

이 섹션에서는 Private Cloud용 Apigee Edge의 샘플 템플릿을 제공합니다.

문제:

<고객 측에서 관찰되는 문제 또는 동작에 대한 자세한 설명을 제공합니다. 해당하는 경우 제품 이름 및 버전을 포함합니다.>

오류 메시지:

<확인된 전체 오류 메시지 포함(있는 경우)>

문제 시작 시간 (ISO 8601 형식):

문제 종료 시간 (ISO 8601 형식):

Edge Private Cloud 설정 세부정보:

<데이터 센터와 노드를 포함하여 프라이빗 클라우드의 설정을 설명하는 네트워크 토폴로지 연결>

재현 단계:

<가능한 경우 문제를 재현하기 위한 단계 제공>

진단 정보

<첨부 파일 목록>

샘플 케이스

이 섹션에서는 Private Cloud용 Apigee Edge의 샘플 케이스를 제공합니다.

문제:

Linux RHEL 7.6에서 Edge Private Cloud 4.19.06의 일부로 10번째 노드에 Apigee Management Server를 설치하는 도중에 다음 오류가 발생합니다.

오류 메시지:

<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