แนวทางปฏิบัติแนะนำสำหรับเคสขอรับความช่วยเหลือของ Google Cloud Apigee

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล

คุณกำลังดูเอกสารประกอบของ Apigee X
ดูเอกสารประกอบของ Apigee Edge

การระบุข้อมูลที่จำเป็นและรายละเอียดในเคสขอรับความช่วยเหลือจะช่วยให้ทีมสนับสนุนของ Google Cloud Apigee ตอบกลับคุณได้อย่างรวดเร็วและมีประสิทธิภาพได้ง่ายขึ้น เมื่อเคสขอรับความช่วยเหลือไม่มีรายละเอียดสำคัญ เราต้องขอข้อมูลเพิ่มเติม ซึ่งอาจต้องมีการสลับไปมาหลายครั้ง ซึ่งใช้เวลานานกว่าปกติและอาจส่งผลให้แก้ปัญหาล่าช้าได้ คู่มือแนวทางปฏิบัติแนะนำนี้จะช่วยให้คุณทราบข้อมูลที่จำเป็นต่อการแก้ไขเคสขอรับความช่วยเหลือด้านเทคนิคได้เร็วขึ้น

การอธิบายปัญหา

ปัญหาควรมีข้อมูลที่อธิบายรายละเอียดเกี่ยวกับสิ่งที่เกิดขึ้นเทียบกับสิ่งที่คาดว่าจะเกิดขึ้น รวมถึงเวลาและสาเหตุ กรณีการสนับสนุนของ Apigee ที่ดีควรมีข้อมูลสำคัญต่อไปนี้สำหรับผลิตภัณฑ์ Apigee แต่ละรายการ

ข้อมูลสำคัญ คำอธิบาย Apigee Edge สำหรับระบบคลาวด์สาธารณะ Apigee Edge สำหรับ Private Cloud
ผลิตภัณฑ์ ผลิตภัณฑ์ Apigee เฉพาะที่พบปัญหา รวมถึงข้อมูลเวอร์ชัน (หากมี)
  • เวอร์ชัน
รายละเอียดของปัญหา คำอธิบายปัญหาที่ชัดเจนและละเอียดซึ่งสรุปปัญหา รวมถึงข้อความแสดงข้อผิดพลาดที่สมบูรณ์ ถ้ามี
  • ข้อความแสดงข้อผิดพลาด
  • เอาต์พุตของเครื่องมือติดตาม
  • ขั้นตอนในการทำให้ปัญหาเกิดซ้ำ
  • ทำตามคำขอ/คำสั่ง API ให้เสร็จสมบูรณ์
  • ข้อความแสดงข้อผิดพลาด
  • เอาต์พุตของเครื่องมือติดตาม
  • ขั้นตอนในการทำให้ปัญหาเกิดซ้ำ
  • ทำตามคำขอ/คำสั่ง API ให้เสร็จสมบูรณ์
  • บันทึกการวินิจฉัยคอมโพเนนต์
เวลา การประทับเวลาที่แน่ชัดว่าปัญหาเริ่มเกิดขึ้นเมื่อใดและระยะเวลาเท่าใด
  • วันที่ เวลา และเขตเวลาที่เกิดปัญหา
  • ระยะเวลาของโจทย์
  • วันที่ เวลา และเขตเวลาที่เกิดปัญหา
  • ระยะเวลาของโจทย์
การตั้งค่า ข้อมูลโดยละเอียดที่พบปัญหา
  • ชื่อองค์กร
  • ชื่อ Env
  • ชื่อพร็อกซี API
  • การแก้ไข
  • โทโพโลยีเครือข่าย
  • คอมโพเนนต์ขอบที่ล้มเหลว

ส่วนต่อไปนี้จะอธิบายแนวคิดเหล่านี้อย่างละเอียดยิ่งขึ้น

ผลิตภัณฑ์

เรามีผลิตภัณฑ์ Apigee ที่แตกต่างกัน ได้แก่ Apigee Edge บน Public Cloud และ Apigee Edge ใน Private Cloud เราจึงต้องการข้อมูลที่เฉพาะเจาะจงว่าผลิตภัณฑ์ใดมีปัญหา

