ネットワークアナライザの設定を作成する - AWS IoT Wireless

ネットワークアナライザの設定を作成する

ワイヤレスゲートウェイまたはワイヤレスデバイスをモニタリングする前に、ネットワークアナライザ設定を作成する必要があります。設定を作成するときは、設定名を指定するだけです。作成した後でも、設定をカスタマイズし、モニタリングするリソースを設定に追加できます。設定によって、それらのリソースについて受信するトレースメッセージング情報が決まります。

モニタリングするリソースとそれらに対して受信する情報のレベルに応じて、複数の設定を作成できます。例えば、AWS アカウント の一連のゲートウェイについてのエラー情報のみを表示する設定を作成できます。モニタリングするワイヤレスデバイスに関するすべての情報を表示する設定を作成することもできます。

次のセクションでは、さまざまな設定と、設定の作成方法について説明します。

構成設定

ネットワークアナライザ設定を作成または更新するときに、次のパラメータをカスタマイズしてログストリーム情報をフィルタリングすることもできます。

  • フレーム情報

    この設定は、トレースメッセージについてのワイヤレスデバイスリソースのフレーム情報です。フレーム情報は、ネットワークサーバーとエンドデバイス間の通信のデバッグに使用できます。このエージェントは、デフォルトでは有効になっています。

  • ログレベル

    情報ログまたはエラーログを表示したり、ログ記録をオフにしたりできます。

    • 情報

      ログレベルが [Info] (情報) のログは冗長性が高く、エラーログストリームと情報ログストリームの両方を含みます。情報ログは、デバイスまたはゲートウェイの状態の変更を表示するために使用できます。

      注記

      冗長性が高いログストリームを収集すると、追加コストが発生する可能性があります。料金の詳細については、「AWS IoT Core の料金」を参照してください。

    • エラー

      ログレベルが Error のログは冗長性が低く、エラー情報のみを表示します。これらのログは、アプリケーションにデバイス接続エラーなどのエラーがあるときに使用できます。ログストリームの情報を使用して、フリート内のリソースのエラーを特定し、トラブルシューティングできます。

コンソールを使用して設定を作成する

AWS IoT コンソールまたは AWS IoT Wireless API を使用して、ネットワークアナライザ設定を作成し、オプションパラメータをカスタマイズできます。また、複数の設定を作成し、後で使用しなくなった設定を削除することもできます。

ネットワークアナライザの設定を作成する

  1. AWS IoT コンソールのネットワークアナライザハブを開いて、[Create configuration] (設定の作成) を選択します。

  2. 設定を指定します。

    • 名前、説明、タグ

      英字、数字、ハイフン、またはアンダースコアのみを含む、一意の [Configuration name] (設定名) を指定します。オプションの [Description] (説明) フィールドを使用して設定に関する情報を指定し、[Tags] (タグ) フィールドを使用して設定に関するメタデータのキーバリューペアを追加します。リソースの命名と説明の詳細については、AWS IoT Wireless リソースについて説明する を参照してください。

    • 構成設定

      フレーム情報を無効にするかどうかを選択し、[Select log levels] (ログレベルの選択) を使用して、トレースメッセージログに使用するログレベルを選択します。[Next] を選択します。

  3. 設定にリソースを追加します。今すぐリソースを追加するか、[Create] (作成) を選択して、後でリソースを追加することもできます。後でリソースを追加するには、[Create] (作成) を選択します。

    [Network Analyzer hub page] (ネットワークアナライザハブページ) には、作成した設定とその構成が表示されます。新しい設定の詳細を表示するには、設定名を選択します。

ネットワークアナライザの設定を削除する

モニタリングするリソースと、そのリソースに対して受け取るトレースメッセージング情報のレベルに応じて、複数のネットワークアナライザ設定を作成することができます。

コンソールから設定を削除するには
  1. AWS IoT コンソールのネットワークアナライザハブに移動し、削除する設定を選択します。

  2. [アクション] を選択し、[削除] を選択します。

