Metrics
To conveniently and thoroughly monitor the performance of your instance of the Iroha network, we recommend using Prometheus. Prometheus is a program that can monitor your Iroha peer over a separate socket and provide different kinds of performance metrics.
This data can help you find performance bottlenecks and optimise your Iroha configuration.
/metrics Endpoint
See Reference > Torii Endpoints: Metrics.
How to use metrics
To collect metrics via the /metrics endpoint, the following must first be configured:
In the
configs/peer/config.jsonconfiguration file:"TORII":"TELEMETRY_URL"variable;"TELEMETRY"object in its entirety.\
For details, see Peer Configuration.
In the
configs/client/config.jsonconfiguration file:"TORII_TELEMETRY_URL"variable.
Set tohttp://127.0.0.1:8180/, by default. If the port is not available, Iroha will still function properly, but the metrics won't be provided.
For details, see Client Configuration
::: note
For examples, see Sample Configuration Files.
:::
After the above is configured, you can use the IP address set in the "TORII_TELEMETRY_URL" variable to access the metrics data from within a running Iroha instance.
Example:
$ curl http://127.0.0.1:8180/metrics$ curl http://127.0.0.1:8180/metricsThis returns a result similar to the following:
# HELP blocks_height Total number of blocks in chain
# TYPE blocks_height gauge
blocks_height 135543
# HELP peers_number Total number peers to send transactions and request proposals
# TYPE peers_number gauge
peers_number 7
# HELP number_of_domains Total number of domains in WSV
# TYPE number_of_domains gauge
number_of_domains 14
# HELP total_number_of_transactions Total number of transactions in blockchain
# TYPE total_number_of_transactions gauge
total_number_of_transactions 216499
# HELP number_of_signatures_in_last_block Number of signatures in last block
# TYPE number_of_signatures_in_last_block gauge
number_of_signatures_in_last_block 5# HELP blocks_height Total number of blocks in chain
# TYPE blocks_height gauge
blocks_height 135543
# HELP peers_number Total number peers to send transactions and request proposals
# TYPE peers_number gauge
peers_number 7
# HELP number_of_domains Total number of domains in WSV
# TYPE number_of_domains gauge
number_of_domains 14
# HELP total_number_of_transactions Total number of transactions in blockchain
# TYPE total_number_of_transactions gauge
total_number_of_transactions 216499
# HELP number_of_signatures_in_last_block Number of signatures in last block
# TYPE number_of_signatures_in_last_block gauge
number_of_signatures_in_last_block 5