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
  • Component Relationships
  • Flow Forwarder Requirements
  • Enterprise Agent Requirements
  • Forwarder Flow Capacity
  • Deployment Approaches
  • Cisco Catalyst SD-WAN and IOS-XE Requirements
  • Supported IOS-XE Versions
  • Supported Cisco Catalyst SD-WAN Versions
  • Traffic Monitor Requirements
  • Supported Cisco Devices
  • Supported Non-Cisco Devices
  • Network Flow Record Requirements
  • Configuration of Network Flows on Cisco vs. non-Cisco Devices
  • Network Flow Traffic Types
  • Network Flow Records and Fields
  • How Records are Recognized by ThousandEyes
  • Minimum Fields Required
  • Recommended Fields
  • For Optimum Functionality
  • Application Recognition
  • Identify Subnets
  1. Product Documentation
  2. Traffic Insights

Traffic Insights System Requirements

PreviousTraffic InsightsNextTraffic Insights Configuration Guide

Last updated 4 hours ago

This section describes certain prerequisites, plus hardware, software, and configuration requirements for Traffic Insights components, including:

  • Enterprise Agent device and installation types that can be enabled for Traffic Insights.

  • The Cisco SD-WAN versions and other Cisco devices supported, as well as support for non-Cisco devices.

  • Network flow record requirements.

Component Relationships

Before we get into the specifics of hardware and software requirements, it’s important to note how the different interact with each other. Here are some guidelines regarding one-to-one and many-to-one relationships between traffic monitors, forwarders, and the interfaces being monitored.

  • There is a maximum of one forwarder enabled per Enterprise Agent.

  • You can have multiple traffic monitors sending network flow data to a single forwarder that’s been enabled on a ThousandEyes Enterprise Agent. See for the different monitor-to-forwarding-agent ratios.

  • A single traffic monitor can be watching different interfaces, and send network flow data for multiple interfaces to the same Enterprise Agent forwarder.

  • The same interface can be monitored for both IPv4 and IPv6.

Flow Forwarder Requirements

The following requirements and performance criteria apply to the Enterprise Agents you enable for flow forwarding.

Enterprise Agent Requirements

The forwarder enablement on the ThousandEyes Enterprise Agent is supported only for:

  • ThousandEyes (TEVA). Machine requirements:

    • 32 GB RAM, 16 Cores.

    • 8 GB RAM, 4 Cores.

  • CAF (Cisco Application-Hosted Framework)

    • Available via ISR1k, ISR4k, Cat8k and ASR1k routers.

In addition, there are a couple restrictions on the use of Enterprise Agents:

  • No shared Account Groups: You cannot enable Traffic Insights for an Enterprise Agent that is shared with another Account Group. Any Enterprise Agent that has already been enabled for Traffic Insights cannot be shared with another Account Group.

Forwarder Flow Capacity

  • One TEVA forwarding agent on a 32 GB RAM machine supports up to 200,000 FPS (around 20,000 PPS) and up to 1,000 traffic monitors.

  • One TEVA forwarding agent on an 8 GB RAM machine supports up to 50,000 FPS (around 5,000 PPS) and up to 1,000 traffic monitors.

  • One CAF forwarding agent supports up to 10,000 FPS (around 1,000 PPS) and up to 3 traffic monitors.

Deployment Approaches

The capacity rates above for TEVA and CAF naturally suggest two kinds of forwarder deployment approaches. Because the TEVA appliance can handle much larger exporter numbers and flow rates, we recommend installing the forwarder on one or more centralized Enterprise Agents at central or regional data centers. In this scenario, you only configure one forwarder for your entire network or one forwarder per regional network.

For those using CAF, we recommend a more distributed approach, such as a forwarder on each local network. CAF users are likely to have Enterprise Agents already installed on these local networks, making enabling them as forwarders relatively straightforward.

Additionally, we recommend using the designated Enterprise Agent(s) only for Traffic Insights, rather than as an agent that also runs tests. We acknowledge, however, in the CAF scenario, that you may be repurposing Enterprise Agents that still run tests. In this case, we recommend reducing the number of tests run on those agents to less than 10 to optimize their flow rates.

Cisco Catalyst SD-WAN and IOS-XE Requirements

Cisco Catalyst SD-WAN includes Cisco Catalyst SD-WAN Manager, formerly known as vManage.

The following minimum and recommended versions apply when using Cisco SD-WAN or other devices that run IOS-XE to set up your network flow environments.

Supported IOS-XE Versions

  • Minimum required IOS-XE version:

    • Cisco IOS-XE v17.9 +.

  • Minimum recommended IOS-XE version:

    • Cisco IOS-XE v17.15.1 +.

Supported Cisco Catalyst SD-WAN Versions

  • Minimum required version for Cisco SD-WAN environments that use Cisco Catalyst SD-WAN:

    • Cisco Catalyst SD-WAN Release 20.9 +.

  • Minimum recommended version for Cisco SD-WAN environments that use Cisco Catalyst SD-WAN:

    • Cisco Catalyst SD-WAN Release 20.12.1 +.

Traffic Monitor Requirements

Traffic monitors can be configured on the following types of routers and/or switches within your enterprise network.

Supported Cisco Devices

Supported Cisco devices for NetFlow v9 and IPFIX are:

Routers

  • ISR1K

  • ISR4K

  • CSR1K

  • ASR1K

  • Cat8K

Switches

  • Cat9K for switches

Meraki

  • MX devices

These devices don’t have to be capable of running a ThousandEyes Enterprise Agent. They only have to be able to send network flows to Enterprise Agents acting as a forwarders.

Supported Non-Cisco Devices

Network Flow Record Requirements

Traffic Insights supports NetFlow v9 and IPFIX network flow records as outlined below.

This section is intended for a technical audience, specifically network engineers who already have a solid working knowledge of enterprise networking, and prior experience configuring network flow on network devices.

To receive network flow data, you must ensure the minimum records are captured on each network device that serves as a traffic monitor.

Configuration of Network Flows on Cisco vs. non-Cisco Devices

Network Flow Traffic Types

Network flow “records” are better understood as network flow traffic types rather than a formally defined “record type”, since the records themselves don’t contain a record type identifier.

While there are multiple traffic types (e.g., 4-tuple, 5-tuple, application performance monitoring (APM), and WAN, with unidirectional and bidirectional variants), minimum records only mandate the 5T (5-tuple) type, while the recommended records optimize your results by including fields from other traffic types.

Network Flow Records and Fields

Fields are uniquely referenced by number (in parentheses in the tables below) rather than by descriptive name. The descriptions themselves are not part of the standard nomenclature as they don’t appear in the network flow traffic records, but are included for understanding here.

Fields also come in two types: match fields and collect fields. Match fields identify and classify the data collected; they are what determine the type of traffic, and hence record, it is. For example, source IP and destination IP are match fields that help to identify where the traffic is coming from and going to. Collect fields “collect” additional data about the traffic, such as how many bytes the traffic is using, packets are being sent, or application it’s related to. Collect fields are mostly used to help analyze traffic flow data.

The IANA document covers standard fields up to number 32767. Any number above 32767, for example 45005, are Cisco-specific and are not part of the IANA standard. Not all IANA fields have a Cisco equivalent.

How Records are Recognized by ThousandEyes

ThousandEyes recognizes a network flow record as valid based on whether it includes the minimum fields listed below. If one of the minimum-required fields is missing, the record is ignored. Records can include more than the minimum-required fields, of course.

In cases where there are different fields depending on whether you are monitoring an IPv4 or an IPv6 interface, those fields are both listed as alternatives and you should choose the appropriate option.

Minimum Fields Required

The following collect and match fields are mandatory for ThousandEyes to be able to ingest your network’s flow record.

Description

Field Type

IANA Field

Cisco Alternative Fields

Number of total bytes transferred

Collect

octetDeltaCount (1)

Protocol ID, IPv4 or IPv6

Match

protocolIdentifier (4)

Source port

Match

sourceTransportPort (7)

Cisco client transport port (45008)

Source IP address

Match

Use one of: sourceIPv4Address (8), sourceIPv6Address (27)

Use one of: Cisco client IP address, IPv4 (45004), Cisco client IP address, IPv6 (45006)

ID of the interface where packets are received

Match

ingressInterface (10)

Destination port

Match

destinationTransportPort (11)

Cisco server port (45009)

Destination IP address

Match

Use one of: destinationIPv4Address (12), destinationIPv6Address (28)

Use one of: Cisco server IP address, IPv4 (45005), Cisco server IP address, IPv6 (45007)

ID of the interface packets are sent to

Collect

egressInterface (14)

Recommended Fields

Whether you have configured flow records already or not, we recommend ensuring the following collect fields are part of your flow records, in addition to the minimum fields, for optimum network visibility.

Description

Field Type

IANA Field

Number of incoming packets

Collect

packetDeltaCount (2)

TCP transport flags

Collect

tcpControlBits (6)

IP address of the next hop

Collect

Use one of: ipNextHopIPv4Address (15), ipNextHopIPv6Address (62)

Direction of the traffic flow

Collect

flowDirection (61)

ID of the application generating the traffic (for Cisco networks)

Collect

applicationId (95)

The point where traffic observation occurs

Collect

observationPointId (Interface) (138)

Timestamp of the absolute first packet

Collect

flowStartMilliseconds (152)

Timestamp of the absolute last packet

Collect

flowEndMilliseconds (153)

DSCP value, IPv4 or IPv6

Collect

ipDiffServCodePoint (195)

For Optimum Functionality

In order to generate fully enriched network flow data in ThousandEyes, you need to enable certain features inside your enterprise network.

Application Recognition

For those using non-Cisco devices and for Meraki MX devices, Traffic Insights can infer application information about applications that have public IP addresses. As such, Traffic Insights is able to enrich your flow data with information about many commercial applications you use, so long as their IP addresses are public. Note that ThousandEyes cannot guarantee that an application with a public IP address will always be identifiable, but makes a best effort to identify it.

Identify Subnets

No clustering: You cannot enable Traffic Insights for an Enterprise Agent cluster. Any Enterprise Agent that has already been enabled for Traffic Insights cannot be added to a cluster. See for more information.

To check if you already have a supported Enterprise Agent, see . If you don’t already have a compatible Enterprise Agent, you can install one for Traffic Insights; see the section for the relevant articles about installing an Enterprise Agent on a virtual appliance or via the CAF.

Flow forwarder capacity is estimated for each Enterprise Agent type below. Estimations are based on the most powerful machine configuration and on records containing all . Minimum flow records could enable a higher rate while flow records with more than the recommended number of fields might yield a lower rate. A packet per second (PPS) is estimated to equal around 10 flows per second (FPS).

A is capped at 500,000 FPS (around 50,000 PPS), regardless.

Note: Once you have set up Traffic Insights, you can check whether your forwarder is breaching capacity via the Dropped Events column at . If the number in the column is higher than 0, some packets were likely discarded due to overcapacity. For example, a TEVA agent that receives 250,000 FPS may drop up to 50,000 FPS (around 5,000 PPS) in order to maintain its estimated capacity of 200,000 FPS. The Dropped Events column in this case would reflect the number of discarded packets. See the for a screenshot.

Any device that supports the standard NetFlow v9 or IPFIX with the minimum fields can send network flow data to Traffic Insights. See for information about the minimum fields.

The network flow configuration for NetFlow v9 and IPFIX can vary based on the network environment. Traffic Insights only requires a minimum set of fields, but we recommend using the recommended set of fields for optimum functionality, including application visibility fields. Minimum fields correspond to a 5T (5-tuple) record type. Find more information below at .

For those using Cisco Catalyst SD-WAN Manager (formerly vManage) or Meraki MX, the bulk of the network flow configuration is performed via their user interfaces. See for SD-WAN Manager and for Meraki MX.

However, if you are not using Cisco’s SD-WAN solution or Meraki MX, you may need to manually configure network flow records on your Cisco or non-Cisco devices in order to create records that can be ingested by Traffic Insights. The following section describes the minimum and recommended IPFIX and NetFlow-equivalent fields required as part of these records. The configuration steps for manual flow record configuration are described under .

Information within this section is based on from the Internet Assigned Numbers Authority (IANA). The IANA document serves as a network flow data dictionary reference.

Cisco offers application recognition via NetFlow v9 on its networks via two methods: for non-SD-WAN solutions, you must include the applicaton ID field as part of your flow record (see ); for networks using an SD-WAN solution, you must enable an application policy or application visibility on your SD-WAN solution (see for information about application visibility on your device template). Both of these methods activate Cisco's NBAR (Network Based Application Recognition), which enhances your Traffic Insights experience with application data for applications with public IP addresses. Through your SD-WAN solution, or via the CLI for non-SD-WAN Cisco networks, you can also separately set up custom applications for identification, ensuring you see applications in Traffic Insights with both public and private IP addresses (see ).

Subnet tagging gives you more granular data about your network flows, such as if they pertain to your engineering department or your HR department. If you want to use the subnet tagging feature of Traffic Insights, you need a list of all the subnets in use on your network, and then decide which ones are relevant for traffic profiling. The ones that are relevant can be tagged in Traffic Insights, as described in the section titled .

Working with Enterprise Agent Clusters
Finding a Supported Agent
Enterprise Agent Installing
ThousandEyes Account Group
Traffic Insights > Settings > Forwarders
Forwarders Screen
Step 3.6 Option 1: Cisco SD-WAN Centralized Cflowd policy
3.3 Meraki Dashboard Configuration
3.1 Command-Line Configuration
IP Flow Information Export (IPFIX) Entities
Subnet Tagging Screen
network components
Virtual Appliances
Forwarder Flow Capacity
recommended fields
Minimum Fields Required
Network Flow Traffic Types
Configure Traffic Flow Monitoring
Chapter: NBAR2 Custom Protocol
recommended fields