ตารางต่อไปนี้มีตัวอย่างบางส่วนที่แสดงข้อมูลที่ครบถ้วนในคอลัมน์สิ่งที่ควรทำ และข้อมูลที่ไม่สมบูรณ์ในคอลัมน์สิ่งที่ไม่ควรทำ

สิ่งที่ควรทำ สิ่งที่ไม่ควรทำ
การทำให้พร็อกซี API OAuth2 ใช้งานได้ไม่สำเร็จในองค์กร Public Cloud ...

การทำให้พร็อกซี API ใช้งานได้ล้มเหลว

(เราจำเป็นต้องทราบผลิตภัณฑ์ Apigee ที่คุณกำลังพบปัญหา)

การติดตั้งล้มเหลวเนื่องจากมีข้อผิดพลาดต่อไปนี้ใน Edge Private Cloud เวอร์ชัน 4.50.00 ...

ติดตั้งในการตั้งค่า Private Cloud ไม่สำเร็จ

(ไม่มีข้อมูลเวอร์ชัน)

รายละเอียดของปัญหา

ให้ข้อมูลที่ชัดเจนเกี่ยวกับปัญหาที่พบ รวมถึงข้อความแสดงข้อผิดพลาด (หากมี) ตลอดจนพฤติกรรมที่คาดไว้และการทำงานจริงที่พบ

ตารางต่อไปนี้มีตัวอย่างบางส่วนที่แสดงข้อมูลที่ครบถ้วนในคอลัมน์สิ่งที่ควรทำ และข้อมูลที่ไม่สมบูรณ์ในคอลัมน์สิ่งที่ไม่ควรทำ

สิ่งที่ควรทำ สิ่งที่ไม่ควรทำ

พร็อกซี edgemicro edgemicro_auth ใหม่ทำงานไม่สำเร็จ โดยมีข้อผิดพลาดต่อไปนี้

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

พร็อกซี edgemicro ที่สร้างใหม่ในวันนี้ไม่ทำงาน

(ไม่รู้จักชื่อพร็อกซี ไม่ชัดเจนว่าพร็อกซีแสดงข้อผิดพลาดหรือการตอบสนองที่ไม่คาดคิด)

ไคลเอ็นต์ของเราได้รับข้อผิดพลาด 500 รายการพร้อมด้วยข้อความแสดงข้อผิดพลาดต่อไปนี้ขณะส่งคำขอไปยังพร็อกซี 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"}}}

ไคลเอ็นต์ของเราได้รับข้อผิดพลาด 500 รายการขณะส่งคำขอไปยังพร็อกซี API

(การถ่ายทอดข้อผิดพลาด 500 เพียงอย่างเดียวไม่ได้ให้ข้อมูลที่เพียงพอสำหรับเราในการตรวจสอบปัญหา เราจำเป็นต้องทราบข้อความแสดงข้อผิดพลาดและรหัสข้อผิดพลาดที่พบจริงๆ)

เวลา

เวลาเป็นข้อมูลสำคัญมาก วิศวกรฝ่ายสนับสนุนควรทราบว่าคุณพบปัญหานี้ครั้งแรกเมื่อใด ใช้เวลานานเท่าไร และยังคงเกิดปัญหาอยู่ไหม

วิศวกรสนับสนุนที่แก้ไขปัญหาอาจไม่ได้อยู่ในเขตเวลาของคุณ ดังนั้น คำชี้แจงเกี่ยวกับเวลาแบบสัมพัทธ์จึงทำให้วินิจฉัยปัญหาได้ยากขึ้น เราจึงขอแนะนำให้ใช้รูปแบบ ISO 8601 สำหรับการประทับเวลาวันที่และเวลา เพื่อให้ข้อมูลเวลาที่แน่นอนที่พบปัญหา

ตารางต่อไปนี้มีตัวอย่างที่แสดงเวลาและระยะเวลาที่ปัญหาเกิดขึ้นในคอลัมน์สิ่งที่ควรทำอย่างถูกต้อง รวมถึงข้อมูลที่กำกวมหรือไม่ชัดเจนเกี่ยวกับเวลาที่เกิดปัญหาในคอลัมน์สิ่งที่ไม่ควรทำ

