AWS IoT Greengrass Version 1 は 2023 年 6 月 30 日に延長ライフフェーズに参加しました。詳細については、「AWS IoT Greengrass V1 メンテナンスポリシー」を参照してください。この日以降、 AWS IoT Greengrass V1 は機能、機能強化、バグ修正、またはセキュリティパッチを提供する更新をリリースしません。で実行されるデバイスは中断 AWS IoT Greengrass V1 されず、引き続き動作し、クラウドに接続します。に移行することを強くお勧めします。 AWS IoT Greengrass Version 2これにより、重要な新機能が追加され、プラットフォーム のサポートが追加されます。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CloudWatch メトリクスコネクタ

CloudWatch メトリクスコネクタは、Greengrass デバイスから Amazon にカスタムメトリクスを発行します CloudWatch。コネクタは、 CloudWatch メトリクスを公開するための一元化されたインフラストラクチャを提供します。これを使用して、Greengrass コア環境のモニタリングと分析を行い、ローカルイベントに対応できます。詳細については、「Amazon ユーザーガイド」の「Amazon CloudWatch メトリクスの使用」を参照してください。 CloudWatch

このコネクタには MQTT メッセージとしてメトリクスデータが送信されます。コネクタは、同じ名前空間にあるメトリクスをバッチ処理し、 CloudWatch 一定の間隔で に発行します。

このコネクタには、次のバージョンがあります。

バージョンの変更については、「Changelog」を参照してください。

要件

このコネクタには以下の要件があります。

Version 3 - 5

• AWS IoT Greengrass Core ソフトウェア v1.9.3 以降。

• Python バージョン 3.7 または 3.8 が Core デバイスにインストールされ、PATH 環境変数に追加されている。

  注記

  Python 3.8 を使用するには、次のコマンドを実行して、Python 3.7 のデフォルトのインストールフォルダからインストール済みの Python 3.8 バイナリへのシンボリックリンクを作成します。

  sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7

  これにより、AWS IoT Greengrass の Python 要件を満たすようにデバイスが設定されます。

• 以下の例に示すように、cloudwatch:PutMetricData アクションを許可する Greengrass グループロールに AWS Identity and Access Management (IAM) ポリシーが追加されている。

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "Stmt1528133056761",
              "Action": [
                  "cloudwatch:PutMetricData"
              ],
              "Effect": "Allow",
              "Resource": "*"
          }
      ]
  }

  グループロール要件では、必要なアクセス許可を付与するようにロールを設定し、ロールがグループに追加されていることを確認する必要があります。詳細については、Greengrass グループロールの管理 (コンソール)またはGreengrass グループロールの管理 (CLI)を参照してください。

  アクセス CloudWatch 許可の詳細については、「IAM ユーザーガイド」の「Amazon アクセス CloudWatch 許可リファレンス」を参照してください。

Versions 1 - 2

• AWS IoT Greengrass Core ソフトウェア v1.7 以降。

• Python バージョン 2.7 が Core デバイスにインストールされ、PATH 環境変数に追加されている。

• 以下の例に示すように、cloudwatch:PutMetricData アクションを許可する Greengrass グループロールに AWS Identity and Access Management (IAM) ポリシーが追加されている。

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "Stmt1528133056761",
              "Action": [
                  "cloudwatch:PutMetricData"
              ],
              "Effect": "Allow",
              "Resource": "*"
          }
      ]
  }

  グループロール要件では、必要なアクセス許可を付与するようにロールを設定し、ロールがグループに追加されていることを確認する必要があります。詳細については、Greengrass グループロールの管理 (コンソール)またはGreengrass グループロールの管理 (CLI)を参照してください。

  アクセス CloudWatch 許可の詳細については、「IAM ユーザーガイド」の「Amazon アクセス CloudWatch 許可リファレンス」を参照してください。

コネクタパラメータ

このコネクタには、以下のパラメータが用意されています。

Versions 4 - 5

PublishInterval

特定の名前空間のメトリクスのバッチを発行するまでに待機する最大秒数。最大の値は 900 です。メトリクスを受信時にバッチにまとめないで発行するようにコネクタを設定するには、0 を指定します。

コネクタは、同じ名前空間で 20 個のメトリクスを受信 CloudWatch した後、または指定された間隔後に に発行します。

注記

コネクタでは、発行イベントの順序は保証されません。

AWS IoT コンソールでの表示名: [Publish interval] (発行間隔)

必須: true

タイプ: string

有効な値: 0 - 900

有効なパターン: [0-9]|[1-9]\d|[1-9]\d\d|900

PublishRegion

CloudWatch メトリクスAWS リージョンを投稿する 。この値は、デフォルトの Greengrass メトリクスリージョンを上書きします。クロスリージョンメトリクスをポストする場合にのみ必要です。

AWS IoT コンソールでの表示名: [Publish region] (発行リージョン)

必須: false

タイプ: string

有効なパターン: ^$|([a-z]{2}-[a-z]+-\d{1})

MemorySize

コネクタに割り当てるメモリ (KB 単位)。

AWS IoT コンソールでの表示名: [Memory size] (メモリサイズ)

必須: true

タイプ: string

有効なパターン: ^[0-9]+$

MaxMetricsToRetain

新しいメトリクスで置き換えられるまでにメモリに保存する、名前空間全体のメトリクスの最大数。最小値は 2000 です。

この制限は、インターネットへの接続がなく、コネクタが後で発行するメトリクスをバッファし始めるときに適用されます。バッファが満杯になると、最も古いメトリクスが新しいメトリクスに置き換えられます。特定の名前空間内のメトリクスは、同じ名前空間内のメトリクスでのみ置き換えられます。

注記

