pNetwork v3 monitoring is a tool designed to monitor the pNetwork v3 decentralized network.
It allows users to perform essential checks and receive real-time feedback, aiding in the seamless integration into various applications and existent monitoring systems.
It can be run using docker or pipenv.
docker build -t pnetwork-monitoring-v3 .
docker run pnetwork-monitoring-v3 -c <checks>pipenv install
pipenv run python main.py -c <checks>In order to use the tool, you only need to edit the config.py file:
RPC_ENDPOINTS: RPC endpoint url mapping (public or third-party, like QuickNode or Alchemy)ipfs_urlandipfs_port: an IPFS node in order to subscribe to the topicpubsub_timeout: how long the listener should run. Could be a value or a real-time stream (0)
usage: main.py [-h] [-c CHECKS [CHECKS ...] | -a] [-v] [--version]
options:
-h, --help show this help message and exit
-c CHECKS [CHECKS ...], --checks CHECKS [CHECKS ...]
choose the check/s to run
-a, --all run all checks
-v, --verbose print check's labels
--version print version and exit
To run a single check (passing the key value or the full name):
pipenv run python main.py -c 5
- or
pipenv run python main.py -c max_ops_in_queuedocker run pnetwork-monitoring-v3 -c 5
- or
docker run pnetwork-monitoring-v3 -c max_ops_in_queueTo run multiple checks (passing the key values and/or the full names):
pipenv run python main.py -c 5 challenge_status 7docker run pnetwork-monitoring-v3 -c 5 challenge_status 7To run all the checks:
pipenv run python main.py -adocker run pnetwork-monitoring-v3 -a-v (--verbose) will also print the checks' labels.
A quick way to redirect only stdout on files, agents, etc. while maintaining the output:
pipenv run python main.py <args> 2>&1 | tee <log_file/stream>docker run pnetwork-monitoring-v3 <args> 2>&1 | tee <log_file/stream>Or just to redirect the output:
pipenv run python main.py <args> 2>&1 > <log_file/stream>docker run pnetwork-monitoring-v3 <args> 2>&1 > <log_file/stream>The tool will print the results splitting errors to stderr and results to stdout.
This separation allows users to easily integrate the tool into their favorite monitoring tools
or agents by writing a wrapper.
All the results are json formatted.
1. challenge_period_duration
2. challenge_status
3. components_balances
4. 4.inactive_actors_by_epoch
5. max_ops_in_queue
6. nr_of_ops_in_queue
7. operation_cancelled
8. queue_op_after_user_op
9. queue_operations_with_threshold
10. slashed_actors
11. user_ops
12. ipfs_subpub_pnetwork_topics
Simple run via docker for a single check:
$ docker run pnetwork-monitoring -c 5
{
"title": "max_ops_in_queue",
"timestamp": 1698686055,
"chain": "bsc",
"max_ops_in_queue": 10
}
{
"title": "max_ops_in_queue",
"timestamp": 1698686056,
"chain": "goerli",
"max_ops_in_queue": 10
}
{
"title": "max_ops_in_queue",
"timestamp": 1698686057,
"chain": "polygon",
"max_ops_in_queue": 10
} Simple run via pipenv with multiple checks and verbose:
$ pipenv run python main.py -v -c 1 5
[+] Check `challenge_period_duration` (1):
{
"title": "challenge_period_duration",
"timestamp": 1698686721,
"chain": "bsc",
"challenge_period_duration": 600
}
{
"title": "challenge_period_duration",
"timestamp": 1698686722,
"chain": "goerli",
"challenge_period_duration": 600
}
{
"title": "challenge_period_duration",
"timestamp": 1698686723,
"chain": "polygon",
"challenge_period_duration": 608
}
##########################################
[+] Check `max_ops_in_queue` (5):
{
"title": "max_ops_in_queue",
"timestamp": 1698686727,
"chain": "bsc",
"max_ops_in_queue": 10
}
{
"title": "max_ops_in_queue",
"timestamp": 1698686728,
"chain": "goerli",
"max_ops_in_queue": 10
}
{
"title": "max_ops_in_queue",
"timestamp": 1698686729,
"chain": "polygon",
"max_ops_in_queue": 10
}
##########################################
Run via pipenv for a single check, this time redirecting only stdout on test_log:
$ pipenv run python main.py -c 1 2>&1 > test_log
$ cat test_log
{
"title": "challenge_period_duration",
"timestamp": 1698687084,
"chain": "bsc",
"challenge_period_duration": 600
}
{
"title": "challenge_period_duration",
"timestamp": 1698687085,
"chain": "goerli",
"challenge_period_duration": 600
}
{
"title": "challenge_period_duration",
"timestamp": 1698687086,
"chain": "polygon",
"challenge_period_duration": 608
}
We welcome contributions from the open-source community.
This project is licensed under the MIT License.
Please note that the project is under active development, and the structure and implementation are subject to change.
For any questions, feedback, or discussions, please open an issue on this repository or reach out to us at our contact email.