ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-17 10:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
dfd4d78e28a372c768634fc3b8c927ab7f26be0e
xrpl-dev-portal/docs/infrastructure/configuration/configure-statsd.md
mDuo13 7645140477 Re-levelization: move non-docs content, rename content→docs 
For better URLs, the content folder has been renamed 'docs' and all
other files have been moved up a level. Also, non-docs images have been
moved to the static folder at the top level where they belong.

Many relative paths had to be fixed to make this work.
2024-01-31 17:53:52 -08:00

2.8 KiB
Raw Blame History

html, parent, seo, labels
html parent seo labels
configure-statsd.html configure-rippled.html
description
Monitor your rippled server with StatsD metrics.
Core Server

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:

  1. 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 the rippledmon repository.

  2. Add the [insight] stanza to your rippled's config file.

    [insight]
server=statsd
address=192.0.2.0:8125
prefix=my_rippled
    • For the address, use the IP address and port where rippledmon is listening. By default, this port is 8125.
    • For the prefix, choose a name that identifies the rippled 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.

    {% partial file="/docs/_snippets/conf-file-location.md" /%}

  3. Restart the rippled service.

    $ sudo systemctl restart rippled

  4. 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