Type alias Config

Config: typeof schemaProperties

The configuration properties are applied in the following order (from higher to lower precedence):

  • arguments passed to the executable in kebab case (e.g. --url-query);
  • environment variables in uppercase snake format (e.g. URL_QUERY);
  • config.json configuration file;
  • default values.

url

The page url to load.

Type: string

Default: ""

urlQuery

The query string to append to the page url; the following template variables are replaced: $p the process pid, $s the session index, $S the total sessions, $t the tab index, $T the total tabs per session, $i the tab absolute index.

Type: string

Default: ""

customUrlHandler

This argument specifies the file path for the custom page URL handler that will be exported by default. The custom page URL handler allows you to define custom URLs that can be used to open your application, and provides the following variables for customization: $p: the process pid, $s: the session index, $S: the total sessions, $t: the tab index, $T: the total tabs per session, $i: the tab absolute index. You can use these variables to create custom URL schemes that suit your application's needs.

Type: string

Default: ""

videoPath

The fake video path; if set, the video will be used as fake media source. It accepts a single path or a comma-separated list of videos paths that will be used in round-robin by the started sessions. The docker pre-built image contains a 2 minutes video sequence stored at /app/video.mp4. It accepts a local file, an http endpoint or a string starting with generate: (example: generate:null will generate a black video with silent audio). The temporary files containing the raw video and audio will be stored at ${VIDEO_CACHE_PATH}/video.${VIDEO_FORMAT} and ${VIDEO_CACHE_PATH}/audio.wav.

Type: string

Default: "https://github.com/vpalmisano/webrtcperf/releases/download/v2.0.4/video.mp4"

videoWidth

The fake video resize width.

Type: positive int

Default: 1280

videoHeight

The fake video resize height.

Type: positive int

Default: 720

videoFramerate

The fake video framerate.

Type: positive int

Default: 25

videoSeek

The fake audio/video seek position in seconds.

Type: positive int

Default: 0

videoDuration

The fake audio/video duration in seconds.

Type: positive int

Default: 120

videoCacheRaw

If the temporary video and audio raw files can be reused across multiple runs.

Type: boolean

Default: true

videoCachePath

The path where the video and audio raw files are stored.

Type: string

Default: "/home/runner/.webrtcperf/cache"

videoFormat

The fake video file format presented to the browser.

Type: [ "y4m", "mjpeg" ]

Default: "y4m"

runDuration

If greater than 0, the test will stop after the provided number of seconds.

Type: positive int

Default: 0

throttleConfig

A JSON5 string with a valid network throttling configuration. Example: 

[{
  sessions: '0-1',
  device: 'eth0',
  protocol: 'udp',
  up: {
    rate: 1000,
    delay: 50,
    loss: 5,
    queue: 10,
  },
  down: [
    { rate: 2000, delay: 50, loss: 2, queue: 20 },
    { rate: 1000, delay: 50, loss: 2, queue: 20, at: 60 },
  ]
}]

The sessions field represents the sessions IDs range that will be affected by the rule, e.g.: "0-10", "2,4" or simply "2". The device, protocol, up, down fields are optional. When device is not set, the default route device will be used. If protocol is specified ('udp' or 'tcp'), only the packets with the specified protocol will be affected by the shaping rules. When running as regular user, add the following sudo configuration:

%sudo ALL=(ALL) NOPASSWD: /usr/sbin/iptables,/usr/sbin/addgroup,/usr/sbin/adduser,/usr/sbin/tc,/usr/sbin/modprobe,/usr/sbin/ip

Type: string

Default: ""

randomAudioPeriod

If not zero, it specifies the maximum period in seconds after which a new random active tab is selected, enabling the getUserMedia audio tracks in that tab and disabling all of the other tabs.

Type: positive int

Default: 0

randomAudioProbability

When using random audio period, it defines the probability % that the selected audio will be activated (value: 0-100).