สิ่งที่ควรทำ สิ่งที่ไม่ควรทำ
เมื่อวานนี้มี 503s จำนวนมากที่สำรวจระหว่างวันที่ 06/11/2020 เวลา 17:30 น. ตามเขตเวลา PDT ถึงวันที่ 6/11/2020 เวลา 17:35 น. ตามเขตเวลา PDT...

เมื่อวานนี้มีผู้ชม 503s จำนวนมาก เวลา 17.30 น. เป็นเวลา 5 นาที

(เราถูกบังคับใช้วันที่ที่ระบุเป็นนัยและยังไม่ชัดเจนว่าเกิดปัญหานี้ในเขตเวลาใด)

พบเวลาในการตอบสนองสูงในพร็อกซี API ต่อไปนี้ตั้งแต่วันที่ 09-11-2020 15:30 IST ถึง 09-11-2020 18:10 IST ...

พบเวลาในการตอบสนองสูงในพร็อกซี API บางรายการในสัปดาห์ที่ผ่านมา

(เรายังไม่ทราบวันและระยะเวลาที่พบปัญหานี้ในสัปดาห์ที่ผ่านมา)

ตั้งค่า

เราจำเป็นต้องทราบรายละเอียดว่าคุณพบปัญหาที่ใด เราต้องการข้อมูลต่อไปนี้โดยขึ้นอยู่กับผลิตภัณฑ์ที่คุณใช้

  • หากคุณกำลังใช้ Apigee Cloud คุณอาจมีองค์กรมากกว่า 1 แห่ง เราจึงจำเป็นต้องทราบองค์กรที่เจาะจงและรายละเอียดอื่นๆ ที่คุณสังเกตเห็นปัญหา
    • ชื่อองค์กรและสภาพแวดล้อม
    • ชื่อพร็อกซี API และหมายเลขการแก้ไข (กรณีที่คำขอ API ล้มเหลว)
  • หากใช้ Private Cloud คุณอาจกำลังใช้โทโพโลยีการติดตั้งที่รองรับแบบใดแบบหนึ่งอยู่ ดังนั้นเราจึงจำเป็นต้องทราบว่าคุณใช้โทโพโลยีใดอยู่ รวมถึงรายละเอียดต่างๆ เช่น จำนวนศูนย์ข้อมูลและโหนด

ตารางต่อไปนี้มีตัวอย่างบางส่วนที่แสดงข้อมูลที่ครบถ้วนในคอลัมน์สิ่งที่ควรทำ และข้อมูลที่ไม่สมบูรณ์ในคอลัมน์สิ่งที่ไม่ควรทำ

สิ่งที่ควรทำ สิ่งที่ไม่ควรทำ

401 ข้อผิดพลาดเพิ่มขึ้นใน Edge Public Cloud นับตั้งแต่ 06/11/2020 09:30 CST

รายละเอียดการตั้งค่า Edge

รายละเอียดของ API ที่ล้มเหลวมีดังนี้
ชื่อองค์กร: myorg
ชื่อ Env: 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 ไม่ได้หลังจากที่เพิ่มโหนดเกตเวย์เพิ่มเติม

(ไม่มีบันทึกผู้ประมวลผลข้อความและโทโพโลยีเครือข่าย)

อาร์ติแฟกต์ที่มีประโยชน์

การส่งอาร์ติแฟกต์ที่เกี่ยวข้องกับปัญหาให้กับเราจะช่วยให้แก้ปัญหาได้เร็วขึ้น เนื่องจากช่วยให้เราเข้าใจลักษณะการทำงานที่แน่นอนที่คุณสังเกตและได้รับข้อมูลเชิงลึกเพิ่มเติม

ส่วนนี้จะอธิบายถึงอาร์ติแฟกต์ที่มีประโยชน์ต่อผลิตภัณฑ์ Apigee ทั้งหมด

อาร์ติแฟกต์ทั่วไปสำหรับผลิตภัณฑ์ Apigee ทั้งหมด

