排查集成错误

Google Cloud 提供了各种工具,让您可以通过 Google Cloud Monitoring 来监控项目可靠性,以及通过 Google Cloud Logging 错误日志来调试问题。每当执行用户 intent 失败时,Google Home Analytics 流水线都会将该失败情况记入您的相应指标,并在项目日志中发布错误日志。

若要对错误进行问题排查,需要执行两个步骤:

  1. 通过智能家居指标监控项目的状态。
  2. 通过查看错误日志中的详细错误说明,对问题进行调查。

对于使用 Local Home SDK 的本地集成,流程也大体相同。掌握问题排查流程后,您可以轻松地在指标和日志之间来回切换,从而深入了解错误。

您还可以与其他用户共享您的 Action 来测试您的 Action。确保正确处理错误和异常

监控错误

您可以通过 Google Cloud Monitoring dashboard 来查看项目指标。下面的几个关键图表对于监控质量和调试尤为有用:

  • 监控项目可靠性时,首先应关注成功率图表。如果此图表中的指标下降,可能表示用户群中的部分用户或所有用户遇到了服务中断。我们建议您在每次项目发生更改或更新后密切监控此图表,看看是否有任何异常情况。
  • 第 95 个百分位延迟图表是衡量 Cloud-to-cloud 集成给用户的体验好坏的重要指标。如果此图表中突然出现波动,可能表示您的系统跟不上请求的速度。建议您定期查看此图表,看看是否有任何意外行为。
  • 在排查与集成相关的问题时,错误细分图表最为有用。针对成功百分比图表中突出显示的每个错误,错误细分图表中都会相应显示一个错误代码。您可以参阅下表,了解 Google Home platform 标记的错误以及相应的排查方法。

平台错误代码

以下是项目日志中的一些常见错误代码,用于识别 Google Home platform 捕获的问题。如需了解问题排查信息,请参阅下表。

错误代码 说明
BACKEND_FAILURE_URL_ERROR Google 从您的服务收到 HTTP 4xx 错误代码(而非 401)。

在 GCP Logging 中使用 requestId,以查看智能家居服务日志。
BACKEND_FAILURE_URL_TIMEOUT Google 的请求在尝试访问您的服务时超时。

请验证您的服务是否处于在线状态、是否接受连接,以及是否超出容量。此外,请确认目标设备已开机、处于在线状态且已同步。
BACKEND_FAILURE_URL_UNREACHABLE Google 从您的服务收到 HTTP 5xx 错误代码。

在 GCP Logging 中使用 requestId,以查看智能家居服务日志。
DEVICE_NOT_FOUND 合作伙伴服务端上不存在该设备。

这通常表示数据同步失败或存在争用情况。
GAL_BAD_3P_RESPONSE 由于载荷中的格式或值无效,Google 无法解析来自账号关联服务的响应。

在 GCP Logging 中使用 requestId,以查看您的账号关联服务中的错误日志。
GAL_INTERNAL Google 尝试检索访问令牌时发生 Google 内部错误。

如果您在 GCP Logging 中发现此错误的出现频率增加,请与我们联系以了解详情。
GAL_INVALID_ARGUMENT Google 尝试检索访问令牌时发生 Google 内部错误。

如果您在 GCP Logging 中发现此错误的出现频率增加,请与我们联系以了解详情。
GAL_NOT_FOUND 储存在 Google 的用户访问令牌和刷新令牌已失效,无法再刷新。用户需要重新关联账号,才能继续使用您的服务。

如果您在 GCP Logging 中发现此错误的出现频率增加,请与我们联系以了解详情。
GAL_PERMISSION_DENIED 令牌共享未获得授权时发生 Google 内部错误。

如果您在 GCP Logging 中发现此错误的出现频率增加,请与我们联系以了解详情。
GAL_REFRESH_IN_PROGRESS 用户的访问令牌已过期,而系统已经同时尝试再次对其进行刷新。

这不是问题,无需执行任何操作。
INVALID_AUTH_TOKEN Google 从您的服务收到 HTTP 401 错误代码。

访问令牌未过期,但您的服务已使其失效。 在 GCP Logging 中使用 requestId,以查看智能家居服务日志。
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 在响应中缺失。

确认您的 执行响应格式是否正确,响应中是否有与请求中的所有 intent 对应的结果。
PARTNER_RESPONSE_MISSING_DEVICE 请求中存在的一个或多个设备在响应中缺失。

确认您的 执行响应格式是否正确,响应中是否有请求中存在的所有设备 ID。
PARTNER_RESPONSE_MISSING_PAYLOAD 响应不包含 payload 字段。

请务必在请求响应中添加载荷字段。您可以详细了解如何正确构建 执行响应
PARTNER_RESPONSE_NOT_OBJECT 响应无法解析为 JSON 对象。

检查请求响应中的所有字段,看看是否有非预期的字符、括号不匹配或格式错误。系统可能不支持某些 Unicode 字符。此外,请确保您的响应采用了 JSON 对象的正确结构。
PROTOCOL_ERROR 无法处理请求。

在 Google Cloud Logging 中使用 requestId,以查看智能家居服务日志。
RESPONSE_TIMEOUT 请求在等待响应时发生超时。

发送响应的超时期限为自发出请求之时起 9 秒。请务必在此期限内发送回复。
RESPONSE_UNAVAILABLE 未收到响应,或者响应不指示状态。

对 intent 执行请求的响应应该采用符合 智能家居文档要求的结构,并且指示状态。
TRANSIENT_ERROR 暂时性错误是指会自行解决的错误。

最常见的表现形式是连接到设备或服务的连接中断。此外,如果无法打开与服务器的新连接。

搜索日志

当您能够熟练地利用指标监控集成后,接下来就是利用 Cloud Logging 对特定错误进行问题排查。错误日志是一个类似 JSON 的条目,其字段包含各种有用信息,例如时间、错误代码,以及关于原始智能家居 intent 的详细信息。

Google Cloud 中有多个系统始终会向您的项目发送日志。您需要编写用于过滤日志的查询,以查找所需的日志。查询可以基于时间范围、资源、日志严重级别或自定义条目。

查询云日志

您可以使用查询按钮来构建自定义过滤条件。

构建云日志查询

如需指定时间范围,请点击时间范围选择按钮 ,然后从提供的选项中选择一个。这样系统就会过滤日志,并显示所选时间范围内生成的日志。

若要指定资源,请点击资源下拉菜单,然后选择 Google 助理 Action 项目这样系统就会在您的查询中添加过滤条件,从而显示您的项目生成的日志。

使用严重级别按钮,按紧急信息调试和其他严重级别日志等级进行过滤。

您还可以使用 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 使用方法的用户指南,该指南会逐步指导您有效地对更改进行测试。

学习资源

本文档说明了对智能家居 Action 中的错误进行问题排查的步骤。您也可以查看我们的 Codelab,详细了解调试: