ThousandEyes Documentation
  • ThousandEyes Documentation
  • What's New
    • Changelog
    • Naming and Navigation Menu Changes - Summary List
  • Product Documentation
    • Getting Started
      • Getting Started with Account Setup
      • Getting Started with Cloud and Enterprise Agents
      • Getting Started with Cloud and Enterprise Agent Tests
      • Getting Started with Endpoint Agents
      • Getting Started with Transactions
      • Getting Started with Dashboards
      • Getting Started with Alerts
      • Getting Started with Internet Insights
      • Getting Started with the ThousandEyes API
      • Getting Started with API Tests
      • Getting Support from ThousandEyes
      • Notification of Upgrades, Maintenance and Outages
      • New User FAQ
      • ThousandEyes Glossary
    • Global Vantage Points
      • Cloud Agents
        • Where Are Cloud Agents Available?
        • Webex Cloud Agents
        • AWS Wavelength Cloud Agents
        • Cloud Agent with Local Problems
      • Enterprise Agents
        • Getting Started
          • Where Can I Get the Account Group Token?
        • Installing
          • Enterprise Agent System Requirements
            • Enterprise Agent Support Lifecycle
          • Appliances
            • How to Set Up the Virtual Appliance
            • Enterprise Agents: Hypervisor Installation
            • Installing Enterprise Agent on VirtualBox
            • Enterprise Agent Deployment Using ThousandEyes Virtual Appliance (Hyper-V)
            • Enterprise Agent Deployment Using ThousandEyes Virtual Appliance (OVA)
            • Custom Virtual Appliances
            • Installing a Physical Appliance
            • Installing an Enterprise Agent on a Raspberry Pi Device
          • Cisco Devices
            • Catalyst Switching
            • Catalyst Routing
            • Nexus Switching
            • Service Routing
            • Meraki MX Appliances
            • Cisco Enterprise NFV Infrastructure Software
            • Installation Methods
              • Installing Enterprise Agents on Cisco Nexus Switches with Application Hosting
              • Installing Enterprise Agents on Cisco Nexus Switches with Guestshell
              • Installing Enterprise Agents on Cisco Routers using SD-WAN Manager Feature Templates
              • Installing Enterprise Agents on Cisco Routers using the SD-WAN Manager ThousandEyes Workflow
              • Installing Enterprise Agents on Cisco Switches with Docker
              • Installing Enterprise Agents on Cisco Routers with Docker
              • Installing Enterprise Agents on Cisco Switches with the DNA Center
          • Linux Packages
            • Enterprise Agent Deployment Using Linux Package Method
            • Installing the Enterprise Agent with BrowserBot on Oracle Linux Server 7
          • Docker Agents
            • Installing Enterprise Agents with Docker
          • Cloud Templates
            • Installing Enterprise Agents with Microsoft Azure
          • Docker Agent Configuration Options
          • Missing Dependencies for Enterprise Agent on Redhat Enterprise Linux RHEL 7 Installation
          • Migrating ThousandEyes Appliance or Package-Based Enterprise Agent to Docker
        • Configuring
          • Password Reset on the Virtual Appliance
          • Configuring rDNS Lookups for Enterprise Agents
          • Connecting to the ThousandEyes Virtual Appliance Using SSH (Mac/Linux)
          • Connecting to the ThousandEyes Virtual Appliance Using SSH (Windows)
          • Static IP Addresses for ThousandEyes Repositories
          • Firewall Configuration for Enterprise Agents
          • Enterprise Agent Port Forwarding
          • Security Policy and Public NTP Servers on Enterprise Agents
          • Secure Access to ThousandEyes Appliances
          • Disabling the Web Server of a Virtual Appliance
          • NAT Traversal for Agent-to-Agent Tests
          • Enterprise Agent on Docker Advanced Networking
        • Managing
          • Cisco Devices
            • Disable, Restart, or Uninstall the Enterprise Agent via DCNM
          • Docker Agents
            • Add/Remove BrowserBot from Existing Docker Enterprise Agents
          • Upgrading Operating Systems for Enterprise Agents
          • Backup and Restore Your Enterprise Agent Configuration
          • Upgrade Ubuntu 20.04 Focal-Based ThousandEyes Appliances
          • Crash Reporting for Enterprise Agents
          • Configuring a Local Mirror of the ThousandEyes Package Repository
          • Resetting an Enterprise Agent
          • Working with Enterprise Agent Clusters
          • Replacing an Enterprise Agent Using the Agent Clustering Method
          • Replacing an Enterprise Agent Using Agent Identity Files
          • Unlocking the ThousandEyes Appliance
          • Uninstalling the Enterprise Agent (Linux Package)
        • Proxy Environments
          • Installing Enterprise Agents in Proxy Environments
          • Configuring an Enterprise Agent to Use a Proxy Server
          • Writing and Testing Proxy Auto-Configuration (PAC) Files
        • Troubleshooting
          • How to Generate Packet Captures
          • Troubleshooting Automatic-Update Problems on Enterprise Agents
          • Troubleshooting Time Synchronization on Enterprise Agents
          • Installing CA Certificates on Enterprise Agents
          • Agent Unable to Trace Path to Destination?
          • BrowserBot Installation Fails on Red Hat or CentOS in Amazon EC2
          • What to Do If te-agent Stops Running Due to a VACUUM Error
        • Enterprise Agents: What Information Do We Collect?
        • What Is BrowserBot?
        • Upgrading to BrowserBot 2
        • Upgrading to BrowserBot 2.6+ (Chromium 97)
        • Enterprise Agent Utilization
        • Network Utilization from Enterprise Agent Test Traffic
        • Enterprise Agent Interface Selection
        • ThousandEyes Product Lifecycle Policy
      • Endpoint Agents
        • Installing
          • System Requirements
          • Download the Endpoint Agent Installer
          • Install the Endpoint Agent
          • Reinstall the Endpoint Agent
          • Install the Endpoint Agent Browser Extension
          • Install Endpoint Agents for Windows via Group Policy
          • Installing Browser Extensions for Windows via Group Policy
          • Guidance for Windows Software Deployment Teams
          • Install Endpoint Agents for macOS using Munki and the Managed Software Center
          • Deploy an MSI package to Intune for Windows Devices
          • Endpoint Agent Installation on Cisco Webex Devices (RoomOS)
          • Endpoint Agent Installation on Cisco Phone Devices (PhoneOS)
          • Uninstall or Delete an Endpoint Agent
          • Endpoint Agent Installation Reference
          • NPCAP Driver Upgrade Management
        • Configuring
          • Configure Endpoint Agent Labels
          • Endpoint Agent Proxy Configuration for Scheduled Tests
        • Managing
          • Manage Endpoint Agent Settings
        • How Does the Endpoint Agent Work
        • Cisco Secure Client ThousandEyes Endpoint Agent Module
        • Endpoint Agent Licensing
        • Assigning tests to an Endpoint Agent
        • Data Collected by Endpoint Agent
        • Reporting on data collected by Endpoint Agent
        • Endpoint Agent VPN Support
        • Endpoint Agent TCP Support
        • Endpoint Agent End-user Experience
        • Endpoint Agent FAQ
      • Working with Agent Settings
      • Obtaining a list of ThousandEyes Agent IP Addresses with te-iplist
    • Tests
      • HTTP Server Tests
        • Collecting Proxy Metrics
        • POSIX Extended Regular Expression Syntax (Quick Reference)
        • POSIX Extended Regular Expression Syntax
        • Custom User-Agent Strings in a Web Test
        • Two-Step HTTP Testing (OAuth)
      • Web-Layer Tests
      • Network Tests
        • Network Tests Explained
        • Agent-to-Agent Test Overview
        • DSCP Options in Network Tests
      • DNS Tests
      • Voice Tests
        • SIP Server Test Settings
        • RTP Stream Test Settings
        • Using the SIP Server View
        • Using the RTP Stream View
      • BGP Tests
        • Inside-Out BGP Visibility
        • Using the BGP Route Visualization View
        • Using the BGP Updates Table
        • Working with Raw BGP Data
        • Reasons for Failure of Private Peering with ThousandEyes
        • RPKI
      • API Tests
        • Using the API Test Step Builder
      • Templates
        • User-defined Templates
      • Recommendations
        • Associated Service Recommendations
        • AWS Test Recommendations
      • ThousandEyes Metrics: What Do Your Results Mean?
      • Sharing Test Data
      • Working with Test Settings
      • Scheduled Versus Instant Tests
      • Working with Instant Tests
      • Working with Labels for Agent and Test Groups
      • Multi-Service Views
      • Identifying Traffic from ThousandEyes Agents
      • Excluding ThousandEyes Agents from Google Analytics
    • Internet and WAN Monitoring
      • Path Visualization
        • How Path Trace Works
        • MPLS Tunnel Inference Using Deep Path Analysis
        • Troubleshooting
          • Reasons for Missing Information on the Visualization View
          • Virtual Machine with NAT Breaks Path Visualization
          • Cisco ASA Breaks Path Visualization
          • Path Visualization: Edge Firewall Incorrectly Shows a Single Hop to the Destination
          • Network Overview Shows Packet Loss That Does Not Appear in Path Visualization
      • Views
        • Using the Network Overview
        • Using the FTP Server View
        • Using the HTTP Server View
        • Using the DNS Server View
        • Using the DNS Domain Trace View
        • Using the DNSSEC Trace View
        • Using the API Test Views
      • Troubleshooting
        • CLI Network Troubleshooting Utilities
        • HTTP Server Test Fails with SSL Error
        • HTTP Server Test Fails with SSL Error: OpenSSL SSL_connect: SSL_ERROR_SYSCALL
        • HTTP Server Test Error "dh Key Too Small"
    • Browser Synthetics
      • Browser Synthetics Test Types
      • Browser Synthetics Disambiguation
      • Test Settings for Page Load and Transaction Tests
      • Navigating Waterfall Charts for Page Load and Transaction Tests
      • Using Round Robin Test Scheduling
      • What Information Is Transmitted in a Page Load or Transaction Test?
      • Transaction Test SSO Support
        • Implementing SSO in Transaction Scripts
        • Caveats for NTLM/Kerberos Authentication
        • TOTP Examples for SSO
      • Page Load Tests
        • When to Use a Page Load Test
        • Creating a Page Load Test
        • Using the Page Load View
        • How to Generate a HAR File
        • Migrating to Single Interval for Page Load Tests
        • Creating a Page Load Test that Uses SSO
      • Transaction Tests
        • Getting Started With Transaction Tests
          • When to Use a Transaction Test
          • Transaction Tests Compared With Other Test Types
          • ThousandEyes Recorder
          • ThousandEyes Recorder Permissions
          • Working With Web Development Tools
          • Working With Secure Credentials
          • Transaction Test Table Tab View
          • Transaction Metrics on Alerts and Dashboards
          • Screenshots in Transaction Test Views
        • Transaction Test Development Guide
          • Creating Robust Transaction Scripts
            • Optimizing and Troubleshooting Transaction Scripts
            • Transaction Scripting Tips and Tricks
          • Transactions – Executing Custom JavaScript Code
        • Use Cases | Code Examples
          • Uploading or Downloading Files in a Script
            • Transaction Scripting Examples for File Downloads
          • Include API Calls in a Transaction Test
            • Using the node-fetch module
            • Using the net module
            • Using the tls module
        • Transaction Scripting Reference
      • Dual Chromium Option
        • Why Are Regular Chromium Upgrades Needed?
        • Configuring Dual Chromium
        • Working With Dual Chromium
        • Chromium Update History
        • Chromium Upgrade Known Issues
    • Endpoint Experience
      • Test Settings
        • Monitoring an Application using Synthetic Tests
        • Configuration Options for Synthetic Tests
        • Managing Synthetic Tests
        • Real User Tests
      • Viewing Data
        • Endpoint Agent Scheduled Tests View
        • Endpoint Agent Real User Tests View
        • Endpoint Agent Local Networks View
        • Endpoint Agent Dynamic Tests View
        • Endpoint Agent Views
        • Endpoint Views Reference
      • Troubleshooting
        • Step-by-Step Guide to Troubleshooting Endpoint Agent Problems
        • Troubleshooting Endpoint Agent Issues
    • Connected Devices
      • Connected Devices Tests
        • Routing
          • Traceroute
        • Network
          • Speed Tests
          • Latency, Loss, Disconnections, and Jitter Tests
          • Responsiveness (Latency under Load) Tests
        • DNS
          • DNS Resolution Tests
        • Web
          • Web Browsing Lite Tests
          • Generic Streaming (HLS/DASH) Tests
        • Voice
        • Dynamic Application Test Suites
          • Gameplay Test Suite
          • Video Conferencing Test Suite
          • Social Media Test Suite
          • Game Store Test Suite
          • Video Streaming Test Suite
            • Netflix Streaming Tests
            • YouTube Streaming Tests
            • BBC iPlayer Streaming Tests
          • Content Delivery Network (CDN) Test Suite
        • Local Network Information
          • Data Usage
      • Test Management
        • Test Triggers
          • Scheduled Tests
          • Instant Tests
        • Testing Thresholds
        • Test Targets
          • Test Server Methodology
        • Automatic Test Configuration Retrieval
      • Device Agents
        • Router Agents
          • Router Agent Device Support
        • Connected Devices Agent Release Versions
      • Usage Guides
        • Viewing Charts
        • Configuring Charts
        • Using Maps
        • Exporting Data
        • Importing Metadata
        • Managing Metadata
        • Creating Reports
        • Viewing Agents
        • Using Test Schedules
        • Accessing Your APIs
        • Using ConstantCare
      • Cisco Real Speed
    • Cloud Insights
      • Integrations
      • Views
      • Settings
    • Traffic Insights
      • Traffic Insights System Requirements
      • Traffic Insights Configuration Guide
      • Traffic Insights Views and Settings
      • Traffic Insights FPS Monitoring
    • WAN Insights
      • WAN Insights Quick Start
        • How to Activate ThousandEyes WAN Insights
        • WAN Insights Introductory Tour, Part 1
        • WAN Insights Introductory Tour, Part 2
        • WAN Insights Introductory Tour, Part 3
      • Introducing WAN Insights
        • What Is WAN Insights?
        • WAN Insights Value-Add
        • Why Use WAN Insights?
        • Using WAN Insights Together With ThousandEyes Network Assurance
        • Using WAN Insights Together with vAnalytics and vManage
        • WAN Insights Key Components
        • Enabling WAN Insights
        • Getting Support for WAN Insights
      • WAN Insights Terminology and Reference
      • WAN Insights Technical Overview
        • Application Categories
        • Sites, Routers, Paths, and Interfaces
        • Application Traffic Types
        • Estimating User Counts
        • Estimating Throughput
        • Capacity Planning
        • Understanding Quality
        • Life of a Recommendation
        • Understanding Recommendations
        • WAN Insights and ThousandEyes Alerts
      • WAN Insights User Interface
        • Logging In for the First Time
        • WAN Insights Screens and Workflows
        • Recommendations Screen
        • Recommendation Cards, Explained
        • Recommendation Details Modal
        • Endpoint-Pair Quality Comparison
        • Site Details Screen
        • Capacity Planning Screen
        • Capacity Detail Modal
        • Enter or Upload Bandwidth Data
      • Common Tasks
        • Adding Business-Critical Applications to WAN Insights
        • Email Notifications
        • Adding and Managing WAN Insights Users
        • Applying WAN Insights Recommendations
    • Internet Insights
      • Internet Insights Terminology
      • Limited Outage Map
      • Internet Insights Screens
        • Overview Screen
        • Internet Insights Service Views Screen
        • Application Outages
        • Network Outages
        • Catalog Settings Screen
      • Saving and Sharing from Internet Insights
      • Configuring Internet Insights
      • Provider Labels
      • Using Alerts and Dashboards With Internet Insights
        • My Affected Tests
        • Setting Up Alert Rules for Internet Insights
        • Using the Internet Insights Built-In Dashboard
    • Event Detection
    • Alerts
      • Creating and Editing Alert Rules
        • Global and Location Alert Conditions
        • Alert Rule Severity
        • Adaptive Alert Detection
        • Dynamic Baselines
        • Transport Layer Security (TLS) Alerts
        • Alert Rules for Devices
        • Alert Metrics Reference
      • Default Alert Rules
      • Viewing Alerts
      • Alert Clearing
        • Alert Suppression Windows
      • Alert Notifications
      • Standard Notification Methods
        • Alert Notifications via Email
        • Alert Notifications via SMS
        • Classic Webhooks for Alert Notifications
    • Dashboards
      • Using the Dashboard
      • Customizing Your Dashboard
      • Using the Dashboard Templates
      • Dashboard Widgets
      • Embedding Dashboard Widgets in External Web Sites
      • Excluding Periods of Data From a Dashboard
      • Dashboard Sharing and Snapshots
      • Dashboard Labels
      • Troubleshooting with Dashboard Drill Down
      • Tailoring Dashboards with Dashboard Filters
    • Device Layer
      • Discovering Device-Layer Devices
      • Device Discovery Results
      • Using the Device Layer View
    • Account Management
      • User Registration
        • SAML JIT Provisioning
        • ThousandEyes Support for SCIM
          • How to Configure SCIM with Azure Active Directory
          • How to Configure SCIM with Okta
      • Authorization
        • Role-Based Access Control
          • Role-Based Access, Explained
          • Built-In Roles and Permissions
        • Account Groups
          • What is an Account Group?
          • Working with Account Settings
          • Users in Multiple Organizations
          • Changing Ownership of a Test
          • Working with Time Zone Settings
        • OAuth 2.0 with ThousandEyes
          • Integrations with OAuth 2.0
        • Adding a Profile Image with Gravatar
      • Authentication
        • Logging In
        • How to Configure Single Sign-On
      • User Activity
        • Working with the Activity Log
        • ThousandEyes User Session Timeouts and Terminations
        • How Long is my Data Accessible via ThousandEyes?
        • Retaining Data Beyond the 90-Day Limit
        • Multi-Region Cloud Support
      • Usage-Based Billing
        • About Our Consumption Model
          • Device Agent Consumption Model
        • About Units
        • Test Type Layers and Units
        • Setting Quotas
        • Calculating Units
        • FAQs: Usage
      • Customer Security and Privacy Responsibilities
    • Integrations
      • Custom Webhooks
        • Using OAuth 2.0 Authentication for Your Custom Webhook
        • Webhook Variables
      • Custom Webhook Examples
        • Microsoft Teams for Alert Notifications
        • Cisco Webex for Alert Notifications
        • Google Chat for Alert Notifications
        • Event-Driven Ansible for Alert Notifications
        • Splunk Alert Notification
      • Custom-Built Integrations
        • PagerDuty for Alert Notifications
        • ServiceNow for Alert Notifications
          • Incident Management
        • Slack for Alert Notifications
        • AppDynamics for Alert Notifications
        • AppDynamics for Test Recommendations
        • AWS for Test Recommendations
        • AWS for Cloud Insights
          • AWS for Cloud Insights Using CLI
        • Meraki for Data Enrichment
        • Webex Control Hub Integration
        • Microsoft Teams Integration
        • ThousandEyes for OpenTelemetry
          • Configuring ThousandEyes for OpenTelemetry
            • Configuring ThousandEyes for OpenTelemetry Using the API
            • Configuring ThousandEyes for OpenTelemetry Using the UI
          • Configuring ThousandEyes for Splunk Cloud or Enterprise
            • Configuring ThousandEyes for Splunk Cloud or Enterprise using the API
            • Configuring ThousandEyes for Splunk Cloud or Enterprise using the UI
          • ThousandEyes for OpenTelemetry Data Model
            • ThousandEyes for OpenTelemetry Data Model v1
              • OpenTelemetry Collector Data v1 Example
            • ThousandEyes for OpenTelemetry Data Model v2
              • ThousandEyes for OpenTelemetry Data Model v2 - Metrics
                • OpenTelemetry Collector Data v2 Metrics Example
                • ThousandEyes for OpenTelemetry Data Model Metrics - Migration from v1 to v2
              • ThousandEyes for OpenTelemetry Data Model v2 - Traces
                • OpenTelemetry Collector Data v2 Traces Example
          • OpenTelemetry Collector Configuration
          • Automatic Disabling of Failing Streaming Integrations
        • Cisco ThousandEyes App for Splunk
          • Configuration
          • Inputs
          • Dashboards
          • Troubleshooting
    • Best-Practices Guides
      • Choosing the Right Test Protocol for Network & App Synthetics Tests
      • Optimizing SYN vs SACK Probing Methods to Avoid Unexplainable Packet Loss
      • Using Dashboards to Tell a Story
      • Best Practices for Implementing Account Groups
      • Monitoring Microsoft 365
      • Monitoring Microsoft Teams
      • Monitoring Salesforce
      • Monitoring Slack
      • Monitoring Webex Meetings with Endpoint Agents
      • Monitoring Webex Calling
      • Monitoring Webex Meetings with Cloud and Enterprise Agents
      • Monitoring Zoom
    • API
      • Create/Update/Delete Tests Using the ThousandEyes API
      • Obtaining a List of ThousandEyes Agent IP Addresses
      • Writing JSON to API Produces HTTP 406 Response Code
    • Privacy-Related
      • Authorized Subprocessors for ThousandEyes Network Intelligence Platform
    • Archived Documentation
      • Archived - Displaying and Alerting for Unit Consumption
      • Archived - Dependency Tree for ThousandEyes Enterprise Agent Software
      • Archived - Getting Started with ThousandEyes
      • Archived - Sending ThousandEyes Alerts to AppDynamics
      • Archived - ThousandEyes Infrastructure Changes
      • Archived - Using the Transactions (Classic) View
      • Archived - Transaction Test Migration Workflow
      • Archived - Instructions for Mitigating Meltdown and Spectre on Enterprise Agents
      • Archived - Bash (ShellShock) Security Notice
      • Archived - Endpoint Installation using Customized Installers
      • Archived - Configuring Endpoint Agent Setup
      • Archived - Creating Scheduled Tests on Endpoint Agents
      • Archived - Managing the Endpoint Agent
      • Archived - Enterprise Agent Installation on Juniper NFX Routers
      • Archived - Installing and Removing ThousandEyes X Virtual Framebuffer on Enterprise Agents
      • Archived - Permitted Content Types for Page Load Tests
  • Archived Release Notes
    • 2024
      • Release Notes: January 2024
      • Release Notes: February 2024
      • Release Notes: March 2024
      • Release Notes: April 2024
      • Release Notes: May 2024
      • Release Notes: June 2024
      • Release Notes: July 2024
      • Release Notes: August 2024
    • 2023
      • Release Notes: January 2023
      • Release Notes: February 2023
      • Release Notes: March 2023
      • Release Notes: April 2023
      • Release Notes: May 2023
      • Release Notes: June 2023
      • Release Notes: July 2023
      • Release Notes: August 2023
      • Release Notes: September 2023
      • Release Notes: October 2023
      • Release Notes: November 2023
      • Release Notes: December 2023
    • 2022
      • Release Notes: January 2022
      • Release Notes: February 2022
      • Release Notes: March 2022
      • Release Notes: April 2022
      • Release Notes: May 2022
      • Release Notes: June 2022
      • Release Notes: July 2022
      • Release Notes: August 2022
      • Release Notes: September 2022
      • Release Notes: October 2022
      • Release Notes: November 2022
      • Release Notes: December 2022
    • 2021
      • Release Notes: January 2021
      • Release Notes: February 2021
      • Release Notes: March 2021
      • Release Notes: April 2021
      • Release Notes: May 2021
      • Release Notes: June 2021
      • Release Notes: July 2021
      • Release Notes: August 2021
      • Release Notes: September 2021
      • Release Notes: October 2021
      • Release Notes: November 2021
      • Release Notes: December 2021
    • 2020
      • Release Notes: January 2020
      • Release Notes: February 2020
      • Release Notes: March 2020
      • Release Notes: April 2020
      • Release Notes: May 2020
      • Release Notes: June 2020
      • Release Notes: July 2020
      • Release Notes: August 2020
      • Release Notes: September 2020
      • Release Notes: October 2020
      • Release Notes: November 2020
      • Release Notes: December 2020
    • 2019
      • Release Notes: 2019-01-08
      • Release Notes: 2019-02-06
      • Release Notes: 2019-02-20
      • Release Notes: 2019-03-06
      • Release Notes: 2019-03-19
      • Release Notes: 2019-04-02
      • Release Notes: 2019-04-30
      • Release Notes: 2019-05-14
      • Release Notes: 2019-05-30
      • Release Notes: 2019-06-11
      • Release Notes: 2019-07-23
      • Release Notes: 2019-08-06
      • Release Notes: 2019-08-20
      • Release Notes: 2019-09-03
      • Release Notes: 2019-09-17
      • Release Notes: 2019-10-03
      • Release Notes: 2019-10-15
      • Release Notes: 2019-10-29
      • Release Notes: 2019-11-12
      • Release Notes: 2019-11-26
      • Release Notes: 2019-12-10
    • 2018
      • Release Notes: 2018-01-10
      • Release Notes: 2018-01-17
      • Release Notes: 2018-01-31
      • Release Notes: 2018-02-14
      • Release Notes: 2018-03-07
      • Release Notes: 2018-03-14
      • Release Notes: 2018-03-28
      • Release Notes: 2018-04-11
      • Release Notes: 2018-04-25
      • Release Notes: 2018-05-09
      • Release Notes: 2018-05-23
      • Release Notes: 2018-06-06
      • Release Notes: 2018-06-20
      • Release Notes: 2018-07-03
      • Release Notes: 2018-07-18
      • Release Notes: 2018-08-01
      • Release Notes: 2018-08-15
      • Release Notes: 2018-08-29
      • Release Notes: 2018-09-12
      • Release Notes: 2018-09-26
      • Release Notes: 2018-10-10
      • Release Notes: 2018-10-23
      • Release Notes: 2018-11-13
      • Release Notes: 2018-11-27
      • Release Notes: 2018-12-18
    • 2017
      • Release Notes: 2017-01-04
      • Release Notes: 2017-01-18
      • Release Notes: 2017-02-01
      • Release Notes: 2017-02-16
      • Release Notes: 2017-03-02
      • Release Notes: 2017-03-15
      • Release Notes: 2017-03-29
      • Release Notes: 2017-04-12
      • Release Notes: 2017-04-26
      • Release Notes: 2017-05-10
      • Release Notes: 2017-05-24
      • Release Notes: 2017-06-06
      • Release Notes: 2017-06-21
      • Release Notes: 2017-07-07
      • Release Notes: 2017-07-19
      • Release Notes: 2017-08-02
      • Release Notes: 2017-08-16
      • Release Notes: 2017-08-30
      • Release Notes: 2017-09-13
      • Release Notes: 2017-09-27
      • Release Notes: 2017-10-12
      • Release Notes: 2017-10-25
      • Release Notes: 2017-11-08
      • Release Notes: 2017-11-29
      • Release Notes: 2017-12-13
    • 2016
      • Release Notes: 2016-01-06
      • Release Notes: 2016-01-20
      • Release Notes: 2016-02-03
      • Release Notes: 2016-02-17
      • Release Notes: 2016-03-02
      • Release Notes: 2016-03-16
      • Release Notes: 2016-03-30
      • Release Notes: 2016-04-13
      • Release Notes: 2016-04-27
      • Release Notes: 2016-05-11
      • Release Notes: 2016-05-25
      • Release Notes: 2016-06-08
      • Release Notes: 2016-06-22
      • Release Notes: 2016-07-06
      • Release Notes: 2016-07-20
      • Release Notes: 2016-08-03
      • Release Notes: 2016-08-17
      • Release Notes: 2016-08-31
      • Release Notes: 2016-09-14
      • Release Notes: 2016-09-28
      • Release Notes: 2016-10-12
      • Release Notes: 2016-10-26
      • Release Notes: 2016-11-09
      • Release Notes: 2016-11-23
      • Release Notes: 2016-12-07
      • Release Notes: 2016-12-21
    • 2015
      • Release Notes: 2015-01-07
      • Release Notes: 2015-01-21
      • Release Notes: 2015-02-04
      • Release Notes: 2015-02-18
      • Release Notes: 2015-03-04
      • Release Notes: 2015-04-01
      • Release Notes: 2015-04-15
      • Release Notes: 2015-04-29
      • Release Notes: 2015-05-13
      • Release Notes: 2015-05-27
      • Release Notes: 2015-06-10
      • Release Notes: 2015-06-24
      • Release Notes: 2015-07-08
      • Release Notes: 2015-07-22
      • Release Notes: 2015-08-05
      • Release Notes: 2015-08-19
      • Release Notes: 2015-09-16
      • Release Notes: 2015-09-30
      • Release Notes: 2015-10-14
      • Release Notes: 2015-10-28
      • Release Notes: 2015-11-11
      • Release Notes: 2015-12-02
      • Release Notes: 2015-12-16
    • 2014
      • Release Notes: 2014-01-09
      • Release Notes: 2014-01-22
      • Release Notes: 2014-02-05
      • Release Notes: 2014-03-05
      • Release Notes: 2014-03-19
      • Release Notes: 2014-04-09
      • Release Notes: 2014-04-30
      • Release Notes: 2014-06-04
      • Release Notes: 2014-06-11
      • Release Notes: 2014-06-26
      • Release Notes: 2014-07-09
      • Release Notes: 2014-07-23
      • Release Notes: 2014-08-20
      • Release Notes: 2014-09-04
      • Release Notes: 2014-09-17
      • Release Notes: 2014-10-01
      • Release Notes: 2014-10-15
      • Release Notes: 2014-10-29
      • Release Notes: 2014-11-12
    • 2013
      • Release Notes: 2013-01-08
      • Release Notes: 2013-02-27
      • Release Notes: 2013-03-20
      • Release Notes: 2013-04-02
      • Release Notes: 2013-04-17
      • Release Notes: 2013-05-01
      • Release Notes: 2013-05-21
      • Release Notes: 2013-06-11
      • Release Notes: 2013-06-18
      • Release Notes: 2013-07-10
      • Release Notes: 2013-07-24
      • Release Notes: 2013-08-07
      • Release Notes: 2013-09-05
      • Release Notes: 2013-09-18
      • Release Notes: 2013-10-02
      • Release Notes: 2013-10-30
      • Release Notes: 2013-11-13
      • Release Notes: 2013-11-27
    • 2012
      • Release Notes: 2012-03-28
      • Release Notes: 2012-04-11
      • Release Notes: 2012-04-24
      • Release Notes: 2012-05-22
      • Release Notes: 2012-06-05
      • Release Notes: 2012-06-20
      • Release Notes: 2012-08-01
      • Release Notes: 2012-08-28
