You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

92 lines
2.4 KiB

  1. # tm-monitor
  2. Tendermint blockchain monitoring tool; watches over one or more nodes,
  3. collecting and providing various statistics to the user:
  4. - [https://github.com/tendermint/tendermint/tree/master/tools/tm-monitor](https://github.com/tendermint/tendermint/tree/master/tools/tm-monitor)
  5. ## Quick Start
  6. ### Docker
  7. Assuming your application is running in another container with the name
  8. `app`:
  9. ```
  10. docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
  11. docker run -it --rm -v "/tmp:/tendermint" -p "26657:26657" --name=tm --link=app tendermint/tendermint node --proxy_app=tcp://app:26658
  12. docker run -it --rm -p "26670:26670" --link=tm tendermint/monitor tm:26657
  13. ```
  14. If you don't have an application yet, but still want to try monitor out,
  15. use `kvstore`:
  16. ```
  17. docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
  18. docker run -it --rm -v "/tmp:/tendermint" -p "26657:26657" --name=tm tendermint/tendermint node --proxy_app=kvstore
  19. docker run -it --rm -p "26670:26670" --link=tm tendermint/monitor tm:26657
  20. ```
  21. ### Using Binaries
  22. [Install Tendermint](https://github.com/tendermint/tendermint#install)
  23. then run:
  24. ```
  25. tendermint init
  26. tendermint node --proxy_app=kvstore
  27. tm-monitor localhost:26657
  28. ```
  29. with the last command being in a separate window.
  30. ## Usage
  31. ```
  32. Tendermint monitor watches over one or more Tendermint core
  33. applications, collecting and providing various statistics to the user.
  34. Usage:
  35. tm-monitor [-no-ton] [-listen-addr="tcp://0.0.0.0:26670"] [endpoints]
  36. Examples:
  37. # monitor single instance
  38. tm-monitor localhost:26657
  39. # monitor a few instances by providing comma-separated list of RPC endpoints
  40. tm-monitor host1:26657,host2:26657
  41. Flags:
  42. -listen-addr string
  43. HTTP and Websocket server listen address (default "tcp://0.0.0.0:26670")
  44. -no-ton
  45. Do not show ton (table of nodes)
  46. ```
  47. ### RPC UI
  48. Run `tm-monitor` and visit http://localhost:26670 You should see the
  49. list of the available RPC endpoints:
  50. ```
  51. http://localhost:26670/status
  52. http://localhost:26670/status/network
  53. http://localhost:26670/monitor?endpoint=_
  54. http://localhost:26670/status/node?name=_
  55. http://localhost:26670/unmonitor?endpoint=_
  56. ```
  57. The API is available as GET requests with URI encoded parameters, or as
  58. JSONRPC POST requests. The JSONRPC methods are also exposed over
  59. websocket.
  60. ## Development
  61. ```
  62. make get_tools
  63. make get_vendor_deps
  64. make test
  65. ```