Documentation forWeb Performance Monitor

Learn about the WPM Recorder configuration file

Changes to WPM Recorder can be made in the RecorderSettings.dat, located at: %ProgramData%/Solarwinds/SEUM/Data/.

This file will be automatically created during the first run of WPM Recorder after installing or reinstalling WPM and will not be recreated nor removed during product upgrades. If you uninstall WPM, the RecorderSettings.dat file will be removed during the uninstall process.

However, if any custom changes were made before upgrading WPM Recorder, you will need to manually upgrade/migrate the content of the config.yaml file and WPMRecorder.exe.config file properties to RecorderSettings.dat.

Recorder configuration settings

The RecorderSettings.dat file includes the following customizable settings.

  • On Windows, the file is located at: %ProgramData%/Solarwinds/SEUM/Data/.
  • On macOS, the file is located at: /Users/<USERNAME>/Library/Application Support/WPMRecorder/RecorderSettings.dat.

proxyUrL

The URL to your proxy server.

<proxyUrl></proxyUrl>

minTLSVersion

The lowest Transport Layer Security version. By default, the value is tls1.2, which is recommended version, but tls1.3 is also supported.

<minTLSVersion>tls1.2</minTLSVersion>

disableWebSecurity

Allows the recorder to interact and record iFrame content on a page when the value is set to True. By default, the value is False.

<disableWebSecurity>false</disableWebSecurity>

electronSwitches

Command line switches supported by Electron that can modify the function of a command. For a complete list of available switches, see Supported Command Line Switches.

<electronSwitches>
  <switch>--disable-backgrounding-occluded-windows</switch>
  <switch>--ignore-certificate-errors</switch>
  <switch>--disable-gpu</switch>
  <!-- <switch>2&gt;&amp;1</switch> -> 2>&1 example of how to handle special chars -->
</electronSwitches>

fileDownloadExtensions

Includes or excludes extensions from DefaultWellKnownFileExtensions list, allowing for a change of what extensions can be found in the URL that the WPM Recorder will use to execute navigation. If the extension is found in the URL, the WPM Recorder will try to download the resource as a file instead of loading it in the browser. WPM includes a predefined list of MIME types as DefaultWellKnownFileExtensions listed below.

DefaultWellKnownFileExtensions: [
    "aac", "abw", "arc", "avif", "avi", "azw", "bin", "bmp", "bz",
    "bz2", "cda", "csh", "css", "csv", "doc", "docx", "eot", "epub",
    "gz", "gif", "ico", "ics", "jar", "jpeg", "jpg",
    "js", "json", "jsonld", "mid", "midi", "mjs", "mp3", "mp4", "mpeg",
    "mpkg", "odp", "ods", "odt", "oga", "ogv", "ogx", "opus", "otf", "png",
    "pdf", "ppt", "pptx", "rar", "rtf", "sh", "svg", "tar", "tif", "tiff",
    "ts", "ttf", "txt", "vsd", "wav", "weba", "webm", "webp", "woff", "woff2",
    "xls", "xlsx", "xml", "xul", "zip", "3gp", "3g2", "7z",
    // 'htm', 'html', 'xhtml', 'php', // excluded from original list
    "exe", "dll", "lib", "msi", "cert", // added manually
    "recording", "web-recording", // WPM extensions
];

For a full list of extensions, see Common MIME types.

    <fileDownloadExtensions>
        <include>
          <extension>PDF</extension>
          <extension>JPEG</extension>
          <extension>ZIP</extension>
        </include>
        <exclude>
          <extension>PNG</extension>
          <extension>AVI</extension>
          <extension>RAR</extension>
        </exclude>
      </fileDownloadExtensions>

Probe configuration settings

Probe configuration settings are used by the probe process, which is started by the WPM Recorder.

imageMatchSimilarityFactor

The similarity ratio of the image match action. The value can be set between 0-1 and 0.99 is the default value. For more information, see Use Image Match in the WPM recordings and Image Classification using SSIM.

<imageMatchSimilarityFactor>0.99</imageMatchSimilarityFactor>

imageMatchScrollXInterval

The number of pixels where the image match action will stop scrolling horizontally when attempting to find the image. The recommended maximum is 100.

<imageMatchScrollXInterval>100</imageMatchScrollXInterval>

imageMatchScrollYInterval

The number of pixels where the image match action will stop scrolling vertically when attempting to find the image. The recommended maximum is 100.

<imageMatchScrollYInterval>100</imageMatchScrollYInterval>

findElementTimeout

The number of seconds the recorder will search for a page element requiring an action before timing out. The recommended maximum value is 5 seconds.

<findElementTimeout>5.0</findElementTimeout>

findElementRetryInterval

The number of seconds the recorder will wait before trying again to find the page element. The recommended maximum value is 5 seconds.

<findElementRetryInterval>0.5</findElementRetryInterval>

pageReloadTimeout

The number of seconds the recorder waits for the page to load after the initiating navigation to a page. The recommended maximum value is 10 seconds.

<pageReloadTimeout>10.0</pageReloadTimeout>

Chromedriver

scriptExecutionTimeoutS

The number of seconds the recorder will attempt to execute JavaScripts on a website during playback. The recommended maximum value is 30 seconds.

<chromedriver>
  <scriptExecutionTimeoutS>30</scriptExecutionTimeoutS>
</chromedriver>

Example content of RecorderSettings.dat

<configuration>
  <recorderConfiguration>
    <proxyUrl></proxyUrl>
    <minTLSVersion>tls1.2</minTLSVersion>
    <disableWebSecurity>false</disableWebSecurity>
    <electronSwitches>
      <switch>--disable-backgrounding-occluded-windows</switch>
      <switch>--ignore-certificate-errors</switch>
      <switch>--disable-gpu</switch>
      <!-- <switch>2&gt;&amp;1</switch> -> 2>&1 example of how to handle special chars -->
    </electronSwitches>
    <fileDownloadExtensions>
        <include>
          <extension>PDF</extension>
          <extension>JPEG</extension>
          <extension>ZIP</extension>
        </include>
        <exclude>
          <extension>PNG</extension>
          <extension>AVI</extension>
          <extension>RAR</extension>
        </exclude>
      </fileDownloadExtensions>
  <recorderConfiguration>
  <probeConfiguration>
    <imageMatchSimilarityFactor>0.99</imageMatchSimilarityFactor>
    <imageMatchScrollXInterval>100</imageMatchScrollXInterval>
    <imageMatchScrollYInterval>100</imageMatchScrollYInterval>
    <findElementTimeout>5.0</findElementTimeout>
    <findElementRetryInterval>0.5</findElementRetryInterval>
    <pageReloadTimeout>10.0</pageReloadTimeout>
    <chromedriver>
      <scriptExecutionTimeoutS>30</scriptExecutionTimeoutS>
    </chromedriver>
  </probeConfiguration>
</configuration>

See also: