Use the network quality analyzer

Step 1: Create a client application

1. Log on to the Simple Log Service console.

2. In the Log Apps section, click Network Quality Analyzer.

3. In the upper-right corner of the page, click Endpoint Management.

4. If this is your first time performing this operation, follow the on-screen instructions to complete the authorization.

   After the authorization is complete, the system creates a service-linked role named AliyunServiceRoleForIpaDataSync. For more information, see Manage service-linked roles.

5. On the Endpoint Management page:

   • Click New Endpoint App. In the Create New Application panel, configure the following parameters and click Create.

     Note

     After the application is created, the system generates a key for the SDK. To obtain the key, click View Secret Key for the client application.

     Parameter	Description
     Region	Select the region of the target Project.
     Project	Select the target Project. Log Service automatically creates a Logstore in this Project to store network probe data.
     Application name	Set a name for the client application.

   • Click Tag Management. In the Tag Management panel, configure Tag name and Remarks.

     • Use cases for tags:

       1. Add a tag to a probe rule group: First, add a tag in the Tag Management panel of the console. Then, select the existing tag in the Set Network Probing Rules panel in Step 2.

       2. Add a tag to a user/device: Use the SDK plugin to add the same tag that is associated with the probe rule group.

       3. Match tags: Data from a user/device is probed and displayed only if the tags of the probe rule group match those on the user/device.

     • Limits on tags:

       • Tags must be globally unique within an Alibaba Cloud account. Currently, you can bind tags only to probe rule groups.

       • A tag name can contain only letters, digits, hyphens (-), and underscores (_), such as jp_2, id-3, and gameVip2. You can create a maximum of 32 tags. You can bind a maximum of 4 tags to each probe rule group. For other limitations, see the Tagging rule description section at the bottom of the Tag Management panel.

Step 2: Set network probe rules

1. On the Endpoint Management page, find the target client application in the application list and click Set Network Probing Rules.

2. In the Set Network Probing Rules panel, configure the following parameters and then click Save.

   Important

   • You can create a maximum of 16 probe rule groups for each client application, and each probe rule group can contain a maximum of 64 probe targets. If you need a higher quota, submit a ticket.

   • Values for time, percentages, and other numbers are approximate.

   • The settings take about 3 minutes to take effect.

   Parameter	Description
   Probe group name	Set the name for the probe group.
   Monitored object collection	Set the information for the monitored objects. The parameters are described below. Probe protocol: Set the probe protocol. Supported protocols include http, tcpping, mtr, ping, udp, dns, and dnsAAAA. Domain name or IP: Enter the target domain name or IP address. Port: Set the port number. You must specify a port number if you set Detection Protocol to tcpping or udp. Probe payload: Enter a valid hexadecimal string. This parameter is required if Probe protocol is set to udp.
   Probe frequency	Set the probe interval.
   Probe source region	Select the region where you want to initiate network probes.
   Probe client ratio	The percentage of devices that have the target app installed and can perform network probes.
   Multi-NIC probe	Select Yes to enable multi-NIC (network interface card) probes. For example, probe the Wi-Fi and cellular networks on a mobile phone separately.
   Advanced Configuration	SDK version requirements: Android SDK 0.2.2.0 or later, and iOS SDK 0.2.1.1 or later. You can get the SDK version from the sdkVer field. For more information, see Network probe field description. Configuration parameters: Supported operating systems: Includes All, Windows, iOS, and Android. Single-round probe: Probe Count, Interval are valid only for Ping, TcpPing, Udp, and Mtr. Packet Size is valid only for Ping. Timeout is valid only for Ping, TcpPing, Udp, Mtr, and DNS probes. Tag association: Add a tag to the probe rule group, and then select the tag here. Finally, use the SDK to add the same tag to the user or device. For more information, see SDK version guide. Important To use the tag association feature, you need Android SDK 1.0.0.0 or later and iOS SDK 1.0.0.0 or later. You can get the SDK version from the sdkVer field. For more information, see Network probe field description. Each probe rule group can be associated with a maximum of four user or device tags.

Step 3: Integrate the SDK plugin

Integrate the SDK plugin into your target client application. For more information, see SDK plugin usage instructions.

After you integrate the SDK plugin into your client application, the Network Quality Analyzer automatically starts network probes when you launch the client application.

Step 4: View data and reports

After the Network Quality Analyzer conducts network probes, it reports the data to the Logstore in Log Service. Log Service automatically analyzes the collected network probe data and generates reports.

View data

1. On the Endpoint Management page, find the target client application and click the icon.

2. In the Application Details panel, click the target Logstore.

3. In the target Logstore, view the network probe data.

   For a detailed description of the network probe data fields, see Network probe fields.

View reports

1. On the Endpoint Management page, click the < icon before Endpoint Management.

2. On the Network Quality Analyzer page, view the generated reports.

   Network Quality Analyzer provides reports for Network Quality Analysis, Probe Result Details, and Probe Count Analysis. For more information, see the linked topics.

Related operations