mirror of
https://github.com/fluencelabs/tendermint
synced 2025-04-25 14:52:17 +00:00
[monitor] bring back readme
This commit is contained in:
parent
445ddbf040
commit
4a03eb7baf
@ -1,5 +1,5 @@
|
|||||||
Benchmarking and Monitoring
|
Benchmarking
|
||||||
===========================
|
============
|
||||||
|
|
||||||
tm-bench
|
tm-bench
|
||||||
--------
|
--------
|
||||||
@ -85,75 +85,3 @@ Development
|
|||||||
|
|
||||||
make get_vendor_deps
|
make get_vendor_deps
|
||||||
make test
|
make test
|
||||||
|
|
||||||
tm-monitor
|
|
||||||
----------
|
|
||||||
|
|
||||||
Tendermint blockchain monitoring tool; watches over one or more nodes, collecting and providing various statistics to the user: https://github.com/tendermint/tools/tree/master/tm-monitor
|
|
||||||
|
|
||||||
Quick Start
|
|
||||||
^^^^^^^^^^^
|
|
||||||
|
|
||||||
Docker
|
|
||||||
~~~~~~
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
|
|
||||||
docker run -it --rm -v "/tmp:/tendermint" -p "46657:46657" --name=tm tendermint/tendermint
|
|
||||||
|
|
||||||
docker run -it --rm --link=tm tendermint/monitor tm:46657
|
|
||||||
|
|
||||||
Binaries
|
|
||||||
~~~~~~~~
|
|
||||||
|
|
||||||
This will be the same as you did for ``tm-bench`` above, except for the last line which should be:
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
tm-monitor localhost:46657
|
|
||||||
|
|
||||||
Usage
|
|
||||||
^^^^^
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
tm-monitor [-v] [-no-ton] [-listen-addr="tcp://0.0.0.0:46670"] [endpoints]
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
# monitor single instance
|
|
||||||
tm-monitor localhost:46657
|
|
||||||
|
|
||||||
# monitor a few instances by providing comma-separated list of RPC endpoints
|
|
||||||
tm-monitor host1:46657,host2:46657
|
|
||||||
Flags:
|
|
||||||
-listen-addr string
|
|
||||||
HTTP and Websocket server listen address (default "tcp://0.0.0.0:46670")
|
|
||||||
-no-ton
|
|
||||||
Do not show ton (table of nodes)
|
|
||||||
-v verbose logging
|
|
||||||
|
|
||||||
RPC UI
|
|
||||||
^^^^^^
|
|
||||||
|
|
||||||
Run ``tm-monitor`` and visit http://localhost:46670
|
|
||||||
You should see the list of the available RPC endpoints:
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
http://localhost:46670/status
|
|
||||||
http://localhost:46670/status/network
|
|
||||||
http://localhost:46670/monitor?endpoint=_
|
|
||||||
http://localhost:46670/status/node?name=_
|
|
||||||
http://localhost:46670/unmonitor?endpoint=_
|
|
||||||
|
|
||||||
The API is available as GET requests with URI encoded parameters, or as JSONRPC
|
|
||||||
POST requests. The JSONRPC methods are also exposed over websocket.
|
|
||||||
|
|
||||||
Development
|
|
||||||
^^^^^^^^^^^
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
make get_vendor_deps
|
|
||||||
make test
|
|
||||||
|
@ -1 +1,74 @@
|
|||||||
NOTE: Please see the ``tm-bench`` directory for the README about tm-monitor. You can also find the documentation at: http://tendermint.readthedocs.io
|
Monitoring
|
||||||
|
==========
|
||||||
|
|
||||||
|
tm-monitor
|
||||||
|
----------
|
||||||
|
|
||||||
|
Tendermint blockchain monitoring tool; watches over one or more nodes, collecting and providing various statistics to the user: https://github.com/tendermint/tools/tree/master/tm-monitor
|
||||||
|
|
||||||
|
Quick Start
|
||||||
|
^^^^^^^^^^^
|
||||||
|
|
||||||
|
Docker
|
||||||
|
~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
|
||||||
|
docker run -it --rm -v "/tmp:/tendermint" -p "46657:46657" --name=tm tendermint/tendermint
|
||||||
|
|
||||||
|
docker run -it --rm --link=tm tendermint/monitor tm:46657
|
||||||
|
|
||||||
|
Binaries
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
This will be the same as you did for ``tm-bench`` above, except for the last line which should be:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
tm-monitor localhost:46657
|
||||||
|
|
||||||
|
Usage
|
||||||
|
^^^^^
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
tm-monitor [-v] [-no-ton] [-listen-addr="tcp://0.0.0.0:46670"] [endpoints]
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
# monitor single instance
|
||||||
|
tm-monitor localhost:46657
|
||||||
|
|
||||||
|
# monitor a few instances by providing comma-separated list of RPC endpoints
|
||||||
|
tm-monitor host1:46657,host2:46657
|
||||||
|
Flags:
|
||||||
|
-listen-addr string
|
||||||
|
HTTP and Websocket server listen address (default "tcp://0.0.0.0:46670")
|
||||||
|
-no-ton
|
||||||
|
Do not show ton (table of nodes)
|
||||||
|
-v verbose logging
|
||||||
|
|
||||||
|
RPC UI
|
||||||
|
^^^^^^
|
||||||
|
|
||||||
|
Run ``tm-monitor`` and visit http://localhost:46670
|
||||||
|
You should see the list of the available RPC endpoints:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
http://localhost:46670/status
|
||||||
|
http://localhost:46670/status/network
|
||||||
|
http://localhost:46670/monitor?endpoint=_
|
||||||
|
http://localhost:46670/status/node?name=_
|
||||||
|
http://localhost:46670/unmonitor?endpoint=_
|
||||||
|
|
||||||
|
The API is available as GET requests with URI encoded parameters, or as JSONRPC
|
||||||
|
POST requests. The JSONRPC methods are also exposed over websocket.
|
||||||
|
|
||||||
|
Development
|
||||||
|
^^^^^^^^^^^
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
make get_vendor_deps
|
||||||
|
make test
|
||||||
|
Loading…
x
Reference in New Issue
Block a user