AWS IoT Wireless リソースのログ記録の設定

CLI を使用して AWS IoT でリソース固有のログ記録を設定するには

1. デフォルトでは、すべてのリソースのログレベルは ERROR に設定されています。アカウント内のすべてのリソースについて、デフォルトのログレベル、またはリソースタイプ別のログレベルを設定するには、update-log-levels-by-resource-types コマンドを使用します。次の例は、JSON ファイル Input.json を作成して、入力として CLI コマンドに提供する方法を示しています。このコマンドを使用すると、特定のタイプのリソースおよびイベントに対して、選択的にログ記録を無効にしたり、デフォルトのログレベルをオーバーライドしたりできます。

   {
       "DefaultLogLevel": "INFO",
       "WirelessDeviceLogOptions": 
        [
           {
            "Type": "Sidewalk",
            "LogLevel": "INFO",
            "Events": 
             [
               {
                 "Event": "Registration",
                 "LogLevel": "DISABLED"
               }
             ]
           }, 
           {
            "Type": "LoRaWAN",
            "LogLevel": "INFO",
            "Events": 
             [
               {
                "Event": "Join",
                "LogLevel": "DISABLED"
               }, 
               {
                "Event": "Rejoin",
                "LogLevel": "ERROR"
               }
             ]
           }
         ]
        "WirelessGatewayLogOptions": 
         [
           {
            "Type": "LoRaWAN",
            "LogLevel": "INFO",
            "Events": 
             [
               {
                "Event": "CUPS_Request",
                "LogLevel": "DISABLED"
               }, 
               {
                 "Event": "Certificate",
                 "LogLevel": "ERROR"
               }
             ]
           }
         ]
   }

   各パラメータの意味は次のとおりです。

   WirelessDeviceLogOptions

   ワイヤレスデバイスのログオプションのリスト。各ログオプションには、ワイヤレスデバイスのタイプ (Sidewalk または LoRaWAN) と、ワイヤレスデバイスのイベントログオプションのリストが含まれます。各ワイヤレスデバイスのイベントログオプションには、必要に応じて、イベントタイプとそのログレベルを含めることができます。

   WirelessGatewayLogOptions

   ワイヤレスゲートウェイのログオプションのリスト。各ログオプションには、ワイヤレスゲートウェイのタイプ (LoRaWAN) と、ワイヤレスゲートウェイのイベントログオプションのリストが含まれます。各ワイヤレスゲートウェイのイベントログオプションには、必要に応じて、イベントタイプとそのログレベルを含めることができます。

   DefaultLogLevel

   すべてのリソースに使用するログレベル。有効な値は、ERROR、INFO、DISABLED です。デフォルト値は INFO です。

   LogLevel

   個々のリソースタイプとイベントに使用するログレベル。これらのログレベルは、LoRaWAN ゲートウェイに対するログレベル INFO や、2 つのイベントタイプに対する DISABLED および ERROR などのデフォルトのログレベルをオーバーライドします。

   次のコマンドを実行すると、Input.json ファイルが入力としてコマンドに提供されます。このコマンドでは、出力が生成されません。

   aws iotwireless update-log-levels-by-resource-types \ 
       --cli-input-json Input.json

   ワイヤレスデバイスとワイヤレスゲートウェイの両方のログオプションを削除する場合は、次のコマンドを実行します。

   {
       "DefaultLogLevel":"DISABLED",
       "WirelessDeviceLogOptions": [],
       "WireslessGatewayLogOptions":[]
   }

2. update-log-levels-by-resource-types コマンドは出力を返しません。リソース固有のログ記録情報を取得するには、get-log-levels-by-resource-types コマンドを使用します。このコマンドは、デフォルトのログレベルと、ワイヤレスデバイスおよびワイヤレスゲートウェイのログオプションを返します。

   注記

   get-log-levels-by-resource-types コマンドは、CloudWatch コンソールでログレベルを直接取得することはできません。get-log-levels-by-resource-types コマンドは、update-log-levels-by-resource-types コマンドを使用してリソースに対して指定した最新のログレベルの情報を取得するために使用できます。

   aws iotwireless get-log-levels-by-resource-types 

   次のコマンドを実行すると、update-log-levels-by-resource-types を使用して指定した最新のログ記録情報が返されます。例えば、ワイヤレスデバイスのログオプションを削除した場合、get-log-levels-by-resource-types を実行すると、この値が null として返されます。

   {
       "DefaultLogLevel": "INFO",
       "WirelessDeviceLogOptions": null,
        "WirelessGatewayLogOptions": 
         [
           {
            "Type": "LoRaWAN",
            "LogLevel": "INFO",
            "Events": 
             [
               {
                "Event": "CUPS_Request",
                "LogLevel": "DISABLED"
               }, 
               {
                 "Event": "Certificate",
                 "LogLevel": "ERROR"
               }
             ]
           }
         ]
   }

3. 個々のワイヤレスゲートウェイまたはワイヤレスデバイスリソースのログレベルを制御するには、次の CLI コマンドを使用します。

   • put-resource-log-level

   • get-resource-log-level

   • reset-resource-log-level

   これらの CLI をいつ使用するかの例として、ログに記録されているアカウント内に多数のワイヤレスデバイスまたはワイヤレスゲートウェイがあるとします。一部のワイヤレスデバイスに対してのみエラーのトラブルシューティングを行う場合は、DefaultLogLevel を DISABLED に設定してすべてのワイヤレスデバイスのログ記録を無効にし、put-resource-log-level を使用して、アカウント内のこれらのデバイスに対してのみ LogLevel を ERROR に設定できます。

   aws iotwireless put-resource-log-level \ 
       --resource-identifier 
       --resource-type WirelessDevice
       --log-level ERROR

   この例では、コマンドによって、指定したワイヤレスデバイスのリソースに対してのみログレベルが ERROR に設定され、その他のすべてのリソースのログが無効になります。このコマンドでは、出力が生成されません。この情報を取得して、ログレベルが設定されたことを確認するには、get-resource-log-level コマンドを使用します。

4. 前のステップでは、問題をデバッグしてエラーを解決した後、reset-resource-log-level コマンドを実行して、そのリソースのログレベルを null にリセットできます。put-resource-log-level コマンドを使用して、複数のワイヤレスデバイスまたはワイヤレスゲートウェイリソースに対してログレベルのオーバーライドを設定した場合 (複数のデバイスのエラーのトラブルシューティングなど)、reset-all-resource-log-levels コマンドを使用して、これらのすべてのリソースに対して、ログレベルのオーバーライドを null にリセットできます。

   aws iotwireless reset-all-resource-log-levels

   このコマンドでは、出力が生成されません。リソースのログ記録情報を取得するには、get-resource-log-level コマンドを実行します。