Type: positive int

Default: 100

randomAudioRange

When using random audio period, it defines the number of pages to be included into the random selection.

Type: positive int

Default: 0

chromiumPath

The Chromium executable path.

Type: string

Default: ""

chromiumRevision

The Chromium revision number. It will be downloaded if the chromium path is not provided.

Type: string

Default: "1108766"

chromiumUrl

The remote Chromium URL (http://HOST:PORT). If provided, the remote instance will be used instead of running a local chromium process.

Type: string

Default: ""

chromiumFieldTrials

Chromium additional field trials (comma-separated).

Type: string

Default: ""

windowWidth

The browser window width.

Type: positive int

Default: 1920

windowHeight

The browser window height.

Type: positive int

Default: 1080

deviceScaleFactor

The browser device scale factor.

Type: positive int

Default: 1

maxVideoDecoders

Specifies the maximum number of concurrent WebRTC video decoder instances that can be created on the same host. If set it will disable the received video resolution and jitter buffer stats. This option is supported only when using the custom chromium build. The total decoders count is stored into the virtual file /dev/shm/chromium-video-decoders

Type: number

Default: -1

maxVideoDecodersAt

Applies the maxVideoDecoders option starting from this session ID.

Type: number

Default: -1

incognito

Runs the browser in incognito mode.

Type: boolean

Default: false

display

If unset, the browser will run in headless mode. When running on MacOS or Windows, set it to any not-empty string. On Linux, set it to a valid X server DISPLAY string (e.g. :0).

Type: string

Default: ""

sessions

The number of browser sessions to start.

Type: positive int

Default: 1

tabsPerSession

The number of tabs to open in each browser session.

Type: positive int

Default: 1

startSessionId

The starting ID assigned to sessions.

Type: positive int

Default: 0

startTimestamp

The start timestamp (in milliseconds). If 0, the value will be calculated using Date.now()

Type: positive int

Default: 0

enableDetailedStats

If true, each individual participant stats values will be reported.

Type: boolean

Default: false

spawnRate

The pages spawn rate (pages/s).

Type: float

Default: 1

showPageLog

If true, the pages console logs will be shown on console.

Type: boolean

Default: true

pageLogFilter

If set, only the logs with the matching text will be printed on console. Regexp string allowed.

Type: string

Default: ""

pageLogPath

If set, page console logs will be saved on the selected file path.

Type: string

Default: ""

userAgent

The user agent override.

Type: string

Default: ""

scriptPath

One or more JavaScript file paths (comma-separated). If set, the files contents will be executed inside each opened tab page; the following global variables will be attached to the window object: WEBRTC_PERF_SESSION the session number (0-indexed); WEBRTC_PERF_TAB the tab number inside the same session (0-indexed); WEBRTC_PERF_INDEX the page absolute index (0-indexed).

Type: string

Default: ""

scriptParams

Additional parameters (in JSON format) that will be exposed into the page context as window.PARAMS.

Type: string

Default: ""

getUserMediaOverride

A JSON string with the getUserMedia constraints to override for each tab in each session; e.g. {"video": {"width": 360, "height": 640}}

Type: string

Default: ""

getDisplayMediaOverride

A JSON string with the getDisplayMedia constraints to override for each tab in each session; e.g. {"video": {"width": 360, "height": 640}}

Type: string

Default: ""

disabledVideoCodecs

A string with the video codecs to disable (comma-separated); e.g. vp9,av1

Type: string

Default: ""

getDisplayMediaType

The fake display type to use for getDisplayMedia. It could be monitor, window or browser,

Type: string

Default: "monitor"

getDisplayMediaCrop

An HTML selector used for cropping the getDisplayMedia video track.

Type: string

Default: ""

localStorage

A JSON string with the localStorage object to be set on page load.

Type: string

Default: ""

clearCookies

If true, all the page cookies are cleared.

Type: boolean

Default: false

enableGpu

It enables the GPU acceleration (experimental). Set to "desktop" to use the host X server instance.

Type: string

Default: ""

enableBrowserLogging

It enables the Chromium browser logging to standard output.

Type: boolean

Default: false

blockedUrls

A comma-separated list of request URLs that will be automatically blocked.

Type: string

Default: ""

extraHeaders

A dictionary of headers keyed by the url in JSON5 format (e.g. { "https://url.com/*": { "header-name": "value" } }).

Type: string

Default: ""

responseModifiers

A dictionary of content replacements keyed by the url in JSON5 format (e.g. { "https://url.com/*": [{ search: "searchString": replace: "anotherString" }] }).The search string should be a valid regular expression.

Type: string

Default: ""

extraCSS

A string with a CSS styles to inject into each page. Rules containing "important" will be replaced with "!important".

Type: string

Default: ""

cookies

A string with the cookies to set into each page in JSON format.

Type: string

Default: ""

debuggingPort

The chrome debugging port. If this value != 0, the chrome instance will listen on the provided port + the start-session-id value.

Type: positive int

Default: 0

debuggingAddress

The chrome debugging listen address. Valid only if debugging-port is provided.

Type: string

Default: "127.0.0.1"

showStats

If the statistics should be displayed on the console output.

Type: boolean

Default: true

statsPath

The log file path; if set, the stats will be written in a .csv file inside that file.

Type: string

Default: ""

detailedStatsPath

The log file path; if set, the detailed stats will be written in a .csv file inside that file.

Type: string

Default: ""

statsInterval

The stats collect interval in seconds. It should be lower than the Prometheus scraping interval.

Type: positive int

Default: 15

rtcStatsTimeout

The timeout in seconds after which the RTC stats coming from inactive hosts are removed. It should be higher than the statsInterval value.

Type: positive int

Default: 60

customMetrics

A dictionary of custom metrics keys in JSON5 format (e.g. '{ statName1: { labels: ["label1"] } }').

Type: string

Default: ""

prometheusPushgateway

If set, logs are sent to the specified Prometheus Pushgateway service (example: "http://127.0.0.1:9091").

Type: string

Default: ""

prometheusPushgatewayJobName

The Prometheus Pushgateway job name.

Type: string

Default: "default"

prometheusPushgatewayAuth

The Prometheus Pushgateway basic auth (username:password).

Type: string

Default: ""

prometheusPushgatewayGzip

Allows to use gzip encoded pushgateway requests.

Type: boolean

Default: true

alertRules

Alert rules definition (in JSON format).

Type: string

Default: ""

alertRulesFilename

The alert rules report output filename.

Type: string

Default: ""

alertRulesFailPercentile

The alert rules report fails percentile (0-100). With the default value the alert will be successful only when at least 95% of the checks pass.

Type: positive int

Default: 95

pushStatsUrl

The URL to push the collected stats.

Type: string

Default: ""

pushStatsId

The ID of the collected stats to push.

Type: string

Default: "default"

serverPort

The HTTP server listening port.

Type: positive int

Default: 0

serverSecret

The HTTP server basic auth secret. The auth user name is set to admin by default.

Type: string

Default: "secret"

serverUseHttps

If true, the server will use the HTTPS protocol.

Type: boolean

Default: false

serverData

An optional path that the HTTP server will expose with the /data endpoint.

Type: string

Default: ""

vmafPath

When set, it runs the VMAF calculator for the videos saved under the provided directory path.

Type: string

Default: ""

vmafPreview

If true, for each VMAF comparison it creates a side-by-side video with the reference and degraded versions.

Type: boolean

Default: false

vmafKeepIntermediateFiles

If true, the VMAF intermediate files will not be deleted.

Type: boolean

Default: false

vmafKeepSourceFiles

If true, the VMAF source files will not be deleted.

Type: boolean

Default: true

Settings

Member Visibility

Theme

On This Page