การแก้ปัญหาข้อผิดพลาดในการผสานรวมกรณี

refresh_date: 2023-01-06

Google Cloud มีเครื่องมือสำหรับตรวจสอบความน่าเชื่อถือของโปรเจ็กต์ด้วย Google Cloud Monitoring และแก้ไขข้อผิดพลาดด้วยGoogle Cloud Logging บันทึกข้อผิดพลาด เมื่อใดก็ตามที่เกิดความล้มเหลวเมื่อดำเนินการตามความต้องการของผู้ใช้ไปป์ไลน์ Google Home Analytics จะบันทึกความล้มเหลวนั้นไว้ในเมตริก และเผยแพร่บันทึกข้อผิดพลาดในบันทึกโปรเจ็กต์

การแก้ปัญหาข้อผิดพลาดมี 2 ขั้นตอนดังนี้

  1. ตรวจสอบสถานะของโปรเจ็กต์ด้วยเมตริกสมาร์ทโฮม
  2. ตรวจสอบปัญหาโดยดูคำอธิบายข้อผิดพลาดโดยละเอียดในบันทึกข้อผิดพลาด

ข้อผิดพลาดในการตรวจสอบ

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

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

รหัสข้อผิดพลาดของแพลตฟอร์ม

ต่อไปนี้คือรหัสข้อผิดพลาดทั่วไปที่คุณอาจเห็นในบันทึกของโปรเจ็กต์ เพื่อระบุปัญหาที่ Google Home platform ตรวจพบ โปรดดูข้อมูลการแก้ปัญหาในตารางต่อไปนี้

รหัสข้อผิดพลาด คำอธิบาย
BACKEND_FAILURE_URL_ERROR Google ได้รับรหัสข้อผิดพลาด HTTP 4xx ที่ไม่ใช่ 401 จากบริการของคุณ

ใช้ requestId ในการบันทึก GCP เพื่อตรวจสอบบันทึกบริการสมาร์ทโฮม
BACKEND_FAILURE_URL_TIMEOUT คำขอของ Google หมดเวลาขณะพยายามเข้าถึงบริการของคุณ

ตรวจสอบว่าบริการออนไลน์อยู่ ยอมรับการเชื่อมต่อ และไม่ได้ใช้งานเกินขีดจำกัด นอกจากนี้ ให้ตรวจสอบว่าอุปกรณ์เป้าหมายเปิดอยู่ ออนไลน์ และซิงค์แล้ว
BACKEND_FAILURE_URL_UNREACHABLE Google ได้รับรหัสข้อผิดพลาด HTTP 5xx จากบริการของคุณ

ใช้ requestId ในการบันทึก GCP เพื่อตรวจสอบบันทึกบริการสมาร์ทโฮม
DEVICE_NOT_FOUND ไม่มีอุปกรณ์ในฝั่งบริการของพาร์ทเนอร์

โดยปกติแล้วข้อผิดพลาดนี้บ่งชี้ว่าการซิงค์ข้อมูลไม่สําเร็จหรือมีเงื่อนไขการแข่งขัน
GAL_BAD_3P_RESPONSE Google แยกวิเคราะห์การตอบกลับจากบริการลิงก์บัญชีไม่ได้เนื่องจากรูปแบบหรือค่าในเพย์โหลดไม่ถูกต้อง

ใช้ requestId ในการบันทึก GCP เพื่อตรวจสอบบันทึกข้อผิดพลาดในบริการการลิงก์บัญชี
GAL_INTERNAL เกิดข้อผิดพลาดภายในของ Google เมื่อ Google พยายามดึงข้อมูลโทเค็นการเข้าถึง

หากคุณเห็นอัตราข้อผิดพลาดนี้เพิ่มขึ้นใน GCP Logging โปรดติดต่อเราเพื่อขอข้อมูลเพิ่มเติม
GAL_INVALID_ARGUMENT เกิดข้อผิดพลาดภายในของ Google เมื่อ Google พยายามดึงข้อมูลโทเค็นการเข้าถึง

หากคุณเห็นว่าอัตราการเกิดข้อผิดพลาดนี้เพิ่มขึ้นในการบันทึก GCP โปรดติดต่อเราเพื่อขอข้อมูลเพิ่มเติม
GAL_NOT_FOUND โทเค็นการเข้าถึงและโทเค็นการรีเฟรชของผู้ใช้ที่จัดเก็บไว้ใน Google จะใช้งานไม่ได้และรีเฟรชไม่ได้อีกต่อไป ผู้ใช้ต้องลิงก์บัญชีอีกครั้งเพื่อใช้บริการของคุณต่อไป

