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
    • 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
  • When and Where Units Are Calculated
  • What the Unit Calculator Is
  • Where to Find the Unit Calculator
  • How Units Are Calculated
  • Test Variables
  • Base Equation
  • Milli-Unit Cost by Test and Agent Type
  • Example Calculation
  • Calculator Reconfiguration Use Case: PseudoCo
  • How to Use the Unit Calculator
  • Configure Tab
  • Using the Share Button
  • Summary Tab
  1. Product Documentation
  2. Account Management
  3. Usage-Based Billing

Calculating Units

PreviousSetting QuotasNextFAQs: Usage

Last updated 1 month ago

When and Where Units Are Calculated

There are two places on the platform that use unit calculation. The first is your existing Cloud and Enterprise test configuration, which calculates the units per test for which you are charged at the end of a billing period. For these tests, units are calculated based on your test configurations and instant tests (see for more information about how units are charged to your account). The second is the , which is a test simulator where you can see how changes to test configurations could affect the number of units you consume.

Units are calculated the same way in the calculator as they are calculated for real tests. Likewise, the projection mechanism in the calculator works in the same way as the projection mechanism for real tests on the Usage page, except that the calculator always projects the unit cost over a 31-day period, whereas the Usage page projection projects both from today to the end of the current billing period (which could be any number of days up to 31), and for the next billing period.

This article will use the unit calculator to help illustrate how units are calculated because it provides a visible interface for interacting with tests in a way that immediately shows their impact on unit consumption. The unit calculator also has a unique function on the platform that merits its own discussion; this article will help you understand how the unit calculator works and why to use it.

The unit calculator currently calculates units for Cloud and Enterprise Agent tests only. It does not calculate units for Device Agent tests.

What the Unit Calculator Is

The is a tool you can use to test the impact of changes to your existing Cloud and Enterprise test configurations, or to determine the estimated cost of a specific test. When you open it up, it is pre-populated with all of your current tests and test settings. It shows the number of units that you are projected to incur over a 31-day period given your current test configurations, and if you add or delete tests or change the configuration of a test in the calculator, it estimates the impact of this change on your usage projection.

Using the unit calculator does NOT change the test settings for which you are currently charged. The calculator is a simulation environment where you can see how changes would impact your unit consumption should they be made in real life.

This is a powerful tool for customers who are at risk of going over their monthly plan allowance, for customers who feel they are underutilizing their allowance, or for customers who want to make adjustments to their test settings to optimize their test performance, add new use cases or reduce alert noise.

It is important to note that the projections the calculator makes are estimates only. For example, the calculator does not consider any instant tests that may be run during a billing period.

Where to Find the Unit Calculator

You can find a link to the calculator at Manage > Account Settings > Usage and Billing > Usage: click Calculate the units you need for this account group located on the right of the page.

The calculator opens in a new window.

How Units Are Calculated

Generally, the number of units you use per month depends on the type of tests you run, on how many and what kind of agents those tests use, and how many times you run your tests. Details about each element of the equation are explained below.

Test Variables

All test units are calculated per test based on:

  • Type of test.

  • Test interval setting (frequency).

  • Number and type of agents running the test.

  • The test’s timeout setting (for tests with timeout settings – see Base Equation, below).

In addition to the above, some tests have particular features that, when modified, can increase or decrease unit count. These are:

  • DNS Server: the number of servers tested.

  • Agent to Agent: Whether using Cloud or Enterprise Agents as the source agent, and whether test direction is one-way or bi-directional. If bi-directional, both directions incur units.

  • RTP Stream: duration of the stream.

  • Page Load: HTTP server timeout.

The calculator pulls the data for your pre-populated test configurations from your Network & App Synthetics > Test Settings screen, on the Basic Configuration tab (1 - 3) and the Advanced Settings tab (4):

If you make changes to your test settings on the Test Settings screen, the calculator will automatically update to reflect these changes the next time you open the calculator (or refresh).

Each calculator “session” always starts from the point of your current test configurations. It will not remember the settings from your last calculator session and will not update changes to your Network & App Synthetics > Test Settings screen “in session”. If you have changed a test setting on the Test Settings screen during a calculator session and you want the change reflected on the calculator without losing any of your other calculator settings, you must update the calculator with the test setting change manually.

Base Equation

There are three main elements that make up the formula for each test projection. The basic formula is:

The above formula applies to Network, DNS, and Routing tests as follows:

  • Agent to server

  • Agent to agent

  • DNS server

  • DNS trace

  • DNSSEC

  • BGP

    • The cost of a BGP test is independent of the number of BGP monitors selected. The BGP test runs every 1 minute.

For tests with timeout settings, the basic formula is also multiplied by the timeout in seconds. The minimum timeout is 5 seconds, the maximum is 180 seconds. This extended formula applies to Web and Voice tests as follows:

  • HTTP server

  • FTP server

  • Page load

  • Transaction

  • SIP server

  • RTP stream

