Files
xrpl-dev-portal/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md
2020-03-24 10:44:37 -04:00

1.5 KiB

Configure StatsD

The client implementation of StatsD within rippled can be enabled to export health and behavioral information about the server. Those metrics can be consumed and visualized through rippledmon or any other collector that accepts StatsD formatted metrics.

Configuration Steps

To enable StatsD on your rippled server, perform the following steps:

  1. Configure rippledmon on a separate machine. For more information about configuring rippledmon see the rippledmon repository.

  2. Add the [insight] stanaza to your rippled's config file. The stanza should contain the address that you would like to send StatsD metrics to followed by the port number that rippledmon is listneing on.

     [insight]
     server=statsd
     address=192.0.2.0:8125
     prefix=my_rippled
    
  3. Restart the rippled service.

     $ sudo systemctl restart rippled
    

For a quick way to check if metrics are being exported, try the following command:

    $ tcpdump -i en0 | grep UDP

Replace en0 with the appropriate network interface for your machine.

Sample Output:

    00:41:53.066333 IP 10.0.0.203.63409 > 192.0.2.0.8125: UDP, length 196

If you periodically see the 8125 port suffix on the destination address, you can be confident that your server is properly exporting StatsD metrics.

For descriptions of each StatsD metric see the rippledmon repository