IDT 使用情况指标 - FreeRTOS
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

IDT 使用情况指标

如果您提供具有所需权限的Amazon证书,则Amazon IoT Device Tester收集使用指标并将其提交给Amazon。这是一项可选功能,用于改进 IDT 功能。IDT 收集以下信息:

  • 用于运行 IDT 的Amazon账户 ID

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

  • 正在运行的测试套件

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

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

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

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

  • 产品功能已测试

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

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

要禁用指标收集,您无需采取其他措施。只需不存储您的Amazon凭证,如果您存储了Amazon证书,也不要配置config.jso n 文件来访问它们。

注册一个 Amazon Web Services 账户

如果您还没有 Amazon Web Services 账户,请完成以下步骤来创建一个。

注册 Amazon Web Services 账户
  1. 打开 https://portal.aws.amazon.com/billing/signup

  2. 按照屏幕上的说明进行操作。

    在注册时,您将接到一通电话,要求您使用电话键盘输入一个验证码。

    当您注册 Amazon Web Services 账户 时,系统将会创建一个 Amazon Web Services 账户根用户。根用户有权访问该账户中的所有 Amazon Web Services和资源。作为安全最佳实践,请 为管理用户分配管理访问权限,并且只使用根用户执行 需要根用户访问权限的任务

Amazon注册过程完成后,会向您发送一封确认电子邮件。在任何时候,您都可以通过转至 https://aws.amazon.com/ 并选择 My Account (我的账户) 来查看当前的账户活动并管理您的账户。

保护 IAM 用户

注册 Amazon Web Services 账户 后,启用多重身份验证(MFA)保护您的管理用户。有关说明,请参阅 IAM 用户指南中的为 为 IAM 用户(控制台)启用虚拟 MFA 设备

要授予其他用户访问您的 Amazon Web Services 账户 资源的权限,请创建 IAM 用户。为了保护您的 IAM 用户,请启用 MFA 并仅向 IAM 用户授予执行任务所需的权限。

有关创建和保护 IAM 用户的更多信息,请参阅 IAM 用户指南中的以下主题:

为 IDT 配置权限

在此步骤中,配置 IDT 用于运行测试和收集 IDT 使用数据的权限。您可以使用Amazon Web Services Management Console或Amazon Command Line Interface (Amazon CLI) 为 IDT 创建 IAM 策略和用户,然后将策略附加到该用户。

配置 IDT 的权限(控制台)

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

  1. 登录 IAM 控制台

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

    1. 在导航窗格中,选择 Policies (策略),然后选择 Create policy (创建策略)

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

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

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

    5. 选择 Create policy(创建策略)

  3. 创建 IAM 用户并向用户附加权限。

    1. 创建 IAM 用户。按照 IAM 用户指南中创建 IAM 用户(控制台)中的步骤 1 到 5 进行操作。如果您已创建 IAM 用户,请跳到下一步。

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

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

      2. 搜索您在上一步中创建的 IDTUsageMetrics IA M 策略搜索一下。选中复选框。

    3. 请选择下一步:标签

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

    5. 选择 Create user

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

为 IDT (Amazon CLI) 配置权限

按照以下步骤使用为 FreeRTOS 配置 IDT 的权限。Amazon CLI

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

    注意

    Amazon CLI是一种开源工具,您可以使用它与命令行 Shell 中的Amazon服务进行交互。

  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 用户并附加到 IDT 为 FreeRTOS 附加到的权限。

    1. 创建 IAM 用户。

      aws iam create-user -\-user-name user-name
    2. 将您创建的IDTUsageMetricsIAMPermissions策略附加到您的 IAM 用户。将用户名替换为您的 IAM 用户名,并将<account-id>命令中的用户名替换为您的Amazon账户 ID。

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

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

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

向 IDT 提供Amazon凭证

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

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

    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. 配置config.json文件auth部分。有关更多信息,请参阅 (可选)配置 config.json