อาร์ติแฟกต์ต่อไปนี้มีประโยชน์สำหรับผลิตภัณฑ์ Apigee ทั้งหมด ได้แก่ Apigee Edge บน Public Cloud และ Apigee Edge บน Private Cloud

อาร์ติแฟกต์ คำอธิบาย
เอาต์พุตของเครื่องมือการติดตาม เอาต์พุตของเครื่องมือติดตามจะมีข้อมูลโดยละเอียดเกี่ยวกับคำขอ API ที่ไหลผ่านผลิตภัณฑ์ Apigee ซึ่งจะเป็นประโยชน์สำหรับข้อผิดพลาดด้านรันไทม์ เช่น 4XX, 5XX และปัญหาเกี่ยวกับเวลาในการตอบสนอง
ภาพหน้าจอ ภาพหน้าจอช่วยถ่ายทอดบริบทของลักษณะการทำงานจริงหรือข้อผิดพลาดที่พบ ซึ่งมีประโยชน์เมื่อพบข้อผิดพลาดหรือปัญหาที่พบ เช่น ใน UI หรือ Analytics
HAR (Http ARchive) HAR คือไฟล์ที่เครื่องมือเซสชัน HTTP บันทึกไว้เพื่อแก้ไขข้อบกพร่องใดๆ ที่เกี่ยวข้องกับ UI ซึ่งสามารถจับภาพได้โดยใช้เบราว์เซอร์ต่างๆ เช่น Chrome, Firefox หรือ Internet Explorer
tcpdumps เครื่องมือ tcpdump จะบันทึกแพ็กเก็ต TCP/IP ที่โอนหรือได้รับผ่านเครือข่าย ซึ่งจะเป็นประโยชน์สําหรับปัญหาที่เกี่ยวข้องกับเครือข่าย เช่น แฮนด์เชค TLS ไม่สําเร็จ, ข้อผิดพลาด 502 และปัญหาเกี่ยวกับเวลาในการตอบสนอง ฯลฯ

อาร์ติแฟกต์เพิ่มเติมของ Apigee Edge สำหรับ Private Cloud

สำหรับ Apigee Edge สำหรับ Private Cloud เราอาจต้องใช้อาร์ติแฟกต์เพิ่มเติมที่จะช่วยในการวินิจฉัยปัญหาได้เร็วขึ้น

อาร์ติแฟกต์ คำอธิบาย
โทโพโลยีเครือข่าย แผนภาพโทโพโลยีการติดตั้ง Edge ที่อธิบายการตั้งค่า Private Cloud รวมถึงศูนย์ข้อมูล โหนด และคอมโพเนนต์ทั้งหมดที่ติดตั้งในแต่ละโหนด
บันทึกการวินิจฉัยคอมโพเนนต์ Edge บันทึกเพื่อวินิจฉัยที่เกี่ยวข้องกับคอมโพเนนต์ Apigee Edge ที่เฉพาะเจาะจง เช่น ผู้ประมวลผลข้อมูลข้อความ, เราเตอร์ หรือ Cassandra
ไฟล์การกำหนดค่าการติดตั้ง ไฟล์การกำหนดค่าแบบปิดเสียงที่ใช้เมื่อติดตั้งหรืออัปเกรด Apigee Edge

ไฟล์นี้มีประโยชน์ในการตรวจสอบความถูกต้องของการตั้งค่าทั้งหมดในกรณีที่พบปัญหาการติดตั้งหรือการย้ายข้อมูล

ฮีพดัมพ์ ฮีพดัมพ์คือสแนปชอตของกระบวนการหน่วยความจำ Java ซึ่งจะเป็นประโยชน์หากเห็นการใช้งานหน่วยความจำสูงหรือข้อผิดพลาด OutOfMemory ในคอมโพเนนต์ Edge บางรายการ
ดัมพ์ชุดข้อความ เทรดดัมพ์คือสแนปชอตของเทรดทั้งหมดของกระบวนการ Java ที่ทำงานอยู่

ซึ่งจะเป็นประโยชน์ในกรณีที่พบ CPU หรือภาระงานสูงในคอมโพเนนต์ Edge บางรายการ

