Submit IDT usage metrics
If you provide AWS credentials with required permissions, AWS IoT Device Tester collects and submits usage metrics to AWS. This is an opt-in feature and is used to improve IDT functionality. IDT collects information such as the following:
-
The AWS account ID used to run IDT
-
The IDT CLI commands used to run tests
-
The test suite that are run
-
The test suites in the
<device-tester-extract-location>folder -
The number of devices configured in the device pool
-
Test case names and run times
-
Test result information, such as whether tests passed, failed, encountered errors, or were skipped
-
Product features tested
-
IDT exit behavior, such as unexpected or early exits
All of the information that IDT sends is also logged to a
metrics.log file in the
<device-tester-extract-location>/results/<execution-id>/
To disable metrics collection, you do not need to take additional action. Simply
do not store your AWS credentials, and if you do have stored AWS credentials, do
not configure the config.json file to access them.
Sign up for an AWS account
To get started with AWS, you need an AWS account. For information about creating an AWS account, see Getting started with an AWS account in the AWS Account Management Reference Guide.
To provide access, add permissions to your users, groups, or roles:
-
Users and groups in AWS IAM Identity Center:
Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide.
-
Users managed in IAM through an identity provider:
Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide.
-
IAM users:
-
Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide.
-
(Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide.
-
Provide AWS credentials to IDT
To allow IDT to access your AWS credentials and submit metrics to AWS, do the following:
-
Store the AWS credentials for your IAM user as environment variables or in a credentials file:
-
To use environment variables, run the following command:
AWS_ACCESS_KEY_ID=access-keyAWS_SECRET_ACCESS_KEY=secret-access-key -
To use the credentials file, add the following information to the
.aws/credentials file:[profile-name] aws_access_key_id=access-keyaws_secret_access_key=secret-access-key
-
-
Configure the
authsection of theconfig.jsonfile. For more information, see (Optional) Configure config.json.
