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

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

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

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

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

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

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

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

ผลิตภัณฑ์

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

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

สิ่งที่ควรทำ สิ่งที่ไม่ควรทำ
การติดตั้งใช้งาน API Proxy 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 จํานวนมากเมื่อวานนี้ระหว่าง 2020-11-06 17:30 PDT และ 2020-11-06 17:35 PDT...

พบ 503s จํานวนมากเมื่อวานนี้เวลา 17:30 น. เป็นเวลา 5 นาที

(เราจำเป็นต้องใช้วันที่โดยนัยและยังไม่แน่ใจว่าปัญหานี้เกิดขึ้นในเขตเวลาใด)

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

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

(ไม่แน่ใจว่าปัญหานี้เกิดขึ้นในวันไหนและระยะเวลาเท่าใดในสัปดาห์ที่ผ่านมา)

ตั้งค่า

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

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

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

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

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

รายละเอียดการตั้งค่า 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 มีข้อผิดพลาดเพิ่มขึ้น

(ไม่ระบุข้อมูลเกี่ยวกับผลิตภัณฑ์ที่ใช้ เวลาที่พบปัญหา หรือรายละเอียดการตั้งค่าใดๆ)

เริ่ม Message Processor ใน Edge Private Cloud เวอร์ชัน 4.19.06 ไม่ได้หลังจากเพิ่มโหนดเกตเวย์เพิ่มเติม

บันทึกการวินิจฉัย:
แนบบันทึกตัวประมวลผลข้อความแล้ว

โทโพโลยีเครือข่าย:
แนบไฟล์ network-topology.png ที่มีโหนดเพิ่มเติม

เริ่ม Message Processor ใน Edge Private Cloud เวอร์ชัน 4.19.06 ไม่ได้หลังจากเพิ่มโหนดเกตเวย์เพิ่มเติม

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

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

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

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

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

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

อาร์ติแฟกต์ คำอธิบาย
เอาต์พุตของเครื่องมือติดตาม เอาต์พุตของเครื่องมือการติดตามจะมีข้อมูลโดยละเอียดเกี่ยวกับคำขอ 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 ที่อธิบายการตั้งค่าระบบคลาวด์ส่วนตัว รวมถึงศูนย์ข้อมูล โหนด และคอมโพเนนต์ทั้งหมดที่ติดตั้งในโหนดแต่ละโหนด
บันทึกการวินิจฉัยคอมโพเนนต์ Edge บันทึกการวินิจฉัยที่เกี่ยวข้องกับคอมโพเนนต์ Apigee Edge ที่เฉพาะเจาะจง เช่น Message Processor, Router หรือ Cassandra
ไฟล์การกำหนดค่าการติดตั้ง ไฟล์การกําหนดค่าแบบเงียบที่ใช้เมื่อติดตั้งหรืออัปเกรด Apigee Edge

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

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

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

เทมเพลตเคสและเคสตัวอย่าง

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

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

เทมเพลต

ส่วนนี้แสดงตัวอย่างเทมเพลตสําหรับ Apigee Edge ในระบบคลาวด์สาธารณะ

ปัญหา:

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

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

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

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

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

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

ขั้นตอนในการทําให้เกิดปัญหาซ้ำ

<ระบุขั้นตอนในการสร้างปัญหาซ้ำ (หากเป็นไปได้)>

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

<List of files attached>

ตัวอย่างเคส

ส่วนนี้แสดงตัวอย่างเคสสำหรับ Apigee Cloud (Apigee ใน Google Cloud/Apigee Edge ใน Public Cloud)

ปัญหา:

เราพบข้อผิดพลาด 503 บริการไม่พร้อมใช้งานจํานวนมากใน Public Cloud Org โปรดตรวจสอบและแก้ไขปัญหานี้หรือแนะนำวิธีแก้ปัญหาให้เราทราบ

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

{"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-503.xml)

Apigee Edge สําหรับระบบคลาวด์ส่วนตัว

เทมเพลต

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

ปัญหา:

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

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

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

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

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

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

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

ขั้นตอนในการทําให้เกิดปัญหาซ้ำ

<ระบุขั้นตอนในการสร้างปัญหาซ้ำ (หากเป็นไปได้)>

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

<List of files attached>

ตัวอย่างเคส

ส่วนนี้แสดงตัวอย่างกรณีการใช้งานสำหรับ Apigee Edge สำหรับ Private Cloud

ปัญหา:

ขณะที่เราติดตั้งเซิร์ฟเวอร์การจัดการ Apigee ในโหนด #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