Support & information center

Configuring a probe in probeRTC

Configuring a probe in probeRTC enables you to decide what tests will be conducted on the target machine as well as creating a link and an invitation email to the user who will be installing and running that probe on the given machine.

You can follow the steps below when creating and configuring a probe:

Step 1

The administration screen for probeRTC can be accessed via the sidebar option of probeRTC. It looks like this:

Step 2

Click on the CREATE NEW PROBE button:

Step 3

Clicking on the CREATE NEW PROBE button takes you to the configuration page where you can configure the probe.

On this screen, you can perform the following functions:

  • Give the probe a name
  • Retrieve and share the probe’s URL with the user who should run it
  • Enter emails that will receive alerts from the probe
  • Enter the End Date for the probe (to stop the probe)
  • Provide additional description for the probe

Give the probe a name

When creating a probe you need to give it a name. The name is used to make it easier for you to track and find it, associating each probe with a certain location, user or device. If you are running multiple probes then this will be used to find that probe later on.

You should choose a name that is verbose enough for you and your peers to understand where the probe is running.

URL Section

This section allows the you to share the API key generated in the process. This unique API key is then sent to the end user along with the email to start the probe. 

Alert Email

The Alert Email enables you to define who will receive emails alerting on changes occurring in the probe.

Currently, alert emails are sent when a probe starts running or when it stops running.

End Date

The End Date section is where the administrator can end the probe by entering an End Date depending on the conditions and the customized requirements of the end user. This field is optional. You can always disable a probe remotely from the main admin panel if needed.

Description

You can add a short description to the probe, giving you more context and information about where and how the probe is being deployed. This information is displayed on the probe’s results page as well.

Options

What is the Options section?

The Options section allows the admin to enforce the probe to associate itself with different geographic regions, along with any other customer-specific parameters that were created for your account.

Test selection and frequency

There are two types of probe Runs:

  1. Normal Run
  2. Thorough Run

Normal Run

Under this section, you will pick and choose tests to run at a low frequency. Usually, tests that don’t take a lot of bitrate or affect the network adversely should be selected.


You can pick frequencies as low as every 5 minutes to running tests once a day for the Normal Run.

Thorough Run

Thorough runs are tests that should run less frequently. Here, you can select tests that take up bitrate and may affect the users on the network. Speed tests and throughput tests are great candidates for these types of tests.

It is good practice to also include whatever you decide to place in your Normal Run as part of your Thorough Run as well.

You can select different tests and define them under these two frequency configurations.

Note that the list of tests available in your account will be different than what is shown above and will be based on the configuration selected for your specific use case during onboarding you to the probeRTC product.

What is DNS Lookup?

The DNS Lookup Widget tests the reachability and connectivity to a list of HTTPS or WSS addresses. This widget enables an admin to enter all the domains that are easily accessible from the user’s browser.

Step 4

After configuring the probe, click on the SAVE button to save the changes. This will also create the probe if needed, assigning it an API key and a URL.

Step 5

Before sending an email to the end user, check whether the probe is active. You can do that on probeRTC’s main dashboard, by using the blue toggle next to the probe information.

Step 6

After activating the probe, go back to the probe’s configuration page. You will find here the probe’s URL which includes its unique API key.

Here you can:

  • COPY this URL and send it to the user directly
  • Click on the SEND button to send an email with instructions to the user
  • REGENERATE the probe if you want to reset and restart it (for example when a user needs to move the probe from running on one machine to another)

Was this article helpful?