On this page
  • Initial Test Settings
  • Basic Configuration Tab: Page Load and Transaction
  • Advanced Settings Tab, Page Load and Transaction
  • Browser Options
  • Page Load or Transaction Timing
  • Exclude Elements from Metrics and Waterfall
  • Network
  • Proxy Settings
  • TLS
  • HTTP Authentication
  • HTTP Request
  • HTTP Response
  • HTTP Headers
  • Additional Transaction Test Settings
  • Basic Configuration Tab, Transaction
  • Transaction Script Window
  • Advanced Settings Tab, Transaction
  • Some HTTP Server Test Options Not Available
  1. Product Documentation
  2. Browser Synthetics

Test Settings for Page Load and Transaction Tests

PreviousBrowser Synthetics DisambiguationNextNavigating Waterfall Charts for Page Load and Transaction Tests

Last updated 1 month ago

Due to recent platform-wide naming, navigation, and URL changes in the product, you may notice some discrepancies between the product and the screenshots displayed in our technical documentation. The instructions and actual pages in the product are still valid and haven’t changed. Please bear with us as we update our screenshots to better match the in-product experience. See the full scope of changes on .

This page addresses two test types that fall under Browser Synthetics: page load and transaction tests. These two test types are unique in that they emulate a browser's interaction with a website.

