Scopemon is configured via parameters. This reference lists all available parameters, default values, allowed values, and use examples for the measurement.
Determines how often quality is measured for the ongoing measurement. Lower value gives more detailed results and consumes more resources. A higher value gives smoother values.
milliseconds
integer
50
1000
Example
To make Scopemon collect quality results twice per second (i.e., every 500 ms), define this parameter as:
[Measurement]
averaging_interval=500
Determines whether average results are gathered from the secondary Probe.
true
- Gather average results from the secondary Probefalse
- Do not gather average results from the secondary Probefalse
Verbose description of the measurement. This value is written to results files as metadata.
string
[empty]
Example
To name this measurement “My measurement”, define this parameter as:
[Measurement]
measurement_description=My measurement
Artificially delay the start of the measurement by the given time. If the value is 0, the measurement starts as soon as possible.
milliseconds
integer
0
0
Example
To delay the start of the measurement by 1 second, define this parameter as:
[Measurement]
measurement_start_offset=1000
Qosium needs to be aware if a Network Address Translation (NAT) occurs between Probes. If this is the case, enable this parameter.
true
- There’s a NAT occurring between Probesfalse
- No NAT is occurring between Probesfalse
Packet filter is one of the most important parameters, as it defines which traffic is measured. The packet filter needs to be strict enough so that no irrelevant traffic is captured. Otherwise, the results may not be useful.
string
ip
For more information, see Packet Filters in Qosium.
Example
To enable monitoring only for UDP traffic going through ports 6889 or 6890, define this parameter as:
[Measurement]
packet_filter=udp port 6889 or udp port 6890
This parameter determines the mode in which packets are filtered. In most cases, the selection is between FILTER_MODE_AUTO_BETW_HOSTS, which generates an automatic filter, or FILTER_SET_EQUAL, which allows the use of a manual filter defined in packet_filter. For more information, see Packet Filters in Qosium.
220
FILTER_SET_EQUAL - Packet filter is defined manually in packet_filter. In a two-point measurement, this filter is used in the secondary Probe as well.240
FILTER_MODE_AUTO_BETW_HOSTS- Generates automatically a filter, which includes all traffic between the hosts (a two-point measurement) or the measurement point’s own traffic (a single-point measurement).231
FILTER_AUTO_SECONDARY_STRICT233
FILTER_AUTO_SECONDARY_LIGHT240
Example
[Measurement]
packet_filter_mode=231
Packet identification mode, i.e., the method of how Probes uniquely identify packets.
10
ID_MODE_AUTO - The ID mode is set automatically by the Qosium system50
ID_MODE_IPv4_ID - IPv4 ID field60
ID_MODE_RTP_SEQ - RTP Sequence number100
ID_MODE_32BITUID - Payload based ID, but IP ID for small packets110
ID_MODE_32BITUID_EXT - Extended payload based ID where also the headers are included120
ID_MODE_32BITUID_ONLY - Pure payload based ID, i.e., do not calculate QoS for packets without payload!200
ID_MODE_32BITUID_NAT - NAT bypasser + Payload based ID, but IP ID for small packets210
ID_MODE_32BITUID_ONLY_NAT - NAT bypasser + Pure payload based ID, i.e., do not calculate QoS for packets without payload10
Example
[Measurement]
packet_id_method=50
Packet loss statistics can only be compiled by monitoring if packets detected by one Probe arrive at the seconds one. Each packet is allowed to be ‘late’ by a number of milliseconds before being considered lost.
milliseconds
integer
1
1000
Example
To allow packet delay up to 2 seconds, define this parameter as:
[Measurement]
packet_loss_timer=2000
Packets with a delay above this threshold are counted in QoS Statistics: Th. ex. delay pkts.
integer
microseconds
0
100000
Example
To count packets that have a delay of 500 ms (500000 μs), define this parameter as:
[Measurement]
pk_delay_threshold=500000
Packets with a jitter above this threshold are counted in QoS Statistics: Th. ex. jitter pkts.
integer
microseconds
0
100000
Example
To count packets that have a jitter of 500 ms (500000 μs), define this parameter as:
[Measurement]
pk_jitter_threshold=500000
The hostname of the primary Probe. This can be omitted if the Probe is located on the same device where Scopemon is used.
string
127.0.0.1
Example
If the primary Probe is installed in another device at IP address 192.168.1.43, define this parameter as:
[Measurement]
primary_probe_hostname=192.168.1.43
Capture interface of the primary Probe. Typically 0
is the OS default interface.
integer
0
0
Example
If the capture interface index is 2, define this parameter as:
[Measurement]
primary_probe_interface_index=2
The topological placement of the primary Probe.
10
TOPO_PROBE_END_POINT- Probe is in either one of the endpoints of the measured traffic. In other words, the device Probe is installed to is either sending or receiving the measured network traffic100
TOPO_PROBE_MIDDLE_POINT- Probe is not located at either one of the end-points but instead resides somewhere along the path where the measured traffic traverses200
TOPO_PROBE_EXTERNAL_POINT- Probe is not located within the measurement path at all. This is the case, for example, when using mirror ports in switches10
The port number of the primary Probe. This can be typically omitted unless the port where Probe serves control connections has been changed in Probe configuration.
integer
0
65535
8177
Example
If Probe is configured to serve control connections on port 9776, define this parameter as:
[Measurement]
primary_probe_port=9776
The manual Ethernet senders list of the local Probe. Used only when primary_probe_senders_eth_mode is set to SENDERS_MANUAL or SENDERS_MASK.
Example
[Measurement]
primary_probe_senders_eth_address_list/size=1
primary_probe_senders_eth_address_list/1/address=0
primary_probe_senders_eth_address_list/1/value=0
The Ethernet senders mode of the local Probe.
0
SENDERS_AUTO_SEARCH - Attempt to automatically determine the direction249
SENDERS_MANUAL - Input sender addresses manually250
SENDERS_INVERSE_DEFINITION - Use the inverse definition of the secondary Probe252
SENDERS_MASK - Same as SENDERS_MANUAL, but a mask is used instead of individual addresses0
Example
[Measurement]
primary_probe_senders_eth_mode=0
The manual IPv4 senders list of the local Probe. Used only when primary_probe_senders_ipv4_mode is set to SENDERS_MANUAL or SENDERS_MASK.
Example
[Measurement]
primary_probe_senders_ipv4_address_list/size=1
primary_probe_senders_ipv4_address_list/1/address=0
primary_probe_senders_ipv4_address_list/1/value=0
The IPv4 senders mode of the local Probe.
0
SENDERS_AUTO_SEARCH - Attempt to automatically determine the direction249
SENDERS_MANUAL - Input sender addresses manually250
SENDERS_INVERSE_DEFINITION - Use the inverse definition of the secondary Probe252
SENDERS_MASK - Same as SENDERS_MANUAL, but a mask is used instead of individual addresses0
Example
[Measurement]
senders_p_ipv4_mode=0
Determines whether the pure MAC method is used for defining primary Probe senders. When enabled, no other senders settings are required for the primary Probe.
true
- Pure MAC method is usedfalse
- Pure MAC method is not usedfalse
Sliding window averaging (SWA) window size.
Unsigned integer
0
5
Example
[Measurement]
qoe_swa_window_size=2
0.0
0.5
Example
[Measurement]
qoe_wma_weight_newest=1.0
If a connection cannot be established to the primary Probe, Scopemon waits for a duration specified by this parameter and then attempts to reconnect.
milliseconds
integer
0
1000
Example
To attempt a reconnection after 500 milliseconds, define this parameter as:
[Measurement]
reconnect_interval=500
Qosium Probe can send measurement results to additional receivers during measurement. These receivers must be running the Qosium server, such as Qosium Storage.
Array
address
The IPv4 address of the receiverport
The port number of the receiverExample
To send Qosium results to destinations 127.0.0.1:7700 and 192.168.1.3:7710, define this parameter as:
[Measurement]
use_results_distribution=true
results_distribution_destinations/size=2
results_distribution_destinations/1/address=127.0.0.1
results_distribution_destinations/1/port=7700
results_distribution_destinations/2/address=192.168.1.3
results_distribution_destinations/2/port=7710
The maximum duration the connection to Probes can be re-attempted before giving up.
minutes
integer
1
10
Example
To make the client attempt reconnect 3 for minutes, define this parameter as:
[Measurement]
robust_mode_max_cbd=3
The hostname of the secondary Probe. This can be omitted if the Probe is located on the same device where Scopemon is used.
string
127.0.0.1
Example
If a secondary Probe is installed in another device at IP address 192.168.1.43, define this parameter as:
[Measurement]
secondary_probe_hostname=192.168.1.43
Capture interface of the secondary Probe. Typically 0
is the OS default interface.
integer
0
0
Example
If the capture interface index is 2, define this parameter as:
[Measurement]
secondary_probe_interface_index=2
The topological placement of the secondary Probe.
10
TOPO_PROBE_END_POINT- Probe is in either one of the endpoints of the measured traffic. In other words, the device Probe is installed to is either sending or receiving the measured network traffic100
TOPO_PROBE_MIDDLE_POINT- Probe is not located at either one of the end-points but instead resides somewhere along the path where the measured traffic traverses200
TOPO_PROBE_EXTERNAL_POINT- Probe is not located within the measurement path at all. This is the case, for example, when using mirror ports in switches10
The port number of the secondary Probe. This can be typically omitted unless the port where Probe serves control connections has been changed in Probe configuration.
integer
0
65535
8177
Example
If Probe is configured to serve control connections on port 9776, define this parameter as:
[Measurement]
secondary_probe_port=9776
The manual Ethernet senders list of the secondary Probe. Used only when secondary_probe_senders_eth_mode is set to SENDERS_MANUAL or SENDERS_MASK. See resources/documentation/concepts/senders_receivers for more information.
Example
[Measurement]
secondary_probe_senders_eth_address_list/size=1
secondary_probe_senders_eth_address_list/1/address=0
secondary_probe_senders_eth_address_list/1/value=0
The Ethernet senders mode of the secondary Probe. See resources/documentation/concepts/senders_receivers for more information..
249
SENDERS_MANUAL - Input sender addresses manually250
SENDERS_INVERSE_DEFINITION - Inverts the definition of local Probe252
SENDERS_MASK - Same as SENDERS_MANUAL, but a mask is used instead of individual addresses253
SENDERS_INVERSE_MASK - Same as SENDERS_INVERSE_DEFINITION, but a mask is used instead of individual addresses250
Example
[Measurement]
secondary_probe_senders_eth_mode=0
The manual IPv4 senders list of the secondary Probe. Used only when secondary_probe_senders_ipv4_mode is set to SENDERS_MANUAL or SENDERS_MASK. See resources/documentation/concepts/senders_receivers for more information.
Example
[Measurement]
secondary_probe_senders_ipv4_address_list/size=1
secondary_probe_senders_ipv4_address_list/1/address=0
secondary_probe_senders_ipv4_address_list/1/value=0
The IPv4 senders mode of the secondary Probe. See resources/documentation/concepts/senders_receivers for more information.
249
SENDERS_MANUAL - Input sender addresses manually250
SENDERS_INVERSE_DEFINITION - Use the inverse definition of the primary Probe252
SENDERS_MASK - Same as SENDERS_MANUAL, but a mask is used instead of individual addresses253
SENDERS_INVERSE_MASK - Same as SENDERS_INVERSE_DEFINITION, but a mask is used instead of individual addresses250
Example
[Measurement]
secondary_probe_senders_ipv4_mode=254
Determines whether the pure MAC method is used for defining secondary Probe senders. When enabled, no other senders settings are required for secondary Probe.
true
- Pure MAC method is usedfalse
- Pure MAC method is not usedfalse
Promiscuous mode allows the detection of incoming traffic that is not directed to the selected network interface. This scenario is common when capturing mirrored traffic, e.g., from a switch.
true
- Allow detection of all incoming trafficfalse
- Allow detection of incoming traffic destined only for this interfacetrue
Example
To disable detection of traffic not designated to the network interface, define this parameter as:
[Measurement]
use_promiscuous_mode=false
Enable or disable sliding window averaging (SWA) for quality estimates.
true
- Enable SWAfalse
- Disable SWAfalse
Example
[Measurement]
use_qoe_swa=true
Enable or disable weighted moving averaging (WMA) for quality estimates.
true
- Enable WMAfalse
- Disable WMAfalse
Example
[Measurement]
use_qoe_wma=true
Enable or disable result distribution directly from primary Probe to external result receivers.
true
- Enable result distributionfalse
- Disable result distributionfalse
By default, measurement is performed with one Probe. With this setting, it’s possible to set a two-point measurement.
true
- Perform a two-point measurementfalse
- Perform a single-point measurementfalse
Example
To perform two-point measurement using the local Probe only, define this parameter as:
[Measurement]
use_secondary_probe=false
secondary_probe_hostname=192.168.1.14
secondary_probe_interface_index=4
Uniquely identifies this client in the Probe. Handy for debugging and in large-scale measurement where multiple clients are connected to the same local Probe. Rarely needed in normal use.
integer
0
0
Example
To set an id of 6 for this client, define this parameter as:
[Measurement]
user_id=6
When true, absolute measurement results are written to file. Two files are generated, and the filenames have format pk_qosDL[suffix].txt and pk_qosUL[suffix].txt, and new measurements are appended to the files.
true
- Results are written to filesfalse
- Results are not written to filesfalse
Example
[Measurement]
write_absolute_results=true
When true, average measurement results are written to file. The filename has the format “averages_[suffix].txt”, and new measurements are appended to the file.
true
- Results are written to filefalse
- Results are not written to filefalse
Example
[Measurement]
write_average_results=true
Date code format governs the frequency of file creation when write_multiple_files
. Whenever Scopemon detects a change in the date code, it automatically triggers new result files. A timestamp with this date code is then appended to the filename.
string
yyyyMMdd
Example
To write results every hour, define this parameter as:
[Measurement]
write_multiple_files=true
write_date_code_format=yyyyMMdd-hh
File suffix string when forming a filename for measurement result files.
string
Example
If defined for example as “test”, filenames will begin with the suffix and underscore, e.g. averages_test.txt.
[Measurement]
write_average_results=true
write_filename_suffix=test
When true, flow measurement results are written to file. The filename has the format “flows_[suffix].txt”, and new measurements are appended to the file. This data only contains flow map detected during the measurement, which starts later than the actual flow. Therefore expect the reported flow duration to be shorter. Typically only one flow should be visible.
true
- Results are written to filefalse
- Results are not written to filefalse
Example
[Measurement]
write_flow_results=true
When true, measurement results are written to multiple files. By default, one file is created for each day. For configuring multiple file writing frequency, see write_date_code_format.
true
- Results are written to multiple filesfalse
- All results are written into a single filefalse
Example
[Measurement]
write_average_results=true
write_flows=true
write_multiple_files=true
When true, packet measurement results are written to file. The filename has the format “pkinfo[suffix].txt”, and new measurements are appended to the file.
true
- Results are written to filefalse
- Results are not written to filefalse
Example
[Measurement]
write_packet_results=true
Set to override the path where measurement result files are stored. Use /
as the directory separator.
string
Example
[Measurement]
write_path=c:/temp
Scopemon is configured via parameters. This reference lists all available parameters, default values, allowed values, and examples for GQoSM configuration.
Scopemon is configured via parameters. This reference lists all available parameters, default values, allowed values, and examples for PSQA configuration.