对 IDT 进行故障排除Amazon IoT GreengrassV2 - Amazon IoT Greengrass
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

对 IDT 进行故障排除Amazon IoT GreengrassV2

同义词Amazon IoT GreengrassV2 根据错误的类型将错误写入不同位置。IDT 将错误写入控制台、日志文件和测试报告。

在哪里寻找错误

测试运行时,控制台上会显示高级错误,当所有测试完成后,会显示失败测试的摘要。awsiotdevicetester_report.xml包含导致测试失败的所有错误的摘要。IDT 将每次测试运行的日志文件存储在带有测试执行的 UUID 的目录中,测试运行期间显示在控制台上。

IDT 测试日志目录是<device-tester-extract-location>/results/<execution-id>/logs/。此目录包含表格中显示的以下文件。这对于调试非常有用。

文件 描述
test_manager.log

测试运行时写入控制台的日志。此文件末尾的结果摘要包括了哪些测试失败的列表。

此文件中的警告和错误日志可以为您提供有关失败的一些信息。

test-group-id/test-case-id/test-name.log 测试组中特定测试的详细日志。对于部署 Greengrass 组件的测试,测试用例日志文件被称为greengrass-test-run.log
test-group-id/test-case-id/greengrass.log 的详细日志Amazon IoT Greengrass核心软件。IDT 在运行安装测试时会从被测设备复制此文件Amazon IoT Greengrass设备上的核心软件。有关此日志文件中消息的更多信息,请参阅故障排除 Amazon IoT Greengrass V2
test-group-id/test-case-id/component-name.log 测试运行期间部署的 Greengrass 组件的详细日志。IDT 在运行部署特定组件的测试时,会从被测设备复制组件日志文件。每个组件日志文件的名称对应于已部署组件的名称。有关此日志文件中消息的更多信息,请参阅故障排除 Amazon IoT Greengrass V2

正在解决 IDTAmazon IoT GreengrassV2 错误

在你运行 IDT 之前Amazon IoT Greengrass,获取正确的配置文件。如果您收到解析和配置错误,则第一步是找到并使用适合您环境的配置模板。

如果仍有问题,请参阅以下调试过程。

别名解析错误

运行自定义测试套件时,您可能会在控制台和中看到以下错误test_manager.log

Couldn't resolve placeholders: couldn't do a json lookup: index out of range

当 IDT 测试协调器中配置的别名无法正确解析或者配置文件中不存在已解析的值时,就会发生此错误。要解决此错误,请确保您的device.jsonuserdata.json 包含您的测试套件所需的正确信息。有关所需配置的信息Amazon IoT Greengrass资格,请参阅配置 IDT 设置以运行 Amazon IoT Greengrass 资格套件

冲突错误

运行时可能会看到以下错误Amazon IoT Greengrass在多台设备上同时使用资格套件。

ConflictException: Component [com.example.IDTHelloWorld : 1.0.0] for account [account-id] already exists with state: [DEPLOYABLE] { RespMetadata: { StatusCode: 409, RequestID: “id” }, Message_: “Component [com.example.IDTHelloWorld : 1.0.0] for account [account-id] already exists with state: [DEPLOYABLE]” }

尚不支持并行测试执行Amazon IoT Greengrass资格套件。按顺序为每台设备运行资格套件。

无法启动测试错误

您可能会遇到错误,这些错误指向测试尝试开始时发生的故障。有几种可能的原因,因此,请执行以下操作:

  • 确保执行命令中的池名称确实存在。IDT 直接引用您的 pool 名称device.json文件。

  • 确保池中的设备具有正确的配置参数。

Docker 资格镜像存在错误

Docker 应用程序管理器资格测试使用amazon/amazon-ec2-metadata-mockAmazon ECR 中的容器镜像,用于验证被测设备。

如果镜像已存在于被测设备上的 Docker 容器中,则可能会收到以下错误。

The Docker image amazon/amazon-ec2-metadata-mock:version already exists on the device.

如果你之前下载了这张图片并运行了amazon/amazon-ec2-metadata-mock设备上的容器,在运行资格测试之前,请务必从被测设备中移除此映像。

