IDT 用量指標 - FreeRTOS

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

IDT 用量指標

重要

這是 FreeRTOS 使用者指南的封存版本,可與 FreeRTOS 版本 202012.00 搭配使用。如需本文件的最新版本,請參閱 FreeRTOS 使用者指南

如果您提供具有必要許可的 AWS 登入資料, 會 AWS IoT Device Tester 收集並提交用量指標給 AWS。這是選擇加入功能,用於改善 IDT 功能。IDT 會收集下列資訊:

  • 用來執行 IDT AWS 的帳戶 ID

  • 用於執行測試的 IDT CLI 命令

  • 執行的測試套件

  • <device-tester-extract-location> 資料夾中的測試套件

  • 在裝置集區中設定的裝置數量

  • 測試案例名稱和執行時間

  • 測試結果資訊,例如測試是否通過、失敗、發生錯誤或被略過

  • 測試的產品功能

  • IDT 結束行為,例如非預期或提早結束

IDT 傳送的所有資訊也會記錄到 <device-tester-extract-location>/results/<execution-id>/ 資料夾中metrics.log的檔案。您可以檢視日誌檔案,以查看在測試執行期間收集的資訊。只有在您選擇收集用量指標時,才會產生此檔案。

若要停用指標集合,您不需要採取其他動作。只要不要存放您的 AWS 登入資料,而且如果您有存放的 AWS 登入資料,請勿設定 config.json 檔案來存取它們。

設定您的 AWS 登入資料

如果您還沒有 AWS 帳戶,則必須建立一個。如果您已經有 AWS 帳戶,您只需要為您的帳戶設定必要的許可,以允許 IDT AWS 代表您將用量指標傳送至 。

註冊 AWS 帳戶

如果您沒有 AWS 帳戶,請完成下列步驟來建立一個。

註冊 AWS 帳戶
  1. 開啟 https://portal.aws.amazon.com/billing/signup

  2. 請遵循線上指示進行。

    註冊程序的一部分包括接聽電話或文字訊息,以及在電話鍵盤上輸入驗證碼。

    當您註冊 時 AWS 帳戶,AWS 帳戶根使用者會建立 。根使用者有權存取該帳戶中的所有 AWS 服務 和資源。作為安全最佳實務,請將管理存取權指派給使用者,並且僅使用根使用者來執行需要根使用者存取權的任務

AWS 會在註冊程序完成後傳送確認電子郵件給您。您可以隨時登錄 https://aws.amazon.com/ 並選擇我的帳戶,以檢視您目前的帳戶活動並管理帳戶。

建立具有管理存取權的使用者

註冊 後 AWS 帳戶,請保護 AWS 帳戶根使用者、啟用 AWS IAM Identity Center和建立管理使用者,以免將根使用者用於日常任務。

保護您的 AWS 帳戶根使用者
  1. 選擇根使用者並輸入 AWS 帳戶 您的電子郵件地址,以帳戶擁有者AWS Management Console身分登入 。在下一頁中,輸入您的密碼。

    如需使用根使用者登入的說明,請參閱 AWS 登入 使用者指南中的以根使用者身分登入

  2. 若要在您的根使用者帳戶上啟用多重要素驗證 (MFA)。

    如需說明,請參閱《IAM 使用者指南》中的為您的 AWS 帳戶 根使用者 (主控台) 啟用虛擬 MFA 裝置

建立具有管理存取權的使用者
  1. 啟用 IAM Identity Center。

    如需指示,請參閱《AWS IAM Identity Center 使用者指南》中的啟用 AWS IAM Identity Center

  2. 在 IAM Identity Center 中,將管理存取權授予使用者。

    如需使用 IAM Identity Center 目錄 做為身分來源的教學課程,請參閱AWS IAM Identity Center 《 使用者指南》中的使用預設值設定使用者存取 IAM Identity Center 目錄

以具有管理存取權的使用者身分登入
  • 若要使用您的 IAM Identity Center 使用者簽署,請使用建立 IAM Identity Center 使用者時傳送至您電子郵件地址的簽署 URL。

    如需使用 IAM Identity Center 使用者登入的說明,請參閱AWS 登入 《 使用者指南》中的登入 AWS 存取入口網站

指派存取權給其他使用者
  1. 在 IAM Identity Center 中,建立一個許可集來遵循套用最低權限的最佳實務。

    如需指示,請參閱《AWS IAM Identity Center 使用者指南》中的建立許可集

  2. 將使用者指派至群組,然後對該群組指派單一登入存取權。

    如需指示,請參閱《AWS IAM Identity Center 使用者指南》中的新增群組

設定 IDT 的許可

在此步驟中,設定 IDT 用來執行測試和收集 IDT 用量資料的許可。您可以使用 AWS Management Console 或 AWS Command Line Interface (AWS CLI) 來建立 IAM 政策和 IDT 的使用者,然後將政策連接到使用者。

設定 IDT (主控台) 的許可

請依照下列步驟,使用 主控台來設定 IDT for FreeRTOS 的許可。

  1. 登入 IAM 主控台

  2. 建立客戶受管政策,該政策授與建立具有特定許可之角色的許可。

    1. 在導覽窗格中,選擇政策,然後選擇建立政策

    2. JSON 標籤上,用以下政策取代預留位置內容。

      { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iot-device-tester:SendMetrics" ], "Resource": "*" } ] }
    3. 選擇檢閱政策

    4. 對於名稱,輸入 IDTUsageMetricsIAMPermissions。在 Summary (摘要) 下,檢閱您的政策所授與的許可。

    5. 選擇建立政策

  3. 建立 IAM 使用者並將許可連接到使用者。

    若要提供存取權,請新增權限至您的使用者、群組或角色:

    • 中的使用者和群組 AWS IAM Identity Center:

      建立權限合集。請按照 AWS IAM Identity Center 使用者指南 中的 建立權限合集 說明進行操作。

    • 透過身分提供者在 IAM 中管理的使用者:

      建立聯合身分的角色。遵循「IAM 使用者指南」的為第三方身分提供者 (聯合) 建立角色中的指示。

    • IAM 使用者:

步驟 2:設定 IDT (AWS CLI) 的許可

請依照下列步驟使用 AWS CLI 來設定 IDT for FreeRTOS 的許可。

  1. 如果尚未安裝 ,請在電腦上安裝和設定 AWS CLI 。請遵循AWS Command Line Interface 《 使用者指南》中的安裝 AWS CLI 中的步驟。

    注意

    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 使用者並連接 IDT for FreeRTOS 所需的許可。

    1. 建立 IAM 使用者。

      aws iam create-user --user-name user-name
    2. 將您建立IDTUsageMetricsIAMPermissions的政策連接至 IAM 使用者。將 user-name 取代為您的 IAM 使用者名稱,並將 命令中的 <account-id> 取代為您 AWS 帳戶的 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

    將輸出儲存在安全的位置。您稍後會使用此資訊來設定您的 AWS 登入資料檔案。

提供 AWS 登入資料給 IDT

若要允許 IDT 存取您的 AWS 登入資料並提交指標 AWS,請執行下列動作:

  1. 將 IAM 使用者的 AWS 登入資料儲存為環境變數或儲存在登入資料檔案中:

    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