หากคุณเห็นว่าอัตราการเกิดข้อผิดพลาดนี้เพิ่มขึ้นในการบันทึก GCP โปรดติดต่อเราเพื่อขอข้อมูลเพิ่มเติม
GAL_PERMISSION_DENIED เกิดข้อผิดพลาดภายในของ Google เมื่อไม่มีการให้สิทธิ์การแชร์โทเค็น

หากคุณเห็นว่าอัตราการเกิดข้อผิดพลาดนี้เพิ่มขึ้นในการบันทึก GCP โปรดติดต่อเราเพื่อขอข้อมูลเพิ่มเติม
GAL_REFRESH_IN_PROGRESS โทเค็นการเข้าถึงของผู้ใช้หมดอายุแล้ว และมีการพยายามรีเฟรชโทเค็นพร้อมกันอีก

นี่ไม่ใช่ปัญหาและคุณไม่จำเป็นต้องดำเนินการใดๆ
INVALID_AUTH_TOKEN Google ได้รับรหัสข้อผิดพลาด HTTP 401 จากบริการของคุณ

โทเค็นเพื่อการเข้าถึงยังไม่หมดอายุ แต่บริการของคุณทำให้โทเค็นดังกล่าวใช้งานไม่ได้ ใช้ requestId ในบันทึกของ GCP เพื่อตรวจสอบบันทึกบริการสมาร์ทโฮม
INVALID_JSON แยกวิเคราะห์หรือทำความเข้าใจคำตอบ JSON ไม่ได้

ตรวจสอบโครงสร้างของการตอบกลับ JSON เพื่อหาไวยากรณ์ที่ไม่ถูกต้อง เช่น วงเล็บไม่ตรงกัน ไม่มีคอมมา อักขระไม่ถูกต้อง
OPEN_AUTH_FAILURE โทเค็นเพื่อการเข้าถึงของผู้ใช้หมดอายุและ Google รีเฟรชไม่ได้ หรือ Google ได้รับรหัสข้อผิดพลาด HTTP 401 จากบริการของคุณ

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

หากการตอบกลับคำขอระบุข้อผิดพลาด โปรดใช้ข้อผิดพลาดที่มาจาก รหัสข้อผิดพลาดที่รองรับ
PARTNER_RESPONSE_INVALID_PAYLOAD แยกวิเคราะห์ช่องการตอบกลับ payload เป็นออบเจ็กต์ JSON ไม่ได้

ตรวจสอบว่าช่องเพย์โหลดในการตอบกลับคำขอมีวงเล็บเหลี่ยมที่ตรงกันและมีโครงสร้างเป็นช่อง JSON อย่างถูกต้องหรือไม่
PARTNER_RESPONSE_INVALID_STATUS การตอบกลับไม่ได้ระบุสถานะ หรือระบุสถานะที่ไม่ถูกต้อง

การตอบสนองต่อคำขอการดำเนินการตาม Intent ควรระบุสถานะด้วย SUCCESS, OFFLINE, ERROR, EXCEPTIONS ดูข้อมูลเพิ่มเติมเกี่ยวกับ การจัดการข้อผิดพลาดและข้อยกเว้น
PARTNER_RESPONSE_MISSING_COMMANDS_AND_DEVICES ไม่มี Intent อย่างน้อย 1 รายการที่แสดงอยู่ในคำขอในการตอบกลับ

ยืนยันว่าการตอบกลับการดำเนินการของคุณมีโครงสร้างถูกต้องและผลการค้นหาสำหรับ Intent ทั้งหมดจากคำขอแสดงอยู่ในคำตอบ
PARTNER_RESPONSE_MISSING_DEVICE ไม่มีอุปกรณ์อย่างน้อย 1 เครื่องที่แสดงอยู่ในคำขอในการตอบกลับ

ตรวจสอบว่าคำตอบการเรียกใช้มีโครงสร้างถูกต้อง และมีรหัสอุปกรณ์ทั้งหมดจากคำขออยู่ในคำตอบ
PARTNER_RESPONSE_MISSING_PAYLOAD การตอบกลับไม่มีช่อง payload

ตรวจสอบว่าได้ใส่ฟิลด์เพย์โหลดในการตอบกลับคำขอ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีสร้างการตอบสนองการดําเนินการอย่างถูกต้อง
PARTNER_RESPONSE_NOT_OBJECT แยกวิเคราะห์คำตอบเป็นออบเจ็กต์ JSON ไม่ได้

ตรวจสอบทุกช่องในการตอบสนองคำขอเพื่อหาอักขระที่ไม่ต้องการ วงเล็บปีกกาที่ไม่ตรงกัน หรือข้อผิดพลาดในการจัดรูปแบบ ระบบอาจไม่รองรับอักขระ Unicode บางตัว และตรวจสอบว่าคำตอบมีโครงสร้างเป็นออบเจ็กต์ JSON อย่างถูกต้อง
PROTOCOL_ERROR ประมวลผลคำขอไม่สำเร็จ

ใช้ requestId ใน Google Cloud Logging เพื่อตรวจสอบบันทึกบริการสมาร์ทโฮม
RESPONSE_TIMEOUT คำขอหมดเวลาขณะรอการตอบกลับ

ระยะเวลาหมดเวลาในการส่งการตอบกลับคือ 9 วินาทีนับจากเวลาที่ส่งคำขอ โปรดส่งคำตอบภายในระยะเวลานี้
RESPONSE_UNAVAILABLE ไม่ได้รับการตอบกลับ หรือการตอบกลับไม่ได้ระบุสถานะ

การตอบกลับคำขอการดำเนินการตามเจตนาควรมีโครงสร้างตามเอกสารสมาร์ทโฮมและระบุสถานะ
TRANSIENT_ERROR ข้อผิดพลาดชั่วคราวคือข้อผิดพลาดที่จะแก้ไขได้เอง

โดยปกติแล้ว ข้อผิดพลาดเหล่านี้จะแสดงเป็นการเชื่อมต่อกับอุปกรณ์หรือบริการถูกตัด และหากเปิดการเชื่อมต่อใหม่กับเซิร์ฟเวอร์ไม่ได้

ข้อมูลบันทึกการค้นหา

เมื่อคุณคุ้นเคยกับการตรวจสอบการผสานรวมโดยใช้เมตริกแล้ว ขั้นตอนถัดไปคือการแก้ปัญหาข้อผิดพลาดที่เฉพาะเจาะจงโดยใช้ Cloud Logging บันทึกข้อผิดพลาดคือรายการที่คล้ายกับ JSON ซึ่งมีช่องที่มีข้อมูลที่เป็นประโยชน์ เช่น เวลา รหัสข้อผิดพลาด และรายละเอียดเกี่ยวกับความตั้งใจของสมาร์ทโฮมต้นทาง

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

ค้นหาบันทึกของระบบคลาวด์

คุณสามารถใช้ปุ่มการค้นหาเพื่อช่วยสร้างตัวกรองที่กำหนดเองได้

สร้างการค้นหาบันทึกในระบบคลาวด์

หากต้องการระบุช่วงเวลา ให้คลิกปุ่มการเลือกช่วงเวลา และเลือกตัวเลือกใดตัวเลือกหนึ่งที่มีให้ ซึ่งจะกรองบันทึกและแสดงบันทึกที่มีต้นทางในช่วงเวลาที่เลือก

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

ใช้ปุ่มความรุนแรงเพื่อกรองตามฉุกเฉิน ข้อมูล แก้ไขข้อบกพร่อง และระดับบันทึกความรุนแรงอื่นๆ

นอกจากนี้ คุณยังใช้ช่องข้อความค้นหาใน Logs Explorer เพื่อป้อนรายการที่กำหนดเองได้อีกด้วย เครื่องมือค้นหาที่ใช้โดยช่องนี้รองรับทั้งการค้นหาพื้นฐาน เช่น การจับคู่สตริง และการค้นหาประเภทขั้นสูงมากขึ้น ซึ่งรวมถึงตัวเปรียบเทียบ (<, >=, !=) และโอเปอเรเตอร์บูลีน (AND, OR, NOT)

ตัวอย่างเช่น รายการที่กำหนดเองด้านล่างจะแสดงข้อผิดพลาดที่มาจากประเภทอุปกรณ์ LIGHT

resource.type = "assistant_action_project" AND severity = ERROR AND jsonPayload.executionLog.executionResults.actionResults.device.deviceType = "LIGHT"

ไปที่คลังข้อความค้นหาเพื่อดูตัวอย่างเพิ่มเติมในการค้นหาบันทึกอย่างมีประสิทธิภาพ

การแก้ไขการทดสอบ

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

แหล่งข้อมูลการเรียนรู้

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

ก่อนหน้า
Cloud Logging ในกรณี