API を使用して設定を作成する

API を使用してネットワークアナライザーの設定を作成するには、CreateNetworkAnalyzerConfiguration API オペレーションまたは create-network-analyzer-configuration CLI コマンドを使用します。

設定を作成するときは、設定名を指定するだけです。この API オペレーションを使用して、構成設定を指定し、設定の作成時にリソースを追加することもできます。または、UpdateNetworkAnalyzerConfiguration API オペレーションまたは update-network-analyzer-configuration CLI を使用して、後で指定することもできます。

  • 設定を作成する

    設定の作成時に、名前を指定する必要があります。例えば、次のコマンドでは、名前とオプションの説明のみを指定して、設定を作成します。デフォルトでは、フレーム情報がアクティブ化されており、ログレベルは INFO を使用する設定になっています。

    aws iotwireless create-network-analyzer-configuration \ --configuration-name My_Network_Analyzer_Config \ --description "My first network analyzer configuration"

    このコマンドを実行すると、ネットワークアナライザ設定の ARN と ID が表示されます。

    { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:NetworkAnalyzerConfiguration/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" }
  • リソースを使用して設定を作成する

    構成設定をカスタマイズするには、trace-content パラメータを使用します。リソースを追加するには、WirelessDevices および WirelessGateways パラメータを使用して、設定に追加するゲートウェイ、デバイス、またはその両方を指定します。例えば、次のコマンドは、構成設定をカスタマイズし、WirelessGatewayIDWirelessDeviceID で指定されたワイヤレスリソースを設定に追加します。

    aws iotwireless create-network-analyzer-configuration \ --configuration-name My_NetworkAnalyzer_Config \ --trace-content WirelessDeviceFrameInfo=DISABLED,LogLevel="ERROR" \ --wireless-gateways "12345678-a1b2-3c45-67d8-e90fa1b2c34d" "90123456-de1f-2b3b-4c5c-bb1112223cd1" --wireless-devices "1ffd32c8-8130-4194-96df-622f072a315f"

    次の例は、コマンドを実行したときの出力を示しています。

    { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:NetworkAnalyzerConfiguration/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" }
ネットワークアナライザ設定を一覧表示する

モニタリングするリソースと、そのリソースに対して受け取るトレースメッセージング情報の詳細のレベルに応じて、複数のネットワークアナライザ設定を作成することができます。これらの設定を作成した後、ListNetworkAnalyzerConfigurations API オペレーションまたは list-network-analyzer-configuration CLI コマンドを使用して、これらの設定の一覧を取得できます。

aws iotwireless list-network-analyzer-configurations

このコマンドを実行すると、AWS アカウント のすべてのネットワークアナライザ設定が表示されます。また、max-results パラメータを使用して、表示する設定の数を指定することができます。以下は、このコマンドを実行したときの出力を示しています。

{ "NetworkAnalyzerConfigurationList": [ { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:NetworkAnalyzerConfiguration/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Name": "My_Network_Analyzer_Config1" }, { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:NetworkAnalyzerConfiguration/90123456-a1a2-9a87-65b4-c12bf3c2d09a", "Name": "My_Network_Analyzer_Config2" } ] }
ネットワークアナライザの設定を削除する

DeleteNetworkAnalyzerConfiguration API オペレーションまたは delete-network-analyzer-configuration CLI コマンドを使用して、使用しなくなった設定を削除できます。

aws iotwireless delete-network-analyzer-configuration \ --configuration-name My_NetworkAnalyzer_Config

このコマンドを実行しても、出力は生成されません。使用可能な設定を確認するには、ListNetworkAnalyzerConfigurations API オペレーションを使用できます。

次のステップ

ネットワークアナライザ設定を作成したので、設定にリソースを追加したり、構成設定を更新したりできます。詳細については、「リソースを追加し、ネットワークアナライザの設定を更新する」を参照してください。