From 453e1cbe707594403c766aed1d887ed099bb00be Mon Sep 17 00:00:00 2001 From: import this <97586125+serinko@users.noreply.github.com> Date: Fri, 20 Feb 2026 14:19:25 +0000 Subject: [PATCH] [DOCs/operators]: Documentation for SOCKS5 probe score (#6473) * bump up stats and run prebuild * fix typos * add socks5 probe calculation * fix conflicts * fix wording --- .../outputs/api-scraping-outputs/time-now.md | 2 +- .../operators/performance-and-testing.mdx | 43 +++++++++++++++++-- 2 files changed, 40 insertions(+), 5 deletions(-) diff --git a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md index f274715f58..06bc0da1c0 100644 --- a/documentation/docs/components/outputs/api-scraping-outputs/time-now.md +++ b/documentation/docs/components/outputs/api-scraping-outputs/time-now.md @@ -1 +1 @@ -Thursday, February 19th 2026, 13:59:34 UTC +Friday, February 20th 2026, 13:42:15 UTC \ No newline at end of file diff --git a/documentation/docs/pages/operators/performance-and-testing.mdx b/documentation/docs/pages/operators/performance-and-testing.mdx index 9e3d96c565..e4e01f1301 100644 --- a/documentation/docs/pages/operators/performance-and-testing.mdx +++ b/documentation/docs/pages/operators/performance-and-testing.mdx @@ -1,4 +1,5 @@ import { Callout } from 'nextra/components'; +import { Steps } from 'nextra/components'; import { Tabs } from 'nextra/components'; import { MyTab } from 'components/generic-tabs.tsx'; import { AccordionTemplate } from 'components/accordion-template.tsx'; @@ -7,11 +8,11 @@ import NodePerfMixnet from 'components/operators/snippets/node-perf-mixnet.mdx'; # Performance Monitoring & Testing -As Nym developers constantly improve the software, the role of Node Operators is to keep their nodes up to date, monitor their performance and share feedback with the rest of the community and Nym team. Node performance measurements and [server monitoring](#monitoring) are an essential pillar of our common work. +As Nym developers constantly improve the software, the role of Node Operators is to keep their nodes up to date, monitor their performance and share feedback with the rest of the community and Nym team. Node performance measurements and [server monitoring](#monitoring) are an essential pillar of our common work. -Nym Network is routed either through the Mixnet (5-hop) or through Wireguard (2-hop). In all cases Nym node operators always employ only one binary called [`nym-node`](/operators/nodes/nym-node). Through provided arguments (or changes in the config file), `nym-node` can be utilised for different [functionalities](/operators/nodes/nym-node/setup#functionality-mode). However, once it's [registered to Nym Network](/operators/nodes/nym-node/bonding) it's by default available for Nym Mixnet not for Wireguard routing. Only nodes with Wireguard enabled, are also available for Wireguard routing. This creates a situation where every Wireguard enabled `nym-node` is required to have a solid performance score in Mixnet to begin with, but not every Mixnet routing `nym-node` must have Wireguard enabled. +Nym Network is routed either through the Mixnet (5-hop) or through Wireguard (2-hop). In all cases Nym node operators always employ only one binary called [`nym-node`](/operators/nodes/nym-node). Through provided arguments (or changes in the config file), `nym-node` can be utilised for different [functionalities](/operators/nodes/nym-node/setup#functionality-mode). However, once it's [registered to Nym Network](/operators/nodes/nym-node/bonding) it's by default available for Nym Mixnet not for Wireguard routing. Only nodes with Wireguard enabled, are also available for Wireguard routing. This creates a situation where every Wireguard enabled `nym-node` is required to have a solid performance score in Mixnet to begin with, but not every Mixnet routing `nym-node` must have Wireguard enabled. -Given this complexity, we divided the part below about perfromance calculation logic and node selection into two parallel tabs: Mixnet and Wireguard. +Given this complexity, we divided the part below about perfromance calculation logic and node selection into two parallel tabs: Mixnet and Wireguard.
/api/v1/roles ``` +## Socks5 Score Calculation + +Geateway probe also runs tests through a Network requester - a module build as a part of `nym-node`, active only in mode Exit Gateway, used for [Socks5](/developers/clients/socks5) proxy TCP connection. + +Socks5 score is displayed in [Nym Node Status Observatory](https://harbourmaster.nymtech.net) (if you open a page with a particular gateway) and in detail it can be previewed at [mainnet-node-status-api.nymtech.cc/dvpn/v1/directory/gateways](https://mainnet-node-status-api.nymtech.cc/dvpn/v1/directory/gateways) or when running own instance of [Gateway probe](/operators/performance-and-testing/gateway-probe). + +### Socks5 Score Calculation Process + +Socks5 score is defined in the json output of Gateway probe as `"socks5"` key. Here is an example of the dictionary: + +```json + "socks5": { + "can_proxy_https": true, + "score": "medium", + "errors": null + } +``` + +> Note: When we write *gateway* we refer to a `nym-node --mode exit-gateway` in this sub-chapter. + + +1. Gateway gets probed as part of a Gateway probe test where other components get tested as well + +2. Probe tries to connect to the Gateway through Socks5 10 times per testing instance + +3. Latency is calculated as an average of the successful attempts + +4. Gateway is scored as `"low"`, `"medium"`, `"high"` or `"offline"`, in numbers it means: + - `"offline"`: Gateway failed the test 3 or more times (out of 10 attempts) + - `"high"`: Top 50% of nodes with lowest average latency + - `"medium"`: Following 25% of nodes with lowest average latency below top 50% nodes + - `"low"`: Remaining 25% of nodes with the highest average latency time + + ## Monitoring There are multiple ways to monitor performance of nodes and the machines on which they run. For the purpose of maximal privacy and decentralisation of the data - preventing Nym Mixnet from any global adversary takeover - we created these pages as a source of mutual empowerment, a place where operators can share and learn new skills to **setup metrics monitors on their own infrastructure**. @@ -94,4 +129,4 @@ We do testing in order to **understand and increase the overall quality of the N 7. Adjust rewarding based on the machine specs and server pricing Visit [Nym Harbour Master](https://harbourmaster.nymtech.net/) monitoring page to monitor network components (nodes) performance. -*/} \ No newline at end of file +*/}