读取凭证失败

在测试 Windows 设备时,你可能会遇到Failed to read credential里面有错误greengrass.log如果未在该设备的凭据管理器中设置您用来连接被测设备的用户,则为该文件。

要解决此错误,请在被测设备的凭据管理器中配置 IDT 用户的用户名和密码。

有关更多信息,请参阅为 Windows 设备配置用户凭证

Guice 错误与 PreInstalled Greengrass

使用 IDT 运行时 PreInstalled Greengrass,如果你遇到的错误是Guice要么ErrorInCustomProvider,检查文件是否userdata.jsonInstalledDirRootOnDevice设置为 Greengrass 安装文件夹。IDT 正在检查文件effectiveConfig.yaml<InstallationDirRootOnDevice>/config/effectiveConfig.yaml

有关更多信息,请参阅为 Windows 设备配置用户凭证

签名异常无效

在运行 Lambda 资格测试时,您可能会遇到invalidsignatureexception如果您的 IDT 主机遇到网络访问问题,则会出错。重置路由器并再次运行测试。

机器学习资格错误

在运行机器学习 (ML) 资格测试时,如果您的设备不满足,则可能会遇到资格认证失败要求部署Amazon-提供了 ML 组件。要对 ML 资格错误进行故障排除,请执行以下操作:

  • 在组件日志中查找测试运行期间部署的组件的错误详细信息。组件日志位于<device-tester-extract-location>/results/<execution-id>/logs/<test-group-id>目录。

  • 添加-Dgg.persist=installed.software争论test.json失败的测试用例的文件。的test.json文件位于<device-tester-extract-location>/tests/GGV2Q_version directory.

开放测试框架 (OTF) 部署失败

如果 OTF 测试未能完成部署,则可能的原因可能是为的父文件夹设置了权限TempResourcesDirOnDeviceInstallationDirRootOnDevice。要正确设置此文件夹的权限,请运行以下命令。替换folder-name使用父文件夹的名称。

sudo chmod 755 folder-name

解析错误

JSON 配置中的错别字可能导致解析错误。大部分情况下,问题是因 JSON 文件中漏掉括号、逗号或引号所导致。IDT 执行 JSON 验证并输入调试信息。它输出发生错误的行、行号以及语法错误的列号。这些信息应该足以帮助您修复错误,但是如果您仍然找不到错误,则可以在IDE、Atom或Sublime等文本编辑器中或通过jsonLint之类的在线工具手动进行验证。

权限被拒绝错误

IDT 将对所测试设备中的各种目录和文件执行操作。其中一些操作需要根用户访问权限。要自动执行这些操作,IDT 必须能够在不键入密码的情况下使用 sudo 运行命令。

请按照以下步骤操作,以允许在不键入密码的情况下进行 sudo 访问。

注意

userusername 是指 IDT 用来访问所测试设备的 SSH 用户。

  1. 使用 sudo usermod -aG sudo <ssh-username> 将 SSH 用户添加到 sudo 组。

  2. 注销,然后重新登录,以使更改生效。

  3. 打开 /etc/sudoers 文件,并将以下行添加到文件末尾:<ssh-username> ALL=(ALL) NOPASSWD: ALL

    注意

    作为最佳实践,我们建议您在编辑 /etc/sudoers 时使用 sudo visudo

资格报告生成错误

IDT 支持四种最新版本major.minor的版本Amazon IoT GreengrassV2 资格套件 (GGV2Q),用于生成资格报告,您可以将其提交给Amazon Partner Network将您的设备包含在Amazon Partner设备目录。早期版本的资格认证套件不生成资格报告。

如果您对支持政策有疑问,请联系Amazon Web Services Support

缺少必需参数错误

当 IDT 添加新功能时,它可能会对配置文件进行更改。使用旧配置文件可能会破坏您的配置。如果出现这种情况,/results/<execution-id>/logs 下的 <test_case_id>.log 文件明确列出了所有缺少的参数。IDT 还会验证您的 JSON 配置文件架构,以验证您使用的是最新的支持版本。

macOS 上的安全异常

