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

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

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

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

อธิบายปัญหา

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

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

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

ผลิตภัณฑ์

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 สำหรับการประทับเวลาวันที่และเวลา เพื่อให้ข้อมูลเวลาที่แน่นอนเมื่อพบปัญหา

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

สิ่งที่ควรทำ สิ่งที่ไม่ควรทำ
พบ503sจำนวนมากเมื่อวานนี้ระหว่าง 2020-11-06 17:30 PDT ถึง 2020-11-06 17:35 PDT...

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

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

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

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

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

ตั้งค่า

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

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

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

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

401 ข้อผิดพลาดเพิ่มขึ้นใน Edge Public Cloud ตั้งแต่ 2020-11-06 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 ไม่ได้หลังจาก เพิ่มโหนดเกตเวย์เพิ่มเติม

บันทึกการวินิจฉัย:
แนบบันทึกของ Message Processor

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

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

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

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

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

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

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

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

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

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

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

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

เทมเพลต

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

ปัญหา:

<Provide detailed description of the problem or the behaviour being observed at your end. โปรดระบุชื่อผลิตภัณฑ์และเวอร์ชัน (หากมี)>

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

<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 โปรดตรวจสอบปัญหาและแก้ไขหรือแนะนำวิธีแก้ไขให้เรา

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

{"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 สำหรับ Private Cloud

เทมเพลต

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

ปัญหา:

<Provide detailed description of the problem or the behaviour being observed at your end. โปรดระบุชื่อผลิตภัณฑ์และเวอร์ชัน (หากมี)>

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

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

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

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

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

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

ขั้นตอนในการสร้างข้อผิดพลาดซ้ำ

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

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

<List of files attached>

ตัวอย่างเคส

ส่วนนี้จะแสดงกรณีตัวอย่างสำหรับ 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