github.com/evdatsion/aphelion-dpos-bft@v0.32.1/tools/tm-monitor/README.md (about)

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