1. Home
  2. bloXroute Documentation
  3. Gateway Installation
  4. Gateway Monitoring

Gateway Monitoring

The easiest way to monitor the status of a local Gateway and make sure it is working as expected is by examining the Gateway status log file. If you are executing the bloXroute Gateway from a Docker container, you will need to volume mount the status log to the host machine. The Gateway status log can also be viewed from the bloXroute-cli.
 
For pip install, the Gateway status log is located at /bloxroute/gateway_status.log.For Docker container, the file can be found inside the container under /home/bxgateway/bloxroute/gateway_status.log
 
The Gateway status file contains important information that can be used to verify status and troubleshooting. The most important section is the Summary section. The Summary section contains current information about connections and accounts.

Sections Description
gateway_status Status of the Gateway, online or offline
account_info Type of account associated, if any, with the Gateway, and whether it is using the limited free daily quota
block_relay_connection_state Status of the connection to the Block Relay: established or closed
transaction_relay_connection_state Status of the connection to the Transaction Relay: established or closed
blockchain_node_connection_state Status of the connection to the blockchain node: established or closed
remote_blockchain_node_connection_state Status of the connection to the remote blockchain node: established or closed
ip_address Ip address of the Gateway, as resolved by the self resolving mechanism or specified by the –external-ip parameter
continent Continent in which the ip geolocation system places the ip address
country Country in which the ip geolocation system places the ip address
update_required Whether or not there is a newer version of the Gateway available for download and installation
quota_level Percentage of the transaction quota already consumed

Check additional information by using bloxroute-cli
 

gateway_status: get status of the gateway

 
pip Install
$ bloxroute-cli gateway_status
 
Docker
$ docker exec -it bxgateway bloxroute-cli gateway_status
# replace “bxgateway” with the actual Gateway container name

Result

{
"gateway_status": "Online",
"account_info": "This gateway is not registered to any account and is limited to the daily free quota",
"block_relay_connection_state": "Established",
"transaction_relay_connection_state": "Established",
"blockchain_node_connection_state": "Established",
"remote_blockchain_node_connection_state": "Established",
"ip_address": "XXX.XXX.XXX.XXX",
"continent": "AS",
"country": "China",
"update_required": false
"Quota_level": null
}

bdn_performance: get percentage of blocks/transactions first received from BDN

 
pip Install
$ bloxroute-cli bdn_performance
 
Docker
$ docker exec -it bxgateway bloxroute-cli bdn_performance
# replace "bxgateway" with the actual gateway container name

 
Result


{
    "interval_start_time": "2020-09-01 22:10:52.063009",
    "interval_end_time": "2020-09-01 22:25:52.096951",
    "blocks_from_bdn_percentage": "90.72%",
    "transactions_from_bdn_percentage": "79.13%"
}

 
See bloXroute-cli page for additional commands.