แนวทางปฏิบัติแนะนำสำหรับเคสขอรับความช่วยเหลือของ 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 ให้เสร็จสิ้น
  • บันทึกการวินิจฉัยคอมโพเนนต์
เวลา การประทับเวลาที่เจาะจงเมื่อปัญหาเริ่มขึ้นและระยะเวลาของปัญหา
  • วันที่ เวลา และเขตเวลาที่เกิดปัญหา
  • ระยะเวลาของปัญหา
  • วันที่ เวลา และเขตเวลาที่เกิดปัญหา
  • ระยะเวลาของปัญหา
การตั้งค่า ข้อมูลโดยละเอียดที่พบปัญหา
  • ชื่อองค์กร
  • ชื่อสภาพแวดล้อม
  • ชื่อพร็อกซี API
  • การแก้ไข
  • โทโพโลยีเครือข่าย
  • คอมโพเนนต์ Edge ล้มเหลว

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

ผลิตภัณฑ์

มีผลิตภัณฑ์ Apigee ที่แตกต่างกันหลายผลิตภัณฑ์ ซึ่งได้แก่ Apigee Edge บนระบบคลาวด์สาธารณะ และ 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 และ 2020-11-06 17:35 PDT...

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

(เราบังคับให้ใช้วันที่โดยนัย และยังไม่ชัดเจนในเขตเวลาใดของปัญหานี้ ได้สังเกตการณ์)

พบเวลาในการตอบสนองสูงในพร็อกซี API ต่อไปนี้ตั้งแต่วันที่ 09-11-2020 เวลา 15:30 น. IST ถึง 2020-11-09 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 บนระบบคลาวด์สาธารณะ และ 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 บนระบบคลาวด์สาธารณะ)

ปัญหา:

เราพบข้อผิดพลาด 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
ชื่อ 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 ในโหนด #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