View and monitor network analyzer trace message logs in real time - Amazon IoT Core
PrerequisitesActivate trace messaging by using the consoleView and monitor trace messagesNetwork analyzer JSON log messageReview and next steps
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

View and monitor network analyzer trace message logs in real time

If you've added resources to your network analyzer configuration, you can activate trace messaging to start receiving trace messages for your resources. You can use either the Amazon Web Services Management Console, the Amazon IoT Wireless API, or the Amazon CLI.

Prerequisites

Before you can activate trace messaging by using network analyzer, you must have:

  • Added the resources that you want to monitor to your default network analyzer configuration. For more information, see Add resources and update the network analyzer configuration.

  • Generated a presigned request by using the StartNetworkAnalyzerStream request URL. The request will be signed using the credentials for the Amazon Identity and Access Management role that makes this request. For more information, see Create a presigned URL

Activate trace messaging by using the console

To activate trace messaging

  1. Open the Network Analyzer hub of the Amazon IoT console and choose your network analyzer configuration, NetworkAnalyzerConfig_Default.

  2. In the details page of your network analyzer configuration, choose Activate trace messaging and then choose Activate.

    You'll start receiving trace messages where the newest trace message appears first in the console.

    Note

    After the messaging session starts, receiving trace messages can incur additional costs until you deactivate the session or leave the trace session. For more information about pricing, see Amazon IoT Core pricing.

View and monitor trace messages

After you activate trace messaging, the WebSocket connection is established and trace messages start appearing in real time, newest first. You can customize the preferences to specify the number of trace messages to be displayed in each page and to display only the relevant fields for each message. For example, you can customize the trace message log to show only logs for wireless gateway resources that have Log level set to ERROR, so that you can quickly identify and debug errors with your gateways. The trace messages contain the following information.

  • Message Number: A unique number that shows the last message received first.

  • Resource ID: The wireless gateway or wireless device ID of the resource.

  • Timestamp: The time when the message was received.

  • Message ID: An identifier that Amazon IoT Core for LoRaWAN assigns to each received message.

  • FPort: The frequency port for communicating with the device by using the WebSocket connection.

  • DevEui: The extended unique identifier (EUI) for your wireless device.

  • Resource: Whether the monitored resource is a wireless device or a wireless gateway.

  • Event: The event for a log message for a wireless device, which can be Join, Rejoin, Uplink_Data, Downlink_Data, or Registration.

  • Log level:Information about INFO or ERROR log streams for your device.

Network analyzer JSON log message

You can also choose one trace message at a time to view the JSON payload for that message. Depending on the message that you select in the trace message logs, you'll see information in the JSON payload that indicates contains 2 parts: CustomerLog and LoRaFrame.

CustomerLog

The CustomerLog part of the JSON displays the type and identifier of the resource that received the message, the log level, and the message content. The following example shows a CustomerLog log message. You can use the message field in the JSON to get more information about the error and how it can be resolved.

LoRaFrame

The LoRaFrame part of the JSON has a Message ID and contains information about the physical payload for the device and the wireless metadata.

The following shows the structure of the trace message.

Note

If your devices send an uplink message without a value for Fport, Amazon IoT Core for LoRaWAN network analyzer will display an fPort value of 225 in the trace message received.

export type TraceMessage = {
  ResourceId: string;
  Timestamp: string;
  LoRaFrame: 
  {
    MessageId: string;
    PhysicalPayload: any;
    WirelessMetadata: 
    {
      fPort: number;
      dataRate: number;
      devEui: string;
      frequency: number,
      timestamp: string;
    },
  }
  CustomerLog: 
  {
    resource: string;
    wirelessDeviceId: string;
    wirelessDeviceType: string;
    event: string;
    logLevel: string;
    messageId: string;
    message: string;
  },
};

Review and next steps

In this section, you've viewed trace messages and learned how you can use the information to debug errors. After you've viewed all messages, you can:

  • Deactivate trace messaging

    To avoid incurring any additional costs, you can deactivate the trace messaging session. Deactivating the session disconnects your WebSocket connection so you won't receive any additional trace messages. You can still continue viewing the existing messages in the console.

  • Edit frame info for your configuration

    You can edit the network analyzer configuration and choose whether to deactivate frame info and choose the log levels for your messages. Before you update your configuration, consider deactivating your trace messaging session. To make these edits, open the Network Analyzer details page in the Amazon IoT console and choose Edit. You can then update your configuration with the new configuration settings and activate trace messaging to see the updated messages.

  • Add resources to your configuration

    You can also add more resources to your network analyzer configuration and monitor them in real time. You can add up to a combined total of 250 wireless gateway and wireless device resources. To add resources, on the Network Analyzer details page of the Amazon IoT console, choose the Resources tab and choose Add resources. You can then update your configuration with the new resources and activate trace messaging to see the updated messages for the additional resources.

For more information about updating your network analyzer configuration by editing the configuration settings and adding resources, see Add resources and update the network analyzer configuration.