For the complete documentation index, see llms.txt. This page is also available as Markdown.

Network Test

A Support Application 6 feature that tests reachability and latency against configured endpoints and fires a Network Test event.

Overview

Use Network Test to test reachability and latency against configured endpoints, independent of the throughput-focused Speed Test. Network Test can run on demand from the device, on a schedule, or remotely from the Portal, and fires a networktestevent with the results.

Scheduled runs are disabled by default.

User Guide

  1. Configure endpoint URLs.

  2. Enable scheduled runs, if needed.

  3. Set the schedule interval.

  4. Select which endpoints to include in scheduled tests.

Configuration

Configuring Endpoint URLs

To specify the BlueFletch-provided endpoints to test, add bfUrls to the networkTest configuration:

"bfSupportAgent": {
  "networkTest": {
    "bfUrls": [
      "https://ems-api.bluefletch.com"
    ]
  }
}

To specify org-provided endpoints to test, add orgUrls to the networkTest configuration:

Enabling Scheduled Runs

To enable scheduled, non-interactive runs, add a periodicNetworkTest configuration section with enable set to true:

Configuring Schedule Interval

To set the interval between scheduled runs, add interval in hours to the periodicNetworkTest configuration. The value is clamped to 2–24 hours. The default is 4:

Selecting Scheduled Test Endpoints

To include BlueFletch endpoints in the scheduled test set, add bfEndpoints to the periodicNetworkTest configuration:

To include org endpoints in the scheduled test set, add orgEndpoints to the periodicNetworkTest configuration:

If neither bfEndpoints nor orgEndpoints is set, BlueFletch endpoints are used by default.

The Network Test configuration consists of the following parameters:

Configuration

Type

Default

Description

networkTest.bfUrls

String array

—

BlueFletch-provided endpoint URLs to test

networkTest.orgUrls

String array

—

Org-provided endpoint URLs to test

periodicNetworkTest.enable

Boolean

—

Enables scheduled (non-interactive) runs

periodicNetworkTest.interval

Integer (hours)

4

Interval between scheduled runs, clamped to 2–24 hours

periodicNetworkTest.bfEndpoints

Boolean

—

Include BlueFletch endpoints in the scheduled test set

periodicNetworkTest.orgEndpoints

Boolean

—

Include org endpoints in the scheduled test set. If neither bfEndpoints nor orgEndpoints is set, BlueFletch endpoints are used by default.

Putting It All Together

For the example described above, the full configuration for the Network Test feature is as follows:

Last updated