ThousandEyes
ThousandEyes monitors the performance of both local and wide-area networks. ThousandEyes combines Internet and WAN visibility, browser synthetics, end-user monitoring, and Internet Insights to deliver a holistic view of your hybrid digital ecosystem β across cloud, SaaS, and the Internet. It's a SaaS-based tool that helps troubleshoot application delivery and maps Internet performance.
Scope of supportβ
- Query parameters retrieval with
sloctl
- Event logs for direct connection method
ThousandEyes metric support:
-
Network Latency - is the interval time (in milliseconds) from sending a network packet to when the test-assigned agent receives the response.
-
Network Loss - is the total loss of the network packet (in percents).
-
Page Load - is the interval of time (in milliseconds) from the load event to the point when the website is loaded.
-
DOM Load Time - is the interval of time (in milliseconds) required for the browser to build the websiteβs Document Object Model (DOM)
-
HTTP Server Response - is the interval between the beginning of the request and the web server successfully sending the first byte of the response to the client.
-
HTTP Server Availability - is the availability for a given agent. For HTTP Server Availability, Nobl9 receives status codes of an
http
response, for example, 200, 201, 400, or 501.warningWhen there are multiple ThousandEyes agents, Nobl9 can receive multiple HTTP response status codes in a single request. In this situation, Nobl9 ingests only the highest status code.
-
HTTP Server Throughput - is the Wire Size divided by the Receive Time (in bits per second). For more information, refer to the ThousandEyes documentation.
-
HTTP Server Total Time - time (in milliseconds) of ThousandEyes agent receiving the last byte of your server's response.
-
DNS Server Resolution Time - time (in milliseconds) of ThousandEyes agent receiving the response from the DNS server about your domain.
-
DNS DNSSEC Valid - 1 if keychain for a domain record is valid, 0 otherwise.
Each measurement is obtained per ThousandEyes test interval.
For details about all ThousandEyes metric types, check ThousandEyes Knowledge Base | ThousandEyes documentation and ThousandEyes Test Data | ThousandEyes documentation.
The following table is an overview of the supported ThousandEyes tests and corresponding Nobl9 names:
Name | Response property read | Nobl9 YAML name | Aggregation* | Minimum agent (supported channel) |
---|---|---|---|---|
Network > End-to-End metrics | avgLatency | net-latency | mean | 0.33.0 (stable, beta) |
Network > End-to-End metrics | Loss | net-loss | mean | 0.33.0 (stable, beta) |
Web > Page load | pageLoadTime | web-page-load | mean | 0.33.0 (stable, beta) |
Web > Page load | domLoadTime | web-dom-load | mean | 0.33.0 (stable, beta) |
Web > HTTP server | responseTime | http-response-time | mean | 0.33.0 (stable, beta) |
Web > HTTP server | responseCode | http-server-availability | max | 0.52.0 (stable, beta) |
Web > HTTP server | throughput | http-server-throughput | mean | 0.52.0 (stable, beta) |
Web > HTTP server | totalTime | http-server-total-time | mean | 0.68.0-beta01 (beta) 0.67.2 (stable) |
DNS > Server metric | resolutionTime | dns-server-resolution-time | mean | 0.68.0-beta01 (beta) 0.67.2 (stable) |
DNS > DNSSEC | valid | dns-dnssec-valid | logical conjunction | 0.68.0-beta01 (beta) 0.67.2 (stable) |
*) If your test returns more than one result per round.
Whenever your ThousandEyes SLO has incompatible data source version/channel, the SLO config won't be served to your data source.
Authenticationβ
Nobl9 requires OAUTH_BEARER_TOKEN
to communicate with ThousandEyes.
To get the OAUTH_BEARER_TOKEN
:
-
Log in to your ThousandEyes account.
-
Navigate to Account Settings.
-
Select Users and Roles.
-
Navigate to the bottom of the page and you will see User API Tokens.
-
Select OAuth Bearer Token.
Currently, Nobl9 only supportsOAUTH_BEARER_TOKEN
.
Adding ThousandEyes as a data sourceβ
To ensure data transmission between Nobl9 and ThousandEyes, it may be necessary to list Nobl9 IP addresses as trusted.
- 18.159.114.21
- 18.158.132.186
- 3.64.154.26
You can add the Thousandeyes data source using the direct or agent connection methods.
Direct connection methodβ
Direct configuration for ThousandEyes requires users to enter their credentials which Nobl9 stores safely.
Nobl9 Webβ
Follow these steps to set up a direct configuration:
- Navigate to Integrations > Sources.
- Click
.
- Click the required Source icon.
- Choose Direct.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Enter your OAuth Bearer Token.
Refer to the Authentication section above for more details.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in ThousandEyes integration for Query delay is
1 minute
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in ThousandEyes integration for Query delay is
- Click Add Data Source
sloctlβ
The YAML for setting up a direct connection to ThousandEyes looks like this:
apiVersion: n9/v1alpha
kind: Direct
metadata:
name: thousandeyes-direct
displayName: Thousandeyes direct
project: thousandeyes-direct
spec:
description: Direct integration with 1000 eyes
sourceOf:
- Metrics
- Services
releaseChannel: beta # string, one of: beta || stable
queryDelay:
unit: Minute # string, one of: Second || Minute
value: 720 # numeric, must be a number less than 1440 minutes (24 hours)
logCollectionEnabled: false # boolean, defaults to 'false'. Set to true if you'd like your source to collect logs. It's a beta functionality available only through direct release channel. Reach out to support@nobl9.com to activate it.
thousandEyes:
oauthBearerToken: "" #secret
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
logCollectionEnabled optional | boolean | Optional. Defaults to false . Set to true if you'd like your direct to collect event logs. Beta functionality available only through direct release channel. Reach out to support@nobl9.com to activate it. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
thousandEyes.oauthBearerToken mandatory | string, secret | Required to communicate with ThousandEyes. See authentication section above for more details. |
Agent connection methodβ
Nobl9 Webβ
Follow the instructions below to configure your ThousandEyes agent.
- Navigate to Integrations > Sources.
- Click
.
- Click the required Source icon.
- Choose Agent.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in ThousandEyes integration for Query delay is
1 minute
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in ThousandEyes integration for Query delay is
- Click Add Data Source
sloctlβ
The YAML for setting up an agent connection to ThousandEyes looks like this:
apiVersion: n9/v1alpha
kind: Agent
metadata:
name: thousandeyes
displayName: ThousandEyes
project: thousandeyes
spec:
sourceOf:
- Metrics
- Services
releaseChannel: beta
queryDelay:
unit: Minute
value: 720
thousandEyes: {}
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
You can deploy only one agent in one YAML file by using the sloctl apply
command.
Agent deploymentβ
When you add the data source, Nobl9 automatically generates a Kubernetes configuration and a Docker command line for you to use to deploy the agent. Both of these are available in the web UI, under the Agent Configuration section. Be sure to swap in your credentials (e.g., replace <OAUTH_BEARER_TOKEN>
with your actual token).
- Kubernetes
- Docker
If you use Kubernetes, you can apply the supplied YAML config file to a Kubernetes cluster to deploy the agent. It will look something like this:
# DISCLAIMER: This deployment description contains only the fields necessary for the purpose of this demo.
# It is not a ready-to-apply k8s deployment description, and the client_id and client_secret are only exemplary values.
apiVersion: v1
kind: Secret
metadata:
name: nobl9-agent-nobl9-dev-thousandeyes-secret
namespace: default
type: Opaque
stringData:
thousandeyes_oauth_bearer_token: "<THOUSANDEYES_OAUTH_BEARER_TOKEN>"
client_id: "unique_client_id"
client_secret: "unique_client_secret"
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: nobl9-agent-nobl9-dev-thousandeyes-agent-deployment
namespace: default
spec:
replicas: 1
selector:
matchLabels:
nobl9-agent-name: "my-unique-agent-name"
nobl9-agent-project: "thousandeyes"
nobl9-agent-organization: "nobl9-dev"
template:
metadata:
labels:
nobl9-agent-name: "my-unique-agent-name"
nobl9-agent-project: "thousandeyes"
nobl9-agent-organization: "nobl9-dev"
spec:
containers:
- name: agent-container
image: nobl9/agent:0.80.0
resources:
requests:
memory: "350Mi"
cpu: "0.1"
env:
- name: N9_CLIENT_ID
valueFrom:
secretKeyRef:
key: client_id
name: nobl9-agent-nobl9-dev-thousandeyes-secret
- name: N9_CLIENT_SECRET
valueFrom:
secretKeyRef:
key: client_secret
name: nobl9-agent-nobl9-dev-thousandeyes-secret
- name: THOUSANDEYES_OAUTH_BEARER_TOKEN
valueFrom:
secretKeyRef:
key: thousandeyes_oauth_bearer_token
name: nobl9-agent-nobl9-dev-thousandeyes-secret
# The N9_METRICS_PORT is a variable specifying the port to which the /metrics and /health endpoints are exposed.
# The 9090 is the default value and can be changed.
# If you donβt want the metrics to be exposed, comment out or delete the N9_METRICS_PORT variable.
- name: N9_METRICS_PORT
value: "9090"
If you use Docker, you can run the Docker command to deploy the agent. It will look something like this:
docker run -d --restart on-failure \
--name nobl9-agent-nobl9-dev-thousandeyes-agent \
-e N9_CLIENT_ID="unique_client_id" \
-e N9_CLIENT_SECRET="unique_client_secret" \
# The N9_METRICS_PORT is a variable specifying the port to which the /metrics and /health endpoints are exposed.
# The 9090 is the default value and can be changed.
# If you donβt want the metrics to be exposed, comment out or delete the N9_METRICS_PORT variable.
-e N9_METRICS_PORT=9090 \
-e THOUSANDEYES_OAUTH_BEARER_TOKEN="" \
nobl9/agent:0.80.0
Creating SLOs with ThousandEyesβ
Nobl9 Webβ
Follow the instructions below to create your SLOs with ThousandEyes in the UI:
-
Navigate to Service Level Objectives.
-
Click
.
-
In step 1 of the SLO wizard, select the service the SLO will be associated with.
-
In step 2, select ThousandEyes as the data source for your SLO, then specify the Metric. For ThousandEyes you can use only a threshold metric, where a single time series is evaluated against a threshold, The ThousandEyes metric specification has two fields:
testID
andtestType
.-
Enter a
testID
. It is an ID of the test configured in ThousandEyes. It is a mandatory field, and it must be a positive number. -
Choose a
testType
. It is a ThousandEyes metric. You can choose between the following ThousandEyes metrics supported by Nobl9 (refer to the Scope of support section for more details):-
Network Latency
-
Network Loss
-
Page Load
-
DOM Load Time
-
HTTP Server Response
-
HTTP Server Availability
-
HTTP Server Throughput
-
-
-
In step 3, define a Time Window for the SLO.
-
Rolling time windows are better for tracking the recent user experience of a service.
-
Calendar-aligned windows are best suited for SLOs that are intended to map to business metrics measured on a calendar-aligned basis, such as every calendar month or every quarter.
-
In step 4, specify the Error Budget Calculation Method and your Objective(s).
- Occurrences method counts good attempts against the count of total attempts.
- Time Slicesmethod measures how many good minutes were achieved (when a system operates within defined boundaries) during a time window.
- You can define up to 12 objectives for an SLO.
See the use case example and the SLO calculations guide for more information on the error budget calculation methods.
-
In step 5, add the Display name, Name, and other settings for your SLO:
- Create a composite SLO
- Set notification on data, if this option is available for your data source.
When activated, Nobl9 notifies you if your SLO hasn't received data or received incomplete data for more than 15 minutes. - Add alert policies, labels, and links, if required.
You can add up to 20 links per SLO.
-
Click Create SLO.
sloctlβ
- Web page load
- Response time
- Net latency
- DOM load
- Net loss
- Server availability
- Server throughput
- apiVersion: n9/v1alpha
kind: SLO
metadata:
name: my-thousandeyes-web-page-load-time-rolling-occurrences
project: thousandeyes
spec:
service: thousandeyes
indicator:
metricSource:
name: thousandeyes
timeWindows:
- unit: Hour
count: 1
isRolling: true
budgetingMethod: Occurrences
objectives:
- displayName: Good
op: lte
rawMetric:
query:
thousandEyes:
testID: 2280492
testType: web-page-load
value: 75
target: 0.90
- apiVersion: n9/v1alpha
kind: SLO
metadata:
name: my-thousandeyes-response-time-rolling-occurrences
project: thousandeyes
spec:
service: thousandeyes
indicator:
metricSource:
name: thousandeyes
timeWindows:
- unit: Hour
count: 1
isRolling: true
budgetingMethod: Occurrences
objectives:
- displayName: Good
op: lte
rawMetric:
query:
thousandEyes:
testID: 2014018
testType: http-response-time
value: 75
target: 0.90
- apiVersion: n9/v1alpha
kind: SLO
metadata:
name: my-thousandeyes-net-latency-calendar-occurrences
project: thousandeyes
spec:
service: thousandeyes
indicator:
metricSource:
name: thousandeyes
timeWindows:
- unit: Day
count: 1
calendar:
startTime: 2020-03-09 00:00:00
timeZone: Europe/Warsaw
budgetingMethod: Occurrences
objectives:
- displayName: Good
op: lte
rawMetric:
query:
thousandEyes:
testID: 2014018
testType: net-latency
value: 75
target: 0.90
- apiVersion: n9/v1alpha
kind: SLO
metadata:
name: my-thousandeyes-web-dom-load-rolling-timeslices
project: thousandeyes
spec:
service: thousandeyes
indicator:
metricSource:
name: thousandeyes
timeWindows:
- unit: Day
count: 7
isRolling: true
budgetingMethod: Timeslices
objectives:
- displayName: Good
op: lte
rawMetric:
query:
thousandEyes:
testID: 2280492
testType: web-dom-load
value: 40
target: 0.50
timeSliceTarget: 0.50
- displayName: Moderate
op: lte
rawMetric:
query:
thousandEyes:
testID: 2280492
testType: web-dom-load
value: 45
target: 0.75
timeSliceTarget: 0.75
- displayName: Annoying
op: lte
rawMetric:
query:
thousandEyes:
testID: 2280492
testType: web-dom-load```
value: 50
target: 0.95
timeSliceTarget: 0.95
- apiVersion: n9/v1alpha
kind: SLO
metadata:
name: my-thousandeyes-net-loss-rolling-timeslices
project: thousandeyes
spec:
service: thousandeyes
indicator:
metricSource:
name: thousandeyes
rawMetric:
thousandEyes:
testID: 2014018
testType: net-loss
timeWindows:
- unit: Day
count: 1
isRolling: true
budgetingMethod: Timeslices
objectives:
- displayName: Good
op: lte
value: 75
target: 0.90
timeSliceTarget: 0.9
apiVersion: n9/v1alpha
kind: SLO
metadata:
name: server-availability-rolling-occurrences
project: thousandeyes
spec:
service: thousandeyes
indicator:
metricSource:
name: thousandeyes
timeWindows:
- unit: Hour
count: 1
isRolling: true
budgetingMethod: Occurrences
objectives:
- displayName: Good
op: lte
rawMetric:
query:
thousandEyes:
testID: 2748593
testType: http-server-availability
value: 300
target: 0.90
apiVersion: n9/v1alpha
kind: SLO
metadata:
name: server-throughput-calendar-timeslices
project: thousandeyes
spec:
service: thousandeyes
indicator:
metricSource:
name: thousandeyes
timeWindows:
- unit: Day
count: 7
calendar:
startTime: 2020-03-09 00:00:00
timeZone: Europe/Warsaw
budgetingMethod: Timeslices
objectives:
- displayName: Good
op: lte
rawMetric:
query:
thousandEyes:
testID: 2123016
testType: http-server-throughput
value: 3000000
target: 0.90
timeSliceTarget: 0.90
Important notes:
The ThousandEyes metric specification expects two fields: testID
and testType
.
-
testID
is an ID of the test configured in ThousandEyes. It is a mandatory field, and it must be a positive number. -
testType
is an end-to-end ThousandEyes metric. It is a string field. Enter one of the below ThousandEyes metrics supported by Nobl9 (for more details, refer to the Scope of support section above).-
net-latency
-
net-loss
-
web-page-load
-
web-dom-load
-
http-response-time
-
http-server-availability
-
http-server-throughput
-
When the testType
field is missing in the ThousandEyes YAML configuration, net-latency
value is assumed.
If you want to apply http-server-availability
and http-server-throughput
as testType
, update your agent to the 0.52.0 version.
Querying the ThousandEyes serverβ
Nobl9 queries the ThousandEyes instance once every minute. If the agent doesnβt collect any data in a given minute, the next query will be extended to the past two minutes.
ThousandEyes API rate limitsβ
The ThousandEyes API throttles API requests using a 240 request-per-minute (per organization) limit with each page having max 1000 elements included.