フリートのメトリクスの管理

このトピックでは、[AWS IoTコンソールの使い方とAWS CLIフリートメトリクスの管理方法を説明します。

フリートメトリクスの管理 (コンソール)

以下のセクションは、フリートメトリクスを管理するための AWS IoT コンソールの使用方法について説明します。フリートメトリックスを作成する前に、関連するデータソースでフリートインデックス作成が有効になっていることを確認してください。

フリートインデックス作成を有効にする

フリートインデックス作成がすでに有効になっている場合は、このセクションをスキップしてください。

フリートのインデックス作成を有効にしていない場合は、次の手順に従ってください。

フリートメトリクスを作成します

作成に成功すると、[Fleet metric](フリートメトリクス)ページで、フリートメトリックスがリスト化されます。

フリートメトリクスを更新します

フリートメトリクスを削除する

フリートのメトリクスの管理 (CLI)

以下のセクションは、フリートメトリクスを管理するための AWS CLI の使用方法について説明します。フリートメトリックスを作成する前に、関連するデータソースでフリートインデックス作成が有効になっていることを確認してください。モノまたはモノのグループのフリートのインデックス作成を有効にするために、[Managing thing indexing](モノのインデックス化管理)または[Managing thing group indexing](モノのグループインデックス化管理)の手順に従ってください。

フリートメトリクスを作成します

フリートメトリクスを作成するには、create-fleet-metric CLI コマンドを使用できます。

aws iot create-fleet-metric --metric-name "YourFleetMetricName" --query-string "*" --period 60 --aggregation-field "registry.version" --aggregation-type name=Statistics,values=sum

このコマンドの出力には、フリートメトリクスの名前と Amazon リソースネーム (ARN) が含まれます。出力は次のようになります。

{
    "metricArn": "arn:aws:iot:us-east-1:111122223333:fleetmetric/YourFleetMetricName", 
    "metricName": "YourFleetMetricName"
}

フリートメトリクスを一覧表示します

list-fleet-metric CLI コマンドを使用して、アカウント内のすべてのフリートメトリクスを一覧表示できます。

aws iot list-fleet-metrics

このコマンドの出力には、すべてのフリートのメトリクスが含まれます。出力は次のようになります。

{
    "fleetMetrics": [
        {
            "metricArn": "arn:aws:iot:us-east-1:111122223333:fleetmetric/YourFleetMetric1", 
            "metricName": "YourFleetMetric1"
        }, 
        {
            "metricArn": "arn:aws:iot:us-east-1:111122223333:fleetmetric/YourFleetMetric2", 
            "metricName": "YourFleetMetric2"
        }
    ]
}

フリートのメトリクスを説明する

describe-fleet-metric CLI コマンドを使用して、フリートメトリクスに関するより詳細な情報を表示できます。

aws iot describe-fleet-metric --metric-name "YourFleetMetricName"

コマンドの出力には、指定されたフリートメトリクスに関する詳細情報が含まれます。出力は次のようになります。

{
    "queryVersion": "2017-09-30", 
    "lastModifiedDate": 1625790642.355, 
    "queryString": "*", 
    "period": 60, 
    "metricArn": "arn:aws:iot:us-east-1:111122223333:fleetmetric/YourFleetMetricName", 
    "aggregationField": "registry.version", 
    "version": 1, 
    "aggregationType": {
        "values": [
            "sum"
        ], 
        "name": "Statistics"
    }, 
    "indexName": "AWS_Things", 
    "creationDate": 1625790642.355, 
    "metricName": "YourFleetMetricName"
}

フリートメトリクスを更新します

フリートメトリクスを更新するには、update-fleet-metric CLI コマンドを使用できます。

aws iot update-fleet-metric --metric-name "YourFleetMetricName" --query-string "*" --period 120 --aggregation-field "registry.version" --aggregation-type name=Statistics,values=sum,count --index-name AWS_Things

update-fleet-メトリクスコマンドは、出力を生成しません。describe-fleet-メトリクス CLI コマンドを使用して、結果を表示できます。

{
    "queryVersion": "2017-09-30", 
    "lastModifiedDate": 1625792300.881, 
    "queryString": "*", 
    "period": 120, 
    "metricArn": "arn:aws:iot:us-east-1:111122223333:fleetmetric/YourFleetMetricName", 
    "aggregationField": "registry.version", 
    "version": 2, 
    "aggregationType": {
        "values": [
            "sum", 
            "count"
        ], 
        "name": "Statistics"
    }, 
    "indexName": "AWS_Things", 
    "creationDate": 1625792300.881, 
    "metricName": "YourFleetMetricName"
}

フリートメトリクスを削除する

delete-fleet-metric CLI コマンドを使用してフリートメトリクスを削除します。

aws iot delete-fleet-metric --metric-name "YourFleetMetricName"

このコマンドは、削除が成功した場合、または存在しないフリートメトリクスを指定した場合、出力を生成しません。

詳細については、「フリートメトリクスのトラブルシューティング」をご覧ください。

IoT リソースのタグ付けを承認する

作成、変更、または使用できるフリートメトリクスをより適切に制御するために、フリートメトリクスにタグをアタッチすることができます。

AWS Management Console または AWS CLI を使用して作成したフリートメトリクスにタグを付けるには、IAM ポリシーに iot:TagResource アクションを含めて、ユーザーにアクセス許可を付与する必要があります。IAM ポリシーに iot:TagResource が含まれていない場合、タグを使用してフリートメトリクスを作成するアクションは AccessDeniedException エラーを返します。

リソースへのタグ付けに関する一般情報については、「AWS IoT リソースのタグ付け」を参照してください。

IAM ポリシーの例

フリートメトリクスの作成時にタグ付けのアクセス許可を付与する IAM ポリシーの例を参照してください。

{
	"Version": "2012-10-17",
	"Statement": [
		{
			"Action": [
				"iot:TagResource"
			],
			"Effect": "Allow",
			"Resource": [
				"arn:aws:iot:*:*:fleetmetric/*"
			]
		},
		{
			"Action": [
				"iot:CreateFleetMetric"
			],
			"Effect": "Allow",
			"Resource": [
				"arn:aws:iot:*:*:index/*",
				"arn:aws:iot:*:*:fleetmetric/*"
			]
		}
	]
}

詳細については、「AWS IoT のアクション、リソース、および条件キー」を参照してください。