# ネットワークアナライザの設定を作成し、リソースを追加する
トレースメッセージをストリーミングする前に、ネットワークアナライザ設定を作成し、モニタリングするリソースをこの設定に追加します。設定を作成すると、次のことができます。
+ 設定名とオプションの説明を指定します。
+ ログメッセージのフレーム情報や詳細レベルなどの設定をカスタマイズします。
+ モニタリングするリソースを追加します。リソースは、ワイヤレスデバイスまたはワイヤレスゲートウェイ、もしくはその両方にすることができます。
指定した構成設定によって、設定に追加するリソースについて受信するトレースメッセージング情報が決まります。モニタリングするユースケースに応じて、複数の設定を作成することもできます。
以下は、設定を作成してリソースを追加する方法を示しています。
**Topics**
+ [ネットワークアナライザの設定を作成する](network-analyzer-create.md)
+ [リソースを追加し、ネットワークアナライザの設定を更新する](network-analyzer-resources.md)
# ネットワークアナライザの設定を作成する
ワイヤレスゲートウェイまたはワイヤレスデバイスをモニタリングする前に、ネットワークアナライザ設定を作成する必要があります。設定を作成するときは、設定名を指定するだけです。作成した後でも、設定をカスタマイズし、モニタリングするリソースを設定に追加できます。設定によって、それらのリソースについて受信するトレースメッセージング情報が決まります。
モニタリングするリソースとそれらに対して受信する情報のレベルに応じて、複数の設定を作成できます。例えば、AWS アカウント の一連のゲートウェイについてのエラー情報のみを表示する設定を作成できます。モニタリングするワイヤレスデバイスに関するすべての情報を表示する設定を作成することもできます。
次のセクションでは、さまざまな設定と、設定の作成方法について説明します。
## 構成設定
ネットワークアナライザ設定を作成または更新するときに、次のパラメータをカスタマイズしてログストリーム情報をフィルタリングすることもできます。
+
**フレーム情報**
この設定は、トレースメッセージについてのワイヤレスデバイスリソースのフレーム情報です。フレーム情報は、ネットワークサーバーとエンドデバイス間の通信のデバッグに使用できます。このエージェントは、デフォルトでは有効になっています。
+
**ログレベル**
情報ログまたはエラーログを表示したり、ログ記録をオフにしたりできます。
+
**情報**
ログレベルが **[Info]** (情報) のログは冗長性が高く、エラーログストリームと情報ログストリームの両方を含みます。情報ログは、デバイスまたはゲートウェイの状態の変更を表示するために使用できます。
**注記**
冗長性が高いログストリームを収集すると、追加コストが発生する可能性があります。料金の詳細については、「[AWS IoT Core の料金](https://aws.amazon.com/iot-core/pricing/)」を参照してください。
+
**エラー**
ログレベルが **Error** のログは冗長性が低く、エラー情報のみを表示します。これらのログは、アプリケーションにデバイス接続エラーなどのエラーがあるときに使用できます。ログストリームの情報を使用して、フリート内のリソースのエラーを特定し、トラブルシューティングできます。
## コンソールを使用して設定を作成する
AWS IoT コンソールまたは AWS IoT Wireless API を使用して、ネットワークアナライザ設定を作成し、オプションパラメータをカスタマイズできます。また、複数の設定を作成し、後で使用しなくなった設定を削除することもできます。
**ネットワークアナライザの設定を作成する**
1. [AWS IoT コンソールのネットワークアナライザハブ](https://console.aws.amazon.com/iot/home#/wireless/networkAnalyzer)を開いて、[**Create configuration**] (設定の作成) を選択します。
1. 設定を指定します。
+
**名前、説明、タグ**
英字、数字、ハイフン、またはアンダースコアのみを含む、一意の [**Configuration name**] (設定名) を指定します。オプションの **[Description]** (説明) フィールドを使用して設定に関する情報を指定し、**[Tags]** (タグ) フィールドを使用して設定に関するメタデータのキーバリューペアを追加します。リソースの命名と説明の詳細については、[AWS IoT Wireless リソースについて説明する](iotwireless-describe-resources.md) を参照してください。
+
**構成設定**
フレーム情報を無効にするかどうかを選択し、**[Select log levels]** (ログレベルの選択) を使用して、トレースメッセージログに使用するログレベルを選択します。[**Next**] を選択します。
1. 設定にリソースを追加します。今すぐリソースを追加するか、**[Create]** (作成) を選択して、後でリソースを追加することもできます。後でリソースを追加するには、**[Create]** (作成) を選択します。
**[Network Analyzer hub page]** (ネットワークアナライザハブページ) には、作成した設定とその構成が表示されます。新しい設定の詳細を表示するには、設定名を選択します。
**ネットワークアナライザの設定を削除する**
モニタリングするリソースと、そのリソースに対して受け取るトレースメッセージング情報のレベルに応じて、複数のネットワークアナライザ設定を作成することができます。
**コンソールから設定を削除するには**
1. [AWS IoT コンソールのネットワークアナライザハブ](https://console.aws.amazon.com/iot/home#/wireless/networkAnalyzer)に移動し、削除する設定を選択します。
1. **[アクション]** を選択し、**[削除]** を選択します。
## API を使用して設定を作成する
API を使用してネットワークアナライザーの設定を作成するには、[CreateNetworkAnalyzerConfiguration](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_CreateNetworkAnalyzerConfiguration.html) API オペレーションまたは [create-network-analyzer-configuration](https://docs.aws.amazon.com/cli/latest/reference/iotwireless/create-network-analyzer-configuration.html) CLI コマンドを使用します。
設定を作成するときは、設定名を指定するだけです。この API オペレーションを使用して、構成設定を指定し、設定の作成時にリソースを追加することもできます。または、[UpdateNetworkAnalyzerConfiguration](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateNetworkAnalyzerConfiguration.html) API オペレーションまたは [update-network-analyzer-configuration](https://docs.aws.amazon.com/cli/latest/reference/iotwireless/update-network-analyzer-configuration.html) 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` パラメータを使用して、設定に追加するゲートウェイ、デバイス、またはその両方を指定します。例えば、次のコマンドは、構成設定をカスタマイズし、`WirelessGatewayID` と `WirelessDeviceID` で指定されたワイヤレスリソースを設定に追加します。
```
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](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_ListNetworkAnalyzerConfigurations.html) API オペレーションまたは [list-network-analyzer-configuration](https://docs.aws.amazon.com/cli/latest/reference/iotwireless/list-network-analyzer-configuration.html) 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](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_DeleteNetworkAnalyzerConfiguration.html) API オペレーションまたは [delete-network-analyzer-configuration](https://docs.aws.amazon.com/cli/latest/reference/iotwireless/delete-network-analyzer-configuration.html) CLI コマンドを使用して、使用しなくなった設定を削除できます。
```
aws iotwireless delete-network-analyzer-configuration \
--configuration-name My_NetworkAnalyzer_Config
```
このコマンドを実行しても、出力は生成されません。使用可能な設定を確認するには、`ListNetworkAnalyzerConfigurations` API オペレーションを使用できます。
## 次のステップ
ネットワークアナライザ設定を作成したので、設定にリソースを追加したり、構成設定を更新したりできます。詳細については、「[リソースを追加し、ネットワークアナライザの設定を更新する](network-analyzer-resources.md)」を参照してください。
# リソースを追加し、ネットワークアナライザの設定を更新する
トレースメッセージングをアクティブ化する前に、設定にリソースを追加する必要があります。使用できるデフォルトのネットワークアナライザ設定は 1 つだけです。AWS IoT Core for LoRaWAN によって、**NetworkAnalyzerConfig\$1Default** という名前がこの設定に割り当てられます。このフィールドは編集できません。この設定は、コンソールからネットワークアナライザを使用する場合、自動的に AWS アカウント に追加されます。
このデフォルト設定に、モニタリングするリソースを追加できます。リソースは、LoRaWAN デバイスと LoRaWAN ゲートウェイのいずれかまたは両方にすることができます。設定に個々のリソースを追加するには、ワイヤレスゲートウェイとワイヤレスデバイス ID を使用します。
## 設定
設定をするには、まずデフォルト設定にリソースを追加し、トレースメッセージングをアクティブにします。トレースメッセージログを受信したら、次のパラメータをカスタマイズしてデフォルト設定を更新し、ログストリームをフィルタリングすることもできます。
+
**フレーム情報**
この設定は、トレースメッセージのワイヤレスデバイスリソースのフレーム情報です。フレーム情報はデフォルトで有効になっており、ネットワークサーバーとエンドデバイス間の通信のデバッグに使用できます。
+
**ログレベル**
情報ログまたはエラーログを表示したり、ログ記録をオフにしたりできます。
+
**情報**
ログレベルが **Info** のログは冗長性が高く、情報を提供しエラーを含むログストリームを含んでいます。情報ログは、デバイスまたはゲートウェイの状態の変更を表示するために使用できます。
**注記**
冗長性が高いログストリームを収集すると、追加コストが発生する可能性があります。料金の詳細については、「[AWS IoT Core の料金](https://aws.amazon.com/iot-core/pricing/)」を参照してください。
+
**エラー**
ログレベルが **Error** のログは冗長性が低く、エラー情報のみを表示します。これらのログは、アプリケーションにデバイス接続エラーなどのエラーがあるときに使用できます。ログストリームの情報を使用して、フリート内のリソースのエラーを特定し、トラブルシューティングできます。
## 前提条件
リソースを追加する前に、モニタリングするゲートウェイとデバイスを AWS IoT Core for LoRaWAN にオンボーディングしておく必要があります。詳細については、「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](lorawan-getting-started.md)」を参照してください。
## コンソールを使用して、リソースを追加し、ネットワークアナライザ設定を更新する
リソースを追加し、オプションパラメータをカスタマイズするには、AWS IoT コンソールまたは AWS IoT Wireless API を使用します。リソースに加えて、設定を編集し、更新された設定を保存することもできます。
**設定にリソースを追加するには (コンソール)**
1. [AWS IoT コンソールの [Network Analyzer] (ネットワークアナライザ) ハブ](https://console.aws.amazon.com/iot/home#/wireless/networkAnalyzer)を開き、ネットワークアナライザの設定 **NetworkAnalyzerConfig\$1Default** を選択します。
1. **[Add resources]** (リソースを追加) を選択します。
1. ワイヤレスゲートウェイとワイヤレスデバイス ID を使用して、モニタリングするリソースを追加します。最大 250 のワイヤレスゲートウェイまたはワイヤレスデバイスを追加できます。リソースを追加するには、次の手順に従います。
1. **[View gateways]** (ゲートウェイを表示) または **[View devices]** (デバイスを表示) タブを使用して、AWS アカウント に追加したゲートウェイとデバイスのリストを表示します。
1. モニタリングするデバイスまたはゲートウェイの `WirelessDeviceID` または `WirelessGatewayID` をコピーし、対応するリソースの識別子の値を入力します。
1. リソースの追加を続行するには、**[Add gateway]** (ゲートウェイを追加) または **[Add device]** (デバイスを追加) を選択し、ワイヤレスゲートウェイまたはデバイスを追加します。追加していたリソースをモニタリングする必要がなくなった場合は、**[Remove resource]** (リソースを削除) を選択します。
1. すべてのリソースを追加したら、**[Add]** (追加) をクリックします。
追加したゲートウェイとデバイスの数が**[Network Analyzer] (ネットワークアナライザ) ハブページ** に表示されます。トレースメッセージングセッションをアクティブにするまで、ゲートウェイとデバイスをさらに続けて追加できます。セッションをアクティブ化した後、リソースを追加するには、セッションを非アクティブ化する必要があります。
**ネットワークアナライザの設定を編集するには (コンソール)**
ネットワークアナライザの設定を編集して、トレースメッセージログのフレーム情報を無効にするかどうかとそのログレベルを選択することもできます。
1. [AWS IoT コンソールの [Network Analyzer] (ネットワークアナライザ) ハブ](https://console.aws.amazon.com/iot/home#/wireless/networkAnalyzer)を開き、ネットワークアナライザの設定 **NetworkAnalyzerConfig\$1Default** を選択します。
1. [**編集**] を選択します。
1. フレーム情報を無効にするかどうかを選択し、**[Select log levels]**(ログレベルの選択) を使用して、トレースメッセージログに使用するログレベルを選択します。[**Save**] を選択します。
ネットワークアナライザの設定の詳細ページで指定した設定が表示されます。
## API を使用してリソースを追加し、ネットワークアナライザの設定を更新する
[AWS IoT Wireless API オペレーション](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/)または[AWS IoT Wireless CLI コマンド](https://docs.aws.amazon.com/cli/latest/reference/iotwireless/index.html)を使用して、リソースを追加し、ネットワークアナライザの設定を更新します。
+ リソースを追加し、ネットワークアナライザの設定を更新するには、[UpdateNetworkAnalyzerConfiguration](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateNetworkAnalyzerConfiguration.html) API または [update-network-analyzer-configuration](https://docs.aws.amazon.com/cli/latest/reference/iotwireless/update-network-analyzer-configuration.html) CLI を使用します。
+
**リソースを追加する**
追加するワイヤレスデバイスについては、`WirelessDevicesToAdd` を使用してデバイスの `WirelessDeviceID` を文字列の配列として入力します。追加するワイヤレスゲートウェイについては、`WirelessGatewaysToAdd` を使用してゲートウェイの `WirelessGatewayID` を文字列の配列として入力します。
+
**設定を編集する**
ネットワークアナライザの設定を編集するには、`TraceContent` パラメータを使用して、`WirelessDeviceFrameInfo` を `ENABLED` にするか `DISABLED` にするか、および `LogLevel` パラメータを `INFO`、`ERROR`、`DISABLED` のいずれにするかを指定します。
```
{
"TraceContent": {
"LogLevel": "string",
"WirelessDeviceFrameInfo": "string"
},
"WirelessDevicesToAdd": [ "string" ],
"WirelessDevicesToRemove": [ "string" ],
"WirelessGatewaysToAdd": [ "string" ],
"WirelessGatewaysToRemove": [ "string" ]
}
```
+ 追加した設定とリソースに関する情報を取得するには、[GetNetworkAnalyzerConfiguration](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateNetworkAnalyzerConfiguration.html) API オペレーション、または [get-network-analyzer-configuration](https://docs.aws.amazon.com/cli/latest/reference/iotwireless/get-network-analyzer-configuration.html) コマンドを使用します。ネットワークアナライザ設定 `NetworkAnalyzerConfig_Default` の名前を入力として指定します。
## 次のステップ
リソースを追加し、オプションの設定を指定したので、WebSocket プロトコルを使用して、AWS IoT Core for LoRaWAN との接続を確立し、ネットワークアナライザを使用できるようになります。その後、トレースメッセージをアクティブにして、リソースのトレースメッセージの受信を開始できます。詳細については、「[WebSockets を使用してネットワークアナライザのトレースメッセージをストリーミングする](network-analyzer-api.md)」を参照してください。