Configure StatsD
rippled
can export health and behavioral information about itself in StatsD format. 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:
Set up a
rippledmon
instance on another machine to receive and aggregate stats.$ git clone https://github.com/ripple/rippledmon.git $ cd rippledmon $ docker-compose up
Make sure Docker and Docker Compose are installed on your machine when performing the steps above. For more information about configuring
rippledmon
, see therippledmon
repository.Add the
[insight]
stanza to yourrippled
's config file.[insight] server=statsd address=192.0.2.0:8125 prefix=my_rippled
- For the
address
, use the IP address and port whererippledmon
is listening. By default, this port is 8125. - For the
prefix
, choose a name that identifies therippled
server you are configuring. The prefix must not include whitespace, colons ":", or the vertical bar "|". The prefix appears on all of the StatsD metrics exported from this server.
The recommended installation uses the config file
/etc/opt/ripple/rippled.cfg
by default. Other places you can put a config file include$HOME/.config/ripple/rippled.cfg
(where$HOME
is the home directory of the user runningrippled
),$HOME/.local/ripple/rippled.cfg
, or the current working directory from where you startrippled
.- For the
Restart the
rippled
service.$ sudo systemctl restart rippled
Check that the metrics are being exported:
$ tcpdump -i en0 | grep UDP
Replace
en0
with the appropriate network interface for your machine. For a complete list of the interfaces on your machine use$ tcpdump -D
.Sample Output:
00:41:53.066333 IP 192.0.2.2.63409 > 192.0.2.0.8125: UDP, length 196
You should periodically see messages indicating outbound traffic to the configured address and port of your
rippledmon
instance.
For descriptions of each StatsD metric, see the rippledmon
repository.
See Also
- Concepts:
- Tutorials:
- References: