ThousandEyes-Test-Report

This script leverages ThousandEyes v7 REST APIs to pull detailed information from a ThousandEyes account and formats it into a comprehensive CSV file for Cloud and Enterprise Agent Tests. This script aims to streamline the process of extracting and analyzing ThousandEyes test data, reducing the time and effort required to gather and analyze network performance data for better monitoring and optimization.

Sample Output:



Primary Language: Python 3.x
Dependencies (Python Libraries): 
- Requests library for API calls
- CSV module for data formatting
- dotenv module for loading environment variables from a .env file
- OS module for interacting with the operating system
- SYS module for system-specific parameters and functions
Standalone Script: Designed as a standalone script, but can be integrated into larger automation frameworks if needed

Contacts:

• Andrew Pignataro (apignata@cisco.com)
• Kalai Shanmugam (kmurugap@cisco.com)
• Mark McBride (markmcbr@cisco.com)

Installation:

Clone the repo

git clone https://github.com/apignata2/ThousandEyes-Test-Report.git

Set up a Python venv
First make sure that you have Python 3 installed on your machine. We will then be using venv to create an isolated environment with only the necessary packages.

Install virtualenv via pip

pip install virtualenv

Create the venv

python3 -m venv venv

Activate your venv

source venv/bin/activate

Install dependencies

pip install -r requirements.txt

Configuration:

1. Obatin the OAuth Bearer Token from your ThousandEyes Account for the authentication when communicating with the APIs

• Navigate to your ThousandEyes
• Account Settings -> Users and Roles -> User API Tokens -> OAuth Bearer Token -> Create

https://app.thousandeyes.com/account-settings/users-roles/

Create an OAuth Bearer Token

Copy the Token and store in a secure location

2. Create a .env File

• Create a file named .env in the root directory of your python project.

• This file will contain your environment variables in the format KEY=VALUE.

• The KEY will be BEARER_TOKEN and VALUE as OAuth Bearer Token you generated

• We will store OAuth Bearer Token in the .env file

Example:

(Optional) Set the file path of the .env file

Windows example:

Mac example:

3. (Optional) Set Account Group Name

• The script will pull the default account group, if no name is set
• You can confirm account group in ThousandEyes by checking the image below

• To change the account group name, set the variable Account_Group_Name in the python code
  

Usage

Run the script:

python3 main.py

Version

1.0.0 (Oct 2024) - Intial Release