当你在 macOS 主机上运行 IDT 时,它会阻止 IDT 的运行。要运行 IDT,请为作为 IDT 运行时功能一部分的可执行文件授予安全例外。当您在主机上看到警告消息显示时,请对每个适用的可执行文件执行以下操作:

向 IDT 可执行文件授予安全例外

  1. 在 macOS 电脑上,在苹果菜单上,打开系统偏好设置

  2. 选择安全与隐私,然后在普通的选项卡上,选择锁定图标以更改安全设置。

  3. 如果被封锁devicetester_mac_x86-64,寻找消息"devicetester_mac_x86-64" was blocked from use because it is not from an identified developer.然后选择无论如何都允许

  4. 恢复 IDT 测试,直到完成所有涉及的可执行文件。

SSH 连接错误

当 IDT 无法连接到被测设备时,它会将连接失败记录在/results/<execution-id>/logs/<test-case-id>.log。SSH 消息出现在该日志文件的顶部,因为连接到被测设备是 IDT 执行的第一批操作之一。

大多数 Windows 配置使用 PuTTY 终端应用程序连接到 Linux 主机。此应用程序要求您将标准 PEM 私钥文件转换为名为 PPK 的 Windows 专有格式。如果你在你的 SSH 中配置device.json文件,使用 PEM 文件。如果您使用 PPK 文件,IDT 将无法与 PPK 文件创建 SSH 连接Amazon IoT Greengrass设备且无法运行测试。

从 IDT v4.4.0 开始,如果您尚未在被测设备上启用 SFTP,则可能会在日志文件中看到以下错误。

SSH connection failed with EOF

要解决此错误,请在您的设备上启用 SFTP。

直播管理员资格错误

运行直播管理员资格测试时,您可能会在中看到以下错误com.aws.StreamManagerExport.log文件。

Failed to upload data to S3

当直播管理器使用时,可能会发生此错误Amazon中的凭证~/root/.aws/credentials在您的设备上归档,而不是使用 IDT 导出到被测设备的环境凭证。要防止出现此问题,请删除credentials在您的设备上归档,然后重新运行资格测试。

超时错误

您可以通过指定应用于每个测试超时默认值的超时乘数来增加每个测试的超时时间。为此标志配置的任何值都必须大于或等于 1.0。

要使用超时乘数,请在运行测试时使用标志 --timeout-multiplier。例如:

./devicetester_linux run-suite --suite-id GGV2Q_1.0.0 --pool-id DevicePool1 --timeout-multiplier 2.5

有关更多信息,请运行 run-suite --help

由于配置问题而无法完成 IDT 测试用例时,会出现一些超时错误。您无法通过增加超时乘数来解决这些错误。使用测试运行的日志来解决底层的配置问题。

  • 如果 MQTT 或 Lambda 组件日志包含Access denied错误,您的 Greengrass 安装文件夹可能没有正确的文件权限。对您在安装路径中定义的每个文件夹运行以下命令userdata.json文件。

    sudo chmod 755 folder-name
  • 如果 Greengrass 日志显示 Greengrass CLI 部署尚未完成,请执行以下操作:

    • 验证一下bash安装在被测设备上。

    • 如果你的userdata.json文件包含GreengrassCliVersion配置参数,将其删除。在 IDT v4.1.0 及更高版本中,此参数已被弃用。有关更多信息,请参阅配置 userdata.json

  • 如果 Lambda 部署测试失败并显示错误消息 “验证 Lambda 发布:超时”,并且您在测试日志文件中收到错误 (idt-gg2-lambda-function-idt-<resource-id>.log) 上面写着Error: Could not find or load main class com.amazonaws.greengrass.runtime.LambdaRuntime.,请执行以下操作:

    • 验证使用了什么文件夹InstallationDirRootOnDeviceuserdata.json文件。

    • 确保在您的设备上设置了正确的用户权限。有关更多详细信息,请参阅在您的设备上配置用户权限

版本检查错误

IDT 在以下情况下会发出以下错误AmazonIDT 用户的用户证书没有所需的 IAM 权限。

Failed to check version compatibility

的Amazon没有所需的 IAM 权限的用户。