Node Inspection Service

Aptos nodes collect metrics and system information while running. These metrics provide a way to track, monitor and inspect the health and performance of the node dynamically, at runtime. Node metrics and system information can be queried or exported via an inspection service that runs on each node. To see the list of important metrics and counters, see the Important Node Metrics document.

If you’d like to examine all the endpoints provided by the inspection service, visit the following URL once you have started your node:

http://localhost:9101/

This will display a directory of all the endpoints and features offered by the service, for example:

Welcome to the Aptos Inspection Service!
The following endpoints are available:
  - /configuration
  - /consensus_health_check
  - /forge_metrics
  - /identity_information
  - /json_metrics
  - /metrics
  - /peer_information
  - /system_information

If you’d like to examine the metrics of your node at runtime, visit the following URL:

http://localhost:9101/metrics

This will display the values of all the metrics and counters of your node at the time you queried it. To see updates to these values, simply refresh the page.

Likewise, if you wish to view the metrics in json format, visit the following URL:

http://localhost:9101/json_metrics

You can configure various aspects of the node inspection service, for example, you can change the port it listens on, enable or disable certain endpoints, and more. The inspection service is enabled by default, so you do not need to do anything special once you start your node.

The inspection service should run by default at port 9101. To change the port the inspection service listens on (e.g., to 1000), add the following to your node configuration file:

inspection_service:
  port: 1000

The inspection service also provides a way to examine the configuration file of your node at runtime (i.e., the node configuration file that your node started with).

To enable this feature, add the following to your node configuration file:

inspection_service:
  expose_configuration: true

And visit the configuration URL:

http://localhost:9101/configuration

Likewise, the inspection service also provides a way to examine the system information of your node at runtime (i.e., build and hardware information). Simply visit the following URL:

http://localhost:9101/system_information

If you’d like to disable this endpoint, add the following to your node configuration file:

inspection_service:
  expose_system_information: false

The inspection service also provides an easy way to examine the identity of your node (i.e., the peer ID for each network) at runtime. Simply visit the following URL:

http://localhost:9101/identity_information

If you’d like to disable this endpoint, add the following to your node configuration file:

inspection_service:
  expose_identity_information: false