コネクタのホストプロセスが中断された場合、メトリクスは保存されません。この中断は、例えばグループデプロイ中やデバイスの再起動時などに発生する可能性があります。

AWS IoT コンソールでの表示名: [Maximum metrics to retain] (保持する最大メトリクス)

必須: true

タイプ: string

有効なパターン: ^([2-9]\d{3}|[1-9]\d{4,})$

IsolationMode

このコネクタのコンテナ化モード。デフォルトは GreengrassContainer です。つまり、コネクタは AWS IoT Greengrass コンテナ内の分離されたランタイム環境で実行されます。

注記

グループの既定のコンテナ化設定は、コネクタには適用されません。

AWS IoT コンソールでの表示名: [Container isolation mode] (コンテナ分離モード)　

必須: false

タイプ: string

有効な値: GreengrassContainer または NoContainer

有効なパターン: ^NoContainer$|^GreengrassContainer$

Versions 1 - 3

PublishInterval

特定の名前空間のメトリクスのバッチを発行するまでに待機する最大秒数。最大の値は 900 です。メトリクスを受信時にバッチにまとめないで発行するようにコネクタを設定するには、0 を指定します。

コネクタは、同じ名前空間で 20 個のメトリクスを受信 CloudWatch した後、または指定された間隔後に に発行します。

注記

コネクタでは、発行イベントの順序は保証されません。

AWS IoT コンソールでの表示名: [Publish interval] (発行間隔)

必須: true

タイプ: string

有効な値: 0 - 900

有効なパターン: [0-9]|[1-9]\d|[1-9]\d\d|900

PublishRegion

CloudWatch メトリクスAWS リージョンを投稿する 。この値は、デフォルトの Greengrass メトリクスリージョンを上書きします。クロスリージョンメトリクスをポストする場合にのみ必要です。

AWS IoT コンソールでの表示名: [Publish region] (発行リージョン)

必須: false

タイプ: string

有効なパターン: ^$|([a-z]{2}-[a-z]+-\d{1})

MemorySize

コネクタに割り当てるメモリ (KB 単位)。

AWS IoT コンソールでの表示名: [Memory size] (メモリサイズ)

必須: true

タイプ: string

有効なパターン: ^[0-9]+$

MaxMetricsToRetain

新しいメトリクスで置き換えられるまでにメモリに保存する、名前空間全体のメトリクスの最大数。最小値は 2000 です。

この制限は、インターネットへの接続がなく、コネクタが後で発行するメトリクスをバッファし始めるときに適用されます。バッファが満杯になると、最も古いメトリクスが新しいメトリクスに置き換えられます。特定の名前空間内のメトリクスは、同じ名前空間内のメトリクスでのみ置き換えられます。

注記

コネクタのホストプロセスが中断された場合、メトリクスは保存されません。この中断は、例えばグループデプロイ中やデバイスの再起動時などに発生する可能性があります。

AWS IoT コンソールでの表示名: [Maximum metrics to retain] (保持する最大メトリクス)

必須: true

タイプ: string

有効なパターン: ^([2-9]\d{3}|[1-9]\d{4,})$

サンプルコネクタを作成する (AWS CLI)

次の CLI コマンドは、 CloudWatch Metrics コネクタを含む初期バージョンConnectorDefinitionで を作成します。

aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{
    "Connectors": [
        {
            "Id": "MyCloudWatchMetricsConnector",
            "ConnectorArn": "arn:aws:greengrass:region::/connectors/CloudWatchMetrics/versions/4",
            "Parameters": {
                "PublishInterval" : "600",
                "PublishRegion" : "us-west-2",
                "MemorySize" : "16",
                "MaxMetricsToRetain" : "2500",
                "IsolationMode" : "GreengrassContainer"
            }
        }
    ]
}'

AWS IoT Greengrass コンソールでは、グループの [Connectors] (コネクタ) ページからコネクタを追加できます。詳細については、「Greengrass コネクタの開始方法 (コンソール)」を参照してください。

入力データ

このコネクタは、MQTT トピックのメトリクスを受け入れ、メトリクスを に発行します CloudWatch。入力メッセージは JSON 形式である必要があります。

出力データ

このコネクターは、MQTT トピックで出力データとしてステータス情報を発行します。

使用例

コネクタの試用に利用できる Python 3.7 Lambda 関数の例を設定するには、次のステップ (概要) を使用します。

例

次の例では、Lambda 関数で入力メッセージをコネクタに送信します。

import greengrasssdk
import time
import json

iot_client = greengrasssdk.client('iot-data')
send_topic = 'cloudwatch/metric/put'

def create_request_with_all_fields():
    return  {
        "request": {
            "namespace": "Greengrass_CW_Connector",
            "metricData": {
                "metricName": "Count1",
                "dimensions": [
                    {
                        "name": "test",
                        "value": "test"
                    }
                ],
                "value": 1,
                "unit": "Seconds",
                "timestamp": time.time()
            }
        }
    }

def publish_basic_message():
    messageToPublish = create_request_with_all_fields()
    print("Message To Publish: ", messageToPublish)
    iot_client.publish(topic=send_topic,
        payload=json.dumps(messageToPublish))

publish_basic_message()

def lambda_handler(event, context):
    return

ライセンス

CloudWatch メトリクスコネクタには、以下のサードパーティーのソフトウェアおよびライセンスが含まれています。

このコネクタは、Greengrass Core ソフトウェアライセンス契約に従ってリリースされます。

変更ログ

次の表に、コネクタの各バージョンにおける変更点を示します。

Greengrass グループには、一度に 1 つのバージョンのコネクタしか含めることができません。コネクタのバージョンのアップグレードについては、「コネクタのバージョンのアップグレード」を参照してください。

以下も参照してください。