import this
04fd197f5a
* fix socks5 syntax * reshape backup and restore and add proxy * fix URLS * remove deprecated node-api-check - archived for when there is time to maintain the tool * add hash verification step
76 lines
4.1 KiB
Plaintext
76 lines
4.1 KiB
Plaintext
import { Callout } from 'nextra/components';
|
||
|
||
# Performance Monitoring & Testing
|
||
|
||
Nym Mixnet has been running on mainnet for quite some time. There is still work to be done in order for the network to meet its full potential - mass adoption of privacy through fully distributed Mixnet.
|
||
|
||
As developers we need to be constantly improving the software. Operators have as much important role, keep their nodes up to date, monitor their performance and share their feedback with the rest of the community and core developers.
|
||
|
||
Therefore [monitoring](#monitoring) and [testing](#testing) are essential pieces of our common work. We call out all Nym operators to join the efforts!
|
||
|
||
## Functionality & Performance Check
|
||
|
||
If you want to just quickly check your nodes performance, connectivity and much more, visit [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net/).
|
||
|
||
For more information about available endpoints and their status, you can refer to:
|
||
```sh
|
||
# sustitude <IPv4_ADDRESS> or <HOSTNAME> with the one corresponding to your node
|
||
# for http
|
||
http://<IPv4_ADDRESS>:8080/api/v1/swagger/#/
|
||
# or
|
||
http://<IPv4_ADDRESS>/api/v1/swagger/#/
|
||
|
||
# for reversed proxy/WSS
|
||
https://<HOSTNAME>/api/v1/swagger/#/
|
||
```
|
||
|
||
For example to determine which mode your node is running, you can check the `:8080/api/v1/roles` endpoint:
|
||
```sh
|
||
# sustitude <IPv4_ADDRESS> or <HOSTNAME> with the one corresponding to your node
|
||
# for http
|
||
http://<IPv4_ADDRESS>:8080/api/v1/roles
|
||
# or
|
||
http://<IPv4_ADDRESS>/api/v1/roles
|
||
|
||
# for reversed proxy/WSS
|
||
https://<HOSTNAME>/api/v1/roles
|
||
```
|
||
|
||
## 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**.
|
||
|
||
### Guides to Setup Own Metrics
|
||
|
||
A list of different scripts, templates and guides for easier navigation:
|
||
|
||
* [`nym-gateway-probe`](perfomance-and-testing/gateway-probe.mdx) - a useful tool used under the hood of [harbourmaster.nymtech.net](https://harbourmaster.nymtech.net)
|
||
* [Prometheus and Grafana](performance-and-testing/prometheus-grafana.mdx) self-hosted setup
|
||
* [Nym-node CPU cron service](https://gist.github.com/tommyv1987/97e939a7adf491333d686a8eaa68d4bd) - an easy bash script by Nym core developer [@tommy1987](https://gist.github.com/tommyv1987), designed to monitor a CPU usage of your node, running locally
|
||
* Nym's script [`prom_targets.py`](https://github.com/nymtech/nym/blob/develop/scripts/prom_targets.py) - a useful python program to request data from API and can be run on its own or plugged to more sophisticated flows
|
||
|
||
### Collecting Testing Metrics
|
||
|
||
For the purpose of the performance testing Nym core developers plan to run instances of Prometheus and Grafana connected to Node explorer in the house. The network overall key insights we seek from these tests are primarily internal. We're focused on pinpointing bottlenecks, capacity loads, and monitoring cpu usage on the nodes' machines.
|
||
|
||
|
||
## Testing
|
||
|
||
<Callout type="info" emoji="ℹ️">
|
||
For the moment we paused Fast and Furious `perf` environment. All load and speed testing is carried on directly Nym Mainnet as this is the only way to collect real performance data.
|
||
</Callout>
|
||
|
||
We do testing in order to **understand and increase the overall quality of the Nym Network**. The main takeaways of such event are:
|
||
|
||
1. Understanding of the network behavior under full load
|
||
- How many mixnet client users can all active set entry gateways handle simultaneously?
|
||
- How much sustained IP traffic can a subset of mainnet nodes sustain?
|
||
2. Needed improvements of Nym Node binaries to improve the throughput on mainnet
|
||
3. Measurement of required machine specs
|
||
4. Raw data record
|
||
5. Increase quality of Nym Nodes
|
||
6. Show each operator a way to monitor their nodes in a distributed fashion
|
||
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.
|