IDT 用量指标 - FreeRTOS
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

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

IDT 用量指标

如果您提供具有所需权限的 AWS 凭证,AWS IoT Device Tester 将收集用量指标并将其提交到 AWS。这是一项选择加入的功能,用于改进 IDT 功能。IDT 收集信息,如下所示:

  • 用于运行 IDT 的 AWS 账户 ID

  • 用于运行测试的 IDT CLI 命令

  • 运行的测试套件

  • 中的测试套件 <device-tester-extract-location> folder

  • 在设备池中配置的设备数

  • 测试用例名称和运行时间

  • 测试结果信息,例如是否通过、失败、遇到错误或跳过了测试

  • 测试的产品功能

  • IDT 退出行为,例如意外或提前退出

IDT 发送的所有信息也会记录到 metrics.log 文件夹中的 <device-tester-extract-location>/results/<execution-id>/ 文件。您可以查看日志文件,以查看在测试运行期间收集的信息。仅当您选择收集用量指标时,才会生成此文件。

要禁用指标收集,您无需采取额外的操作。仅仅不要存储您的 AWS 凭证,如果您有存储的 AWS 凭证,不要将 config.jso n 文件配置为访问它们。

配置 AWS 凭证

如果您还没有 AWS 账户,则必须创建一个。如果您已有 AWS 账户,则只需为允许 IDT 代表您向 发送用量指标的账户配置所需的权限AWS。

步骤 1:创建 AWS 账户

在此步骤中,将创建并配置 AWS 账户。如果您已有 AWS 账户,请跳到步骤 2:为 IDT 配置权限.

  1. 打开 AWS 主页,然后选择 Create an AWS Account (创建 AWS 账户).

    注意

    如果您最近已登录到 AWS,则您可能会看到 Sign In to the Console (登录到控制台)

  2. 按照屏幕上的说明进行操作。注册过程包括注册信用卡、接收短信或电话以及输入 PIN。

    有关更多信息,请参阅如何创建并激活新的 Amazon Web Services 账户?

步骤 2:为 IDT 配置权限

在此步骤中,配置 IDT 运行测试和收集 IDT 使用情况数据所用的权限。您可以使用 AWS 管理控制台或 AWS Command Line Interface (AWS CLI) 为 IDT 创建 IAM 策略和用户,然后将策略附加到用户。

为 IDT 配置权限(控制台)

请按照以下步骤使用控制台为适用于 的 IDT 配置权限。FreeRTOS.

  1. 登录到 IAM 控制台.

  2. 创建客户托管策略,该策略授权创建具有特定权限的角色。

    1. 在导航窗格中,选择策略,然后选择创建策略.

    2. JSON 选项卡上,将占位符内容替换为以下策略。

      { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iot-device-tester:SendMetrics" ], "Resource": "*" } ] }
    3. 选择查看策略.

    4. 对于 Name (名称),输入 IDTUsageMetricsIAMPermissions。 在 Summary (摘要) 下,查看策略授予的权限。

    5. 选择 Create policy.

  3. 创建 IAM 用户并将权限附加到该用户。

    1. 创建 IAM 用户。按照 https://docs.amazonaws.cn/IAM/latest/UserGuide/id_users_create.html#id_users_create_console创建 IAM 用户(控制台)IAM 用户指南中的步骤 1 到 5 操作。如果您已创建 IAM 用户,请跳到下一步。

    2. 将权限附加到您的 IAM 用户:

      1. Set permissions (设置权限) 页面上,选择 Attach existing policies to user directly (直接附加现有策略到用户).

      2. 搜索您在上一步中创建的 IDTUsageMetricsIAMPermissions 策略。选中复选框。

    3. 选择下一步: 标签.

    4. 选择 Next: Review (下一步: 审核) 以查看您的选择的摘要。

    5. 选择 Create user.

    6. 要查看用户的访问密钥(访问密钥 IDs 和秘密访问密钥),请选择密码和访问密钥旁边的 Show (显示)。要保存访问密钥,请选择 Download.csv 并将文件保存到安全位置。稍后您可以使用此信息配置 AWS 凭证文件。

为 IDT 配置权限 (AWS CLI)

请按照以下步骤使用 AWS CLI 为适用于 FreeRTOS. 的 IDT 配置权限。

  1. 在您的计算机上,安装并配置 AWS CLI(如果尚未安装)。按照 中的AWS CLI安装 中的步骤操作。AWS Command Line Interface 用户指南

    注意

    AWS CLI 是一个开源工具,您可以使用此工具通过命令行 Shell 与 AWS 服务进行交互。

  2. 创建以下客户托管策略,该策略授予管理 IDT 和 FreeRTOS 角色的权限。

    Linux, macOS, or Unix
    aws iam create-policy --policy-name IDTUsageMetricsIAMPermissions --policy-document '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iot-device-tester:SendMetrics" ], "Resource": "*" } ] }'
    Windows command prompt
    aws iam create-policy --policy-name IDTUsageMetricsIAMPermissions --policy-document '{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Action\": [\"iot-device-tester:SendMetrics\"], \"Resource": \"*\"}]}'
    注意

    此步骤包含一个 Windows 命令提示符示例,因为它使用的 JSON 语法与 Linux、macOS 或 Unix 终端命令不同。

  3. 创建 IAM 用户并附加适用于 FreeRTOS. 的 IDT 所需的权限。

    1. 创建 IAM 用户。

      aws iam create-user --user-name user-name
    2. 将您创建的 IDTUsageMetricsIAMPermissions 策略附加到 IAM 用户。Replace user-name 替换为您的 IAM 用户名和 <account-id> (位于包含您的 AWS 账户 ID 的命令中)。

      aws iam attach-user-policy --user-name user-name --policy-arn arn:aws-cn:iam::<account-id>:policy/IDTFreeRTOSIAMPermissions
  4. 为用户创建私密访问密钥。

    aws iam create-access-key --user-name user-name

    将输出存储在安全位置。稍后您可以使用此信息配置 AWS 凭证文件。

向 IDT 提供 AWS 凭证

要允许 IDT 访问您的 AWS 凭证并将指标提交到 AWS,请执行以下操作:

  1. 将 AWS 用户的 IAM 凭证存储为环境变量或存储在凭证文件中:

    1. 要使用环境变量,请运行以下命令:

      AWS_ACCESS_KEY_ID=access-key AWS_SECRET_ACCESS_KEY=secret-access-key
    2. 要使用凭证文件,请将以下信息添加到 .aws/credentials file:

      [profile-name] aws_access_key_id=access-key aws_secret_access_key=secret-access-key
  2. 配置 auth 文件的 config.json 部分。有关更多信息,请参阅 (可选)配置 config.json.