เทมเพลตกรณีและกรณีตัวอย่าง

ส่วนนี้จะแสดงเทมเพลตเคสและเคสตัวอย่างสำหรับผลิตภัณฑ์ต่างๆ ตามแนวทางปฏิบัติแนะนำที่อธิบายไว้ในเอกสารนี้

Apigee Edge บนระบบคลาวด์สาธารณะ

เทมเพลต

ส่วนนี้จะแสดงเทมเพลตตัวอย่างสำหรับ Apigee Edge บน Public Cloud

ปัญหา:

<ให้คำอธิบายโดยละเอียดของปัญหาหรือลักษณะการทำงานที่พบที่ฝั่งของคุณ ระบุชื่อและเวอร์ชันของผลิตภัณฑ์ (หากมี)>

ข้อความแสดงข้อผิดพลาด:

<ใส่ข้อความแสดงข้อผิดพลาดทั้งหมดที่สังเกตได้ (หากมี)>

เวลาเริ่มต้นของปัญหา (รูปแบบ ISO 8601):

เวลาสิ้นสุดของปัญหา (รูปแบบ ISO 8601):

รายละเอียดการตั้งค่า Apigee:
ชื่อองค์กร:
ชื่อ Env:
ชื่อพร็อกซี API:
หมายเลขการแก้ไข:

ขั้นตอนที่ทำให้เกิดปัญหาซ้ำมีดังนี้

<ระบุขั้นตอนที่จะทำให้ปัญหาเกิดซ้ำ>

ข้อมูลการวินิจฉัย:

<รายการไฟล์ที่แนบ>

กรณีตัวอย่าง

ส่วนนี้เป็นตัวอย่างกรณีสำหรับ Apigee Cloud (Apigee ใน Google Cloud/Apigee Edge บน Public Cloud)

ปัญหา:

เราพบข้อผิดพลาด 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
ชื่อ Env: dev
ชื่อพร็อกซี API: myproxy
หมายเลขการแก้ไข: 3

ขั้นตอนที่ทำให้เกิดปัญหาซ้ำมีดังนี้

เรียกใช้คำสั่ง curl ต่อไปนี้เพื่อจำลองการเกิดปัญหา

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

ข้อมูลการวินิจฉัย:

เอาต์พุตของเครื่องมือติดตาม (trace-503.xml)

Apigee Edge สำหรับ Private Cloud

เทมเพลต

ส่วนนี้จะแสดงเทมเพลตตัวอย่างสำหรับ Apigee Edge สำหรับ Private Cloud

ปัญหา:

<ให้คำอธิบายโดยละเอียดของปัญหาหรือลักษณะการทำงานที่พบที่ฝั่งของคุณ ระบุชื่อและเวอร์ชันของผลิตภัณฑ์ (หากมี)>

ข้อความแสดงข้อผิดพลาด:

<ใส่ข้อความแสดงข้อผิดพลาดทั้งหมดที่สังเกตได้ (หากมี)>

เวลาเริ่มต้นของปัญหา (รูปแบบ ISO 8601):

เวลาสิ้นสุดของปัญหา (รูปแบบ ISO 8601):

รายละเอียดการตั้งค่า Edge Private Cloud มีดังนี้

<แนบโทโพโลยีเครือข่ายที่อธิบายการตั้งค่า Private Cloud รวมถึงศูนย์ข้อมูลและโหนด>

ขั้นตอนที่ทำให้เกิดปัญหาซ้ำมีดังนี้

<ระบุขั้นตอนที่จะทำให้ปัญหาเกิดซ้ำ>

ข้อมูลการวินิจฉัย

<รายการไฟล์ที่แนบ>

กรณีตัวอย่าง

ส่วนนี้เป็นตัวอย่างกรณีของ Apigee Edge สำหรับ Private Cloud

ปัญหา:

ขณะที่เราติดตั้ง Apigee Management Server บนโหนด #10 โดยเป็นส่วนหนึ่งของ Edge Private Cloud 4.19.06 บน Linux RHEL 7.6 เราพบข้อผิดพลาดต่อไปนี้

ข้อความแสดงข้อผิดพลาด:

<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