From 42521afbea202ddac2abc68d21b02d33e2110b21 Mon Sep 17 00:00:00 2001 From: meaghanbauman607 Date: Fri, 13 Feb 2026 09:11:53 -0800 Subject: [PATCH 1/3] custom responsiveness endpoints --- docs/deploy-and-configure/configuration.md | 73 ++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/docs/deploy-and-configure/configuration.md b/docs/deploy-and-configure/configuration.md index 5484c77..b3b70dc 100644 --- a/docs/deploy-and-configure/configuration.md +++ b/docs/deploy-and-configure/configuration.md @@ -40,6 +40,79 @@ The Token associated with your Configuration can be used to link Orbs (see [Depl On the Status page, you can select Orbs, click "Apply Configuration", and select your named configuration to push that config to the selected Orbs. +### Configuring Responsiveness Endpoints + +Orb measures network responsiveness by performing latency tests to various endpoints. You can configure which endpoints Orb uses for its responsiveness measurements to better align with your specific use case or network environment. + +#### Default Behavior + +By default, Orb automatically selects appropriate endpoints for responsiveness testing based on your network location and ISP. + +#### Custom Endpoint Configuration + +You can specify custom endpoints for responsiveness measurements using the `collectors.response.lag_endpoints` configuration option. This allows you to test responsiveness to endpoints that are most relevant to your use case, such as: + +- Your company's servers or data centers +- Specific cloud providers or CDNs you rely on +- Gaming servers or real-time application endpoints +- Regional internet exchange points + +##### Configuration Format + +Endpoints are specified as a list of endpoint URLs using the format `protocol://host:port`. Supported protocols are: + +- **`icmp`**: ICMP ping tests (e.g., `icmp://8.8.8.8`) +- **`tcp`**: TCP connection tests (e.g., `tcp://example.com:443`) +- **`udp`**: UDP tests (e.g., `udp://example.com:53`) +- **`h3`**: HTTP/3 connection tests (e.g., `h3://fonts.google.com`) + +If no port is specified, the default port for the protocol will be used. + +##### Advanced Configuration Editor + +To configure custom responsiveness endpoints using the advanced configuration editor, add the following property to your configuration JSON: + +```json +{ + "collectors.response.lag_endpoints": [ + "icmp://8.8.8.8", + "icmp://1.1.1.1", + "tcp://your-server.example.com:443", + "h3://fonts.google.com" + ] +} +``` + +##### Example Use Cases + +**Gaming Network Monitoring**: +```json +{ + "collectors.response.lag_endpoints": [ + "icmp://na-west1.valve.net", + "tcp://riot-ping-na-central1.na.leagueoflegends.com:80" + ] +} +``` + +**Enterprise Network Monitoring**: +```json +{ + "collectors.response.lag_endpoints": [ + "icmp://dc1.company.com", + "tcp://backup.company.com:443" + ] +} +``` + +##### Important Notes + +- When custom endpoints are configured, they supplement (rather than replace) the responsiveness measurements +- Endpoint responsiveness data is included in [Responsiveness Datasets](/docs/deploy-and-configure/datasets#responsiveness) +- ICMP (ping) tests require appropriate network permissions and may be blocked by some firewalls +- TCP tests establish connections to the specified port to measure connection establishment time +- Changes to endpoint configuration take effect within a few minutes of applying the configuration + ### Configuring Datasets Orb applications and sensors are capable of producing [Datasets](/docs/deploy-and-configure/datasets) for Scores, Responsiveness, Web Responsiveness, and Speed data. These datasets may be streamed to Orb Cloud, Orb [Local Analytics](/docs/deploy-and-configure/local-analytics), or a destination of your choice. See [Datasets Configuration](/docs/deploy-and-configure/datasets-configuration) for details. From cf724b7b64918c8fb1da84b879e1dfc73bcd0288 Mon Sep 17 00:00:00 2001 From: meaghanbauman607 Date: Fri, 13 Feb 2026 09:50:36 -0800 Subject: [PATCH 2/3] Update configuration.md updated to reference these pingers only: h3, icmp and https --- docs/deploy-and-configure/configuration.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/deploy-and-configure/configuration.md b/docs/deploy-and-configure/configuration.md index b3b70dc..9c50662 100644 --- a/docs/deploy-and-configure/configuration.md +++ b/docs/deploy-and-configure/configuration.md @@ -62,8 +62,7 @@ You can specify custom endpoints for responsiveness measurements using the `coll Endpoints are specified as a list of endpoint URLs using the format `protocol://host:port`. Supported protocols are: - **`icmp`**: ICMP ping tests (e.g., `icmp://8.8.8.8`) -- **`tcp`**: TCP connection tests (e.g., `tcp://example.com:443`) -- **`udp`**: UDP tests (e.g., `udp://example.com:53`) +- **`https`**: HTTPS connection tests (e.g., `https://example.com:443`) - **`h3`**: HTTP/3 connection tests (e.g., `h3://fonts.google.com`) If no port is specified, the default port for the protocol will be used. @@ -77,7 +76,7 @@ To configure custom responsiveness endpoints using the advanced configuration ed "collectors.response.lag_endpoints": [ "icmp://8.8.8.8", "icmp://1.1.1.1", - "tcp://your-server.example.com:443", + "https://your-server.example.com:443", "h3://fonts.google.com" ] } @@ -90,7 +89,7 @@ To configure custom responsiveness endpoints using the advanced configuration ed { "collectors.response.lag_endpoints": [ "icmp://na-west1.valve.net", - "tcp://riot-ping-na-central1.na.leagueoflegends.com:80" + "https://riot-ping-na-central1.na.leagueoflegends.com" ] } ``` @@ -100,7 +99,7 @@ To configure custom responsiveness endpoints using the advanced configuration ed { "collectors.response.lag_endpoints": [ "icmp://dc1.company.com", - "tcp://backup.company.com:443" + "https://backup.company.com:443" ] } ``` From 88d2f5a5cbf92420c20baf1b7512454730aa342a Mon Sep 17 00:00:00 2001 From: meaghanbauman607 <156958372+meaghanbauman607@users.noreply.github.com> Date: Fri, 13 Feb 2026 11:39:53 -0800 Subject: [PATCH 3/3] Update important notes in configuration documentation Clarified that custom endpoints supplement responsiveness measurements. --- docs/deploy-and-configure/configuration.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/deploy-and-configure/configuration.md b/docs/deploy-and-configure/configuration.md index 9c50662..35c9dc4 100644 --- a/docs/deploy-and-configure/configuration.md +++ b/docs/deploy-and-configure/configuration.md @@ -106,7 +106,6 @@ To configure custom responsiveness endpoints using the advanced configuration ed ##### Important Notes -- When custom endpoints are configured, they supplement (rather than replace) the responsiveness measurements - Endpoint responsiveness data is included in [Responsiveness Datasets](/docs/deploy-and-configure/datasets#responsiveness) - ICMP (ping) tests require appropriate network permissions and may be blocked by some firewalls - TCP tests establish connections to the specified port to measure connection establishment time