Milli-Unit Cost by Test and Agent Type

For billing purposes, units are considered in lots of thousands. This is because many test configurations can run over many millions of rounds per month. At this scale, unit numbers begin to look meaningless. Therefore, when we refer to unit usage, and when you see units shown on the calculator, we are referring to units per thousand rounds, which we call milli-units.

In the table below, note that Enterprise Agents use only half the number of milli-units that Cloud Agents do. This is because Cloud Agents are maintained by ThousandEyes while Enterprise Agents are maintained by customers.

Test Type
Cloud Agent (milli-units)
Enterprise Agent (milli-units)

Network - Agent to Agent

5

2.5

Network - Agent to Agent (Throughput Enabled)

N/A

Timeout * 0.5

Network - Agent to Server

5

2.5

DNS Trace

5

2.5

DNSSEC

5

2.5

DNS Server

Number of servers * 5

Number of servers * 2.5

Web - FTP Server

Timeout (seconds) * 1

Timeout (seconds) * 0.5

Web - HTTP Server

Timeout (seconds) * 1

Timeout (seconds) * 0.5

Web - Page Load

Timeout (seconds) * 1

Timeout (seconds) * 0.5

Web – Transaction

Timeout (seconds) * 1

Timeout (seconds) * 0.5

Voice - SIP Server

Timeout (seconds) * 1

Timeout (seconds) * 0.5

Voice - RTP Stream

Duration (seconds) * 1

Duration (seconds) * 0.5

BGP

BGP Tests run on BGP monitors rather than agents, so the units per 1000 rounds will always be 8

For reference, 1000 rounds of a test at 5-minute intervals would be around 3.5 days’ worth of tests, while a test at 1-minute intervals would be around 17 hours’ worth of tests.

Example Calculation

If you want to set up an HTTP Server web test, you could set the following test variables:

  • Test type: HTTP Server

  • Interval: 1 minute

  • Agents: 1 Cloud

  • Timeout Setting: 5 Seconds

  • HTTP server test milli-unit cost per Cloud Agent =

  • Timeout (seconds) * 1 milli-unit =

  • 5 * 1 =

  • 5 milli-units.

Now, calculate the number of rounds across 31 days using the base equation.

  • Milli-units * number of rounds per hour over 31 days * number (and type) of agents =

  • 5 milli-units * ((60 minutes/1 minute interval) * 24 hours * 31 days) * 1 Cloud Agent =

  • 5 * 44,640 * 1 =

  • 223,200 milli-units

Because units are calculated per 1000 rounds, the actual cost is 223 units (223,200/1000). Note, units are rounded to the nearest 1000 milli-unit. This displays as the following on the calculator:

The calculator also sums the number of tests with this same configuration. The monthly usage simply increases by the unit amount with each test added. Adding two more of the same HTTP server test, for example, would add up to (223,200 * 3)/1000 = 670 units (when rounded).

Calculator Reconfiguration Use Case: PseudoCo

Consider the following scenario: PseudoCo needs to monitor ten separate targets, from various locations around the world. These targets are all various PseudoCo websites and portals with related domain names such as pseudo.com and pseudo.cloud.com.

For the purposes of this example, let’s assume that PseudoCo has configured a total of 10 page load tests running at 5-minute intervals from 20 cloud agent locations, with a 30-second timeout. The test interval for the page load and HTTP server portions of this are both configured as 5 minutes. The same page load test specifies a separate HTTP server timeout of 5 seconds – but because the test interval is still the same, there is no additional charge for the HTTP server portion of this test.

PseudoCo subsequently purchases another company called NymCo, and needs to monitor two new targets: a new website for NymCo, as well as an API integration website for their own product. In addition to their original page load tests, PseudoCo wants to add a few more tests, including additional HTTP server targets, and one DNS trace test to validate the new company’s DNS configuration.

For example, rather than increasing the monthly allowable usage ceiling in the contract, PseudoCo can be flexible in the deployment of the new tests by reducing the number of agents running the original page load test from 20 to 16, and re-allocating the saved units to the new tests.

How to Use the Unit Calculator

Configure Tab

The unit calculator opens to the Configure tab, which displays the existing test configurations in your current account group, and their projected monthly usage.

Top panel

Middle panel

  • Account Group dropdown: switch between account groups.

  • Tests/Agents toggle: The calculator defaults to the Tests view. You can also toggle to the Agents view, which provides a summary of the number of tests and units per agent type. This can be helpful to understand and manage cost by agent type, since using Cloud Agents costs twice as much as Enterprise Agents.

  • Show filter: Filter by test type. There are two Quick Filters: All Tests and Manually Added Tests. Test Type allows you to filter by any test type currently visible on the calculator.

  • Add Row button: Allows you to add a new row to your test table in which you can configure a new test. A summary of the number of table rows and unit subtotal displays beneath the button.

  • Ellipsis button: Allows you to clear all the table rows.

Bottom panel

The bottom panel contains the table of tests. When first opened, the calculator displays all of your current test configurations here. You can also add new tests using the Add Row button from the middle panel.

Across the top are the table columns:

  • Test Description: Displays the test layer and type. In each row beneath, upon hover, you can add a more meaningful description – useful if you have several of the same type of test and want to align with a use case or team – or you can change the test type with the dropdown arrow.

  • Interval: A slider that allows you to view and change the frequency of your tests.

    • For the Page Load test type, two sliders appear; one for Page Load and one for HTTP server.

    • There is no slider for BGP test types as the interval is always set to 15 minutes.

  • Details: If a test has additional variables that affect unit consumption, this column displays the additional configurable fields, which change depending on test type. The following list explains which field displays for which test types.

    • Timeout: HTTP server, FTP server, Page load, Transaction, SIP server, Agent to Agent w/throughput enabled

    • Servers: DNS Server

    • Duration: RTP stream

    • Direction: Agent to Agent, Agent to Agent w/throughput enabled

    • HTTP Server Timeout: Page Load

  • Agents: Allows you to view and change the number of Cloud (indicated by the cloud symbol) and Enterprise (indicated by the server symbol) Agents used in each test.

    • For Agent to Agent tests, the first column of agents allows you to choose which type (and number) of agent to use for your source, while the second column of agents allows you to choose which type of agent to use for your target. Source agents determine the unit count for one-way tests, while units will accrue for both directions on a bi-directional test.

    • For Agent to Agent w/throughput enabled tests, only Enterprise Agents are available.

    • For BGP tests, no agents are available because BGP tests do not use agents.

  • No. of tests: Allows you to view and change the number of tests.

  • Monthly Usage: Displays the number of units the test configuration would consume over the course of 31 days if deployed and left unchanged. In each row, upon hover, you can click the trash can symbol to delete the row from the table or click the copy symbol to duplicate the row.

Using the Share Button

The Share button on the top panel allows you to generate a snapshot and a link to the snapshot of your calculator as it currently stands. You can use this link either to keep a record of (save) this snapshot for your own purposes or to share it with others.

Saving

As there is no “save” button on the calculator, generating a link using the Share button is the only way to capture the work you have put into the calculator. Calculator snapshots do not work like dashboard or test view snapshots, which get saved to the platform. Calculator snapshots are only available through the generated link. To save your calculator snapshot, therefore, you must paste the link somewhere you can access it again, such as to a bookmark folder on your browser or a personal file on your computer. As such, we advise giving your snapshot a meaningful Subject title so you can differentiate calculator snapshots.

Sharing

Anyone can view a calculator snapshot; they do not require a ThousandEyes login. For anyone without a ThousandEyes login, the link opens in a pared-down ThousandEyes browser window.

The calculator snapshot is not static. Anyone who opens the snapshot can subsequently make edits to it. Any edits made to the snapshot on the link are local to the viewer; these edits will not be seen by any other viewers with the link. That said, anyone who makes edits can create a new link and share the new snapshot with anyone else.

Summary Tab

The Summary tab shows projected usage and percentage of usage by account group in your organization.

Clicking any account group name will take you to the Configure tab for that account group.

The unit calculator is not in the main menu on the platform. You can also access it directly by going to .

Do not close or refresh the calculator if you want to save the settings from your current session. You can use the Share button to generate a link to a snapshot of your current calculator session if you want to save your session settings somewhere. See for more information about how to use the Share button.

First, calculate the milli-unit cost of the test (see ).

PseudoCo can use the to understand how best to rearrange their test settings to enable them to monitor these two new websites without going over their monthly unit limit.

Overages: For customers who have overages enabled, there would be no need to reduce the number of Cloud Agents to stay within plan, as overages allow customers to go over their plan limit. For more information about overages, see .

The top panel shows your organization name, your consumption model, and the sum of units your test configurations amount to across 31 days. This sum will update as you add, remove, or change test configurations. A link below the organization name opens a window with a summary of how tests are calculated. There is also a Share button. Click this button to generate a snapshot of the calculator and copy the link to the snapshot for saving or sharing purposes. See for more information about using the Share button.

The middle panel contains settings that apply to the calculator in general. Along the top are the two main tabs: Summary and Configure. See below for more about the tab. This panel also features:

app.thousandeyes.com/calculator
ThousandEyes unit calculator
Overages
Using the Share Button
Milli-unit Cost by Test and Agent Type
Using the Share Button
Summary
How Units Are Consumed
unit calculator
ThousandEyes unit calculator
Usage page with link to calculator
The unit calculator page
Test Settings and Basic Configuration pages
Basic formula
Showing calculation
Top panel
Agents toggle view
Add Row button
Bottom panel
Sharing browser view
Summary tab