The content below supplements and describes test configuration specifically for page load and transaction tests. You’ll need user permissions in ThousandEyes to create and edit test settings.

If you just need to run a test using API calls, and don’t need to emulate a user journey in a browser, use the .

The test settings are available under Network & App Synthetics > Test Settings as shown below.

Summary:

  1. Choose Network & App Synthetics > Test Settings and click Add New Test.

  2. Choose Web as the Layer and then choose either Page Load or Transaction as the Test Type.

  3. Complete the Basic Configuration and Advanced Settings tabs as needed. Most of the required defaults are already filled in.

  4. Click Run Once to ensure that the test configuration is valid.

  5. Click Create New Test to save and activate the test.

Initial Test Settings

When you choose the test type, you can see all the view layers that will be enabled by your new test. If no name is specified, the Test Name uses the value in the URL field, along with a prepended protocol (https:// by default).

Basic Configuration Tab: Page Load and Transaction

The basic test configuration is the same for both page load and transaction tests.

The Basic Configuration settings are as follows:

  • URL - Specify a domain to monitor using the format http(s)://domain:port/path for example https://google.com. If you type a simple domain like google.com, the prefix https:// is automatically prepended.

  • Schedule - Used if running this page load or transaction test from more than one ThousandEyes Agent. You can stagger the test launches so that the target server doesn’t identify the test as a security threat.

    • Default - Choose Default to launch all tests on all agents at the start of each test round if possible. If the test round specifies a 5-minute interval, choose Default to cause all agents to attempt to launch this test at the beginning of that 5-minute test interval. Note that tests will not necessarily execute at the beginning of the interval. Exactly when the test runs is a function of how many tests are assigned to the agent and the intervals and runtimes of those tests.

  • Interval - The test interval is the frequency with which the test will be run.

    • Default: 2 minutes

  • Agent (s) - Choose one or more ThousandEyes Cloud Agents, or choose from the ThousandEyes Enterprise Agents that are available to your account. Both Cloud Agents and Enterprise Agents can be selected.

  • Alerts, Enable - When the Enable box is checked, all the alert rules currently selected in the drop-down immediately below will be active for the test.

    • Default: Enabled

  • 4 out of 6 Alert Rules Enabled - Drop-down to quickly see which alert rules are associated with this test.

    • You can create, modify and delete alert rules using the Edit Alert Rules link.

  • Alert Suppression Windows - This drop-down appears if you have any alert suppression windows configured under Alerts.

Advanced Settings Tab, Page Load and Transaction

The Advanced Settings apply to both page load and transaction tests, except where noted.

Browser Options

Browser Options allows for additional fine-tuning of page load and transaction tests.

The Browser Options are as follows:

  • Screenshot / Enable - Check box. You can disable screenshots for data privacy reasons without having to remove those lines from the transaction script. For example, if you are monitoring a HIPAA-compliant application you might want to disable screenshots that show patient identifying information.

    Default: Enabled

  • Browser Language: Drop-down selector to choose the language/locale of the browser used during testing.

    When a visitor with a browser setting for a specific language/locale lands on a web site, that site can redirect them to the appropriate landing page that uses their preferred language. For example, if you are looking to test the Portuguese-language version of your site for visitors located in Brazil, or who have Portuguese selected as their preferred language, you can create a transaction test that runs on the default site for Portuguese.

    Default: English (US)

  • Microphone and Camera / Allow or Block: Button. Used for collaborative web applications such as Google Meet that may prompt the user for permission for the app to use the camera or microphone.

    • Allow: The ThousandEyes transaction or page load test will emulate a fake camera and microphone to be used in that application.

    • Block: Deny permission. Camera and microphone will not be available for the application.

    Default: Block

  • Geolocation / Allow or Block: Button. For web applications that require the user's location in order to test an area of the application, the target web application might request permission to use the location of the browser.

    • Allow: The ThousandEyes test provides the location of the ThousandEyes agent to be used for the test. Using the agent’s location provides data consistent with that vantage point.

    • Block: Denies permission to use geolocation.

    Default: Block

  • Page Loading Strategy: This option lets you choose how long to wait to execute the webdriver command. The Page Loading Strategy gives you the option to execute the next action without waiting for all the elements on the page to load. For example, you might have a page or application where the DOM loads quickly, but because of JavaScript that modifies the page, or assets that take a long time to load, you might otherwise have to wait a long time before executing the next action on your transaction script.

    There are three major milestones for loading a web page: when the structure of the page (HTML) has been downloaded, when the major structural elements are present (DOMContent Loaded) and when images and other assets of the page have finished rendering (last contentful paint). You can see this in the page load waterfall charts: the "index.html" object shows when the HTML has finished downloading. The blue line denotes when the DOM content has loaded, and the red line in the waterfall shows when the page has fully loaded.

    Drop-down options as follows:

    • Normal. Wait for the entire page to load, meaning that HTML content and all resources have been downloaded and parsed before moving to the next action in the transaction test script.

    • Eager. Wait for the DOMContentLoaded event, meaning that HTML content is downloaded and parsed, and the document readiness state is “interactive”, before moving to the next action in the test script.

    • None. Wait only for HTML content to download. Once the HTML is downloaded, the test proceeds to the next action in the transaction test script.

    Default: Normal

Page Load or Transaction Timing

The Page Load Timing settings are as follows:

  • Timeout - This is the overall page load or transaction test timeout setting. Note that there’s a separate timeout for the HTTP server portion of this test. Timeout is the number of seconds until the test type terminates due to inability to load the page in a page load test or to complete the script in a transaction test within the timeout time.

    Slider with a range 5 - 15 seconds. Timeout is equal to or larger than Target Time for View. Also note that the maximum timeout can change based on the interval selected in the basic settings.

    • Default:

      • 10 seconds for page load tests. The maximum timeout value is either 0.25 * interval (in seconds) or 60 seconds, whichever is lower.

      • 30 seconds for transaction tests. The maximum timeout value is either 0.5 * interval (in seconds) or 180 seconds, whichever is lower.

  • Target Time for View - Specifies the expected or “normal” timeout for the transaction or page load test. Influences color-coding legend on the test view Map tab for the page load or transaction view layer. If a test completion takes longer than this threshold, the test still runs but the results show in red instead of green.

    Slider with a range 1 - 30 seconds. Cannot exceed the Timeout.

    • Default:

      • 6 seconds for page load

      • 10 seconds for transaction

Exclude Elements from Metrics and Waterfall

Use the exclude feature to exclude all objects from a domain, a sub-domain, or even specific objects such as very large images, for example *.domain.com/very_large_logo.jpg.

  • Exclude Domains / Object URLs:

    Text entry. Ignore large page objects that you don’t care about that could be negatively impacting your page load times and raising false timeout alarms. Can also be used to block requests to third-party tracking tools.

Excluding domains or URLs can be helpful for ignoring third-party assets that are not important to your teams’ primary business objectives. Requests to blocked domains or objects appear greyed out in the waterfall and will not affect test metrics collected.

Note that entering a domain such as google.com only blocks the main domain (https://google.com). Blocking subdomains requires a wildcard, for example *.google.com would block docs.google.com, maps.google.com and google.com itself.

Network

Proxy Settings

TLS

The TLS area has separate options as follows:

  • Disable SSL verification for page load and transaction tests

  • Use a client-side certificate

The TLS settings are as follows:

  • SSL Version - Select the version of the SSL/TLS protocol to offer in the SSL Client Hello from the ThousandEyes Cloud or Enterprise Agent.

    This will set the maximum version of SSL/TLS that the connection can use, but a lower version may be negotiated by the server.

    Drop-down options are the following:

    • SSLv3: Use SSL version 3.0. No lower version can be negotiated.

    • TLSv1.0: The Agent will start the TLS negotiation at version 1.0.

    • TLSv1.1: The Agent will start the TLS negotiation at version 1.1.

    • TLSv1.2: The Agent will start the TLS negotiation at version 1.2.

    • Auto: The Agent will start the TLS negotiation at the highest version of TLS supported by its operating system. Currently the highest version is TLS 1.2 Contact ThousandEyes Customer Support if you require confirmation of the current version.

    Default: Auto

  • Verify SSL Certificate - Checkbox. Applies to both the HTTP view and to the page load or transaction view, for page load and transaction tests.

    By default, certificate-related errors will result in a test error. Uncheck this box to ignore certificate errors during SSL/TLS negotiation.

    If your page load and transaction tests have SSL verification disabled at the ThousandEyes Agent level, review your configuration and use the test-level setting going forward.

    Default: Selected

The certificate body itself is obscured once the test has been saved. To change an existing client certificate, click Remove, re-enable the checkbox, and then copy in the new certificate.

HTTP Authentication

NTLM authentication may fail in some situations for page load or transaction tests, because NTLM negotiation using GSSAPI and NTLMSSP is not natively supported by the Linux libraries available for use with BrowserBot. A website that supports both Kerberos (ticket-exchange negotiation) and NTLM (credentials provided) and which sends a generic WWW-Authenticate: Negotiate header will cause the NTLM authentication to fail on any BrowserBot tests, even when NTLM still works for the HTTP server test.

HTTP Request

HTTP request settings for page load and transaction tests include HTTP versions, redirects, browser versions, device emulation, and the use of custom headers.

The HTTP Request settings are as follows:

  • HTTP Version - Options

    • Prefer HTTP/2 - Attempt HTTP/2 and fallback to HTTP/1.1 if HTTP/2 is not available.

    • HTTP/1.1 only - Send request(s) using HTTP/1.1 only, no attempt is made to utilize HTTP/2.

    Default: Prefer HTTP/2

  • Follow Redirects / Enable - Checkbox to enable redirects.

    Default: Selected

  • Device Emulation - Drop-down options with these main device type categories. A range of options are available for different device type, including custom dimensions for each:

    • Desktop

    • Phone

    • Tablet

    • Laptop

    Default: Desktop Large

  • Device Emulation / pixel dimensions - The browser display updates based on Device Emulation selection immediately above.

    Default: 1440 x 900 px

  • Device Emulation / portrait or landscape - Icon. The browser display updates based on Device Emulation selection immediately above.

    Default: Landscape

  • User Agent - The user agent normally refers to what your browser is sending in the user-agent heading. In this case it refers to what ThousandEyes sends when running this test.

    Drop-down options include various browser options for Windows and Mac OS. Chrome, Firefox, Internet Explorer, Edge, Safari. Options are:

    • Default

    • Additional options for commonly used browsers

    • Choose Custom for other browsers not specified

    Default: Default

  • User Agent / Custom - If Custom is selected immediately above, this text box populates with suggested text, which may show different versions based on recent software updates.

    For example, the suggested text might read something like this: “Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.163 Safari/537.36”

  • Agent ID Strategy - Drop-down options for the identifier to use for the ThousandEyes Cloud or Enterprise Agent that is running this test. Options:

    • Add x-thousandeyes-agent Header: Identify ThousandEyes Agent HTTP requests by including the custom x-thousandeyes-agent: yes header to every request.

    • Extend User Agent Header: Identify ThousandEyes Agent HTTP requests by extending the user agent request header with the ThousandEyes Agent identifier string. Use if default ThousandEyes Agent header causes CORS issues.

    Default: Add x-thousandeyes-agent Header

  • Custom Headers - Drop-down options. Use the plus sign to the right to add multiple entries. Options are:

    • Root Request

    • Specific Domain

    • All Domains

    Default: Root Request

  • Custom Headers / text - Enter one or more HTTP header strings in the form <stringname>: <value>. Note the whitespace between the literal colon character and the placeholder <value>. When adding multiple headers, delineate between individual headers using a line break. The custom headers will be transmitted with the target page request (page load test) or each page request (transaction test) but not for objects within a page.

Notes on Agent ID Strategy

ThousandEyes adds one line to the HTTP request headers that identifies the HTTP request as coming from a ThousandEyes Cloud or Enterprise Agent. By default, that identifier is this string:

x-thousandeyes-agent: yes

To get around this limitation, the alternative Agent ID strategy option Extend User Agent Header: appends the ThousandEyes Agent identifier string at the end of the line immediately above that (the line that begins with user-agent).

If the (ThousandEyes Agent) identifier string is removed from the User Agent text input while the Extend User Agent Header option is selected, the test configuration will not be valid and cannot be saved.

HTTP Response

The HTTP Response settings are as follows:

  • Desired Status Code / Default (2xx or 3xx) - Check box

    Default: Selected

  • Desired HTTP status code of the response - Use to set a custom status code, if Desired Status Code / Default is un-checked immediately above.

One reason to specify a custom HTTP status code is if you can’t run the test that you really want due to authentication challenges on the server side. In this case, even a “403 - forbidden” might constitute a success message, because it tells you that the target is still responding

  • Verify Content / Enable - Check box. If selected, a text box appears. Enter a POSIX Extended Regular Expression to match against the content of the response.

    Non-matching responses will be marked as errors.

    Note: the HTTP server portion of the test does not execute any JavaScript code, nor does it expand any CSS. It simply downloads the initial page and stops. It does not load anything that comes from other files. Therefore the content generated by JavaScript cannot be verified using a page load test. If you need to match JavaScript-generated content, use a transaction test instead.

    Default: Not selected

HTTP Headers

Use this setting to suppress the capture and display of HTTP headers on the ThousandEyes platform.

The HTTP Headers settings are as follows:

  • Show HTTP headers in waterfalls - If enabled, shows HTTP request and response header information for each object in the waterfall displays. You can view by clicking the [Header] link in a waterfall row.

    De-select in order to suppress sensitive data that might otherwise be available in ThousandEyes.

    Default: Selected

Additional Transaction Test Settings

The test settings for transaction tests are almost the same as for page load tests, with a few additional settings as described below.

Basic Configuration Tab, Transaction

All Basic Configuration settings are the same for a transaction test as for a page load test, except as noted below.

  • Transaction Script - Text window. Transaction tests execute custom Selenium WebDriver-based scripts written in JavaScript, to simulate user interactions with web page elements.

    Default: A skeleton transaction script is generated with the JavaScript functions necessary for ThousandEyes transaction tests.

  • Transaction Script / Icons - Use the icons to insert special functions at selected points within your transaction test script.

    • Hourglass - Add sleep function which waits 5 seconds before proceeding to the next step in the script.

    • Timer - Adds a marker function to track script progress. Note that this can be changed from markers.set to markers.start and makers.stop to track a particular section.

    • Screenshot - Capture screenshot at a particular point in the script. You can temporarily disable screenshots without having to remove these lines from your script by un-checking the Screenshot | Enable checkbox under Advanced Settings tab, Browser Options section.

Transaction Script Window

Transaction tests execute custom Selenium WebDriver-based scripts written in the JavaScript language to emulate user interaction with web page elements. There's a download link for the ThousandEyes Recorder as well.

Advanced Settings Tab, Transaction

All of the items on the Advanced Settings tab for transaction test configuration are identical to the same settings as they appear for page load test configuration, with the exception of the default timeouts.

Some HTTP Server Test Options Not Available

The following test options that are available in the HTTP Server test type are not available in page load and transaction tests:

  • Client certificates

  • IPv6

  • DNS override

  • HTTP Request method (can be used for basic API testing)

  • Limit download size

The majority of the ThousandEyes test configuration settings are shared between page load and transaction tests, and many are common to all or most ThousandEyes test types. For commonly shared test layers such as Network and BGP, see .

Round Robin - Stagger the tests so that each agent launches the test on the same interval, but they don’t all start simultaneously. See for more information.

Default: A few built-in alert rules are automatically associated with new page load tests. You can de-select them, view the alert rule, or create your own alert rules as described in .

Chromium Version - Drop-down selector to choose which version of Chromium for this test. See for details.

Page load or transaction timeout affects unit consumption as described in .

Network layer test settings for page load and transaction tests are the same as for other test types, described in .

Use Proxy Settings to select a pre-configured setting from within ThousandEyes. You can view or configure these settings under Network & App Synthetics > Agent Settings, under the Proxy Settings tab. See for more information.

The also uses proxy settings in the same way as HTTP server, page load, and transaction tests do. Note, however, that API tests do not support automatically following HTTP redirects that change the protocol from HTTP to HTTPS or vice versa. When configuring proxy settings for API tests, please configure your test to target the final URL where possible.

Enable Client Certificate - Checkbox. Use this feature if your test target requires a client-side certificate, and copy the certificate body into the text field below. The text box under Enable shows suggested text and hints as described in .

Authentication settings for page load and transaction test types are the same as for the HTTP server test type, with the exception of OAuth and NTLM:Negotiate. See for information on the HTTP server test type.

Sometimes the default agent identifier causes problems with cross-origin resource sharing on the target server. affects third-party HTML objects that might be fetched from another site. A third-party domain owner can choose not to allow sharing for requests containing unknown agent identifiers, which might cause all HTML objects from that domain to fail to load properly.

HTTP response settings are the same as for other web layer test types, described in .

Download the ThousandEyes Recorder (shown first time only) - Link to download the ThousandEyes Recorder IDE. Use the Recorder to generate your own transaction scripts without having to write any code. See for more information.

You can write your own transaction test script, use the ThousandEyes Recorder, or copy from another script and modify it. See for more information, and visit the for some scripting examples.

Key - Add login credentials from the ThousandEyes Credentials Repository, available as a separate tab under Network & App Synthetics > Test Settings. See for more information.

See for more information.

Working With Test Settings
Using Round Robin Test Scheduling
Creating and Editing Alert Rules
Configure Dual Chromium
Calculating Units
Working With Test Settings
Collecting Proxy Metrics
API test type
Converting Certificates into PEM Format
Working With Test Settings
CORS
Working With Test Settings
ThousandEyes Recorder
Getting Started With Transaction Tests
ThousandEyes scripting repository
Working With Secure Credentials
Transaction Test Development Guide
Naming and Navigation Menu changes - Summary List
Working With Test Settings
API Test Type