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

วันที่รีเฟรช: 06-01-2023

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 โปรดติดต่อเราเพื่อขอข้อมูลเพิ่มเติม
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 คำตอบไม่ได้ระบุสถานะ หรือระบุสถานะที่ไม่ถูกต้อง

การตอบสนองต่อคำขอ Fulfillment 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 ไม่ได้รับการตอบกลับหรือการตอบกลับไม่ได้ระบุสถานะ

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

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

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

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

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

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

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

สร้างการค้นหา Cloud Log

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

หากต้องการระบุทรัพยากร ให้คลิกเมนูแบบเลื่อนลงทรัพยากร แล้วเลือกโปรเจ็กต์การดำเนินการของ 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 เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับการแก้ไขข้อบกพร่องได้อีกด้วย