From 6ae440f6caec62f189c8eba13ed75bbc1cf5ba40 Mon Sep 17 00:00:00 2001 From: mbhandary Date: Tue, 24 Mar 2020 10:44:37 -0400 Subject: [PATCH 1/5] Instructions on how to enable StatsD --- .../configuration/configure-statsd.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md new file mode 100644 index 0000000000..0018eea3bc --- /dev/null +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md @@ -0,0 +1,46 @@ +# Configure StatsD + + The client implementation of [StatsD](https://github.com/statsd/statsd) within rippled can be enabled to export health and behavioral information about the server. Those metrics can be consumed and visualized through [`rippledmon`](https://github.com/ripple/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](https://github.com/ripple/rippledmon). + + +0. 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 + + +0. 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](https://github.com/ripple/rippledmon) + + + + + + + + + From 33284395dcff2e26d85bbafca5f18a927806169a Mon Sep 17 00:00:00 2001 From: mbhandary Date: Tue, 24 Mar 2020 11:14:43 -0400 Subject: [PATCH 2/5] updated dactyl-config and included see also --- .../configuration/configure-statsd.md | 14 +++++++++++++- dactyl-config.yml | 10 ++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md index 0018eea3bc..d0b89631cf 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md @@ -38,7 +38,19 @@ For descriptions of each StatsD metric see the `rippledmon` [repository](https:/ - +## See Also + +- **Concepts:** + - [XRP Ledger Overview](xrp-ledger-overview.html) + - [Consensus Network](consensus-network.html) + - [The `rippled` Server](the-rippled-server.html) +- **Tutorials:** + - [Install `rippled`](install-rippled.html) + - [Capacity Planning](capacity-planning.html) + +- **References:** + - [server_info method](server_info.html) + - [print method](print.html) diff --git a/dactyl-config.yml b/dactyl-config.yml index a21caa8caf..7f0a37945b 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2385,6 +2385,16 @@ pages: targets: - en + - md: tutorials/manage-the-rippled-server/configuration/configure-statsd.md + html: configure-statsd.html + funnel: Docs + doc_type: Tutorials + category: Manage the rippled Server + subcategory: Configuration + blurb: Monitor your rippled server with StatsD metrics. #TODO:translate + targets: + - en + - md: tutorials/manage-the-rippled-server/configuration/run-rippled-as-a-validator.ja.md html: run-rippled-as-a-validator.html funnel: Docs From 57f9b02b48303a7f1cd0b0b07b0f3051b159f84b Mon Sep 17 00:00:00 2001 From: mbhandary Date: Tue, 24 Mar 2020 11:35:23 -0400 Subject: [PATCH 3/5] Fixed heading --- .../configuration/configure-statsd.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md index d0b89631cf..167f5d5b96 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md @@ -1,9 +1,8 @@ # Configure StatsD - The client implementation of [StatsD](https://github.com/statsd/statsd) within rippled can be enabled to export health and behavioral information about the server. Those metrics can be consumed and visualized through [`rippledmon`](https://github.com/ripple/rippledmon) or any other collector that accepts StatsD formatted metrics. + The client implementation of [StatsD](https://github.com/statsd/statsd) within rippled can be enabled to export health and behavioral information about the server. Those metrics can be consumed and visualized through [`rippledmon`](https://github.com/ripple/rippledmon) or any other collector that accepts StatsD formatted metrics. - - ## Configuration Steps +## Configuration Steps To enable StatsD on your rippled server, perform the following steps: @@ -30,7 +29,7 @@ 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 + 00:41:53.066333 IP 192.0.2.2.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. From fa8dea9b59068145587e44d107c30a48be5cd3ab Mon Sep 17 00:00:00 2001 From: mbhandary Date: Wed, 25 Mar 2020 17:26:17 -0400 Subject: [PATCH 4/5] Fixed typos, changed code fonts, added prefix description, reworded --- .../configuration/configure-statsd.md | 19 ++++++++++++------- dactyl-config.yml | 1 + 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md index 167f5d5b96..28f343d278 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md @@ -1,15 +1,20 @@ # Configure StatsD - The client implementation of [StatsD](https://github.com/statsd/statsd) within rippled can be enabled to export health and behavioral information about the server. Those metrics can be consumed and visualized through [`rippledmon`](https://github.com/ripple/rippledmon) or any other collector that accepts StatsD formatted metrics. + `rippled` can export health and behavioral information about itself in [StatsD](https://github.com/statsd/statsd) format. Those metrics can be consumed and visualized through [`rippledmon`](https://github.com/ripple/rippledmon) or any other collector that accepts StatsD formatted metrics. ## Configuration Steps - To enable StatsD on your rippled server, perform the following 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](https://github.com/ripple/rippledmon). +1. Set up a `rippledmon` instance on another machine to receive and aggregate stats. For more information about configuring `rippledmon`, see the [`rippledmon` repository](https://github.com/ripple/rippledmon). + $ git clone https://github.com/rippled/rippledmon.git + $ cd rippledmon + $ docker-compose up -0. 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. + Make sure [Docker](https://docs.docker.com/) and [Docker Compose](https://docs.docker.com/compose/install/) are installed on your machine when performing the steps above. + +0. Add the `[insight]` stanza to your `rippled`'s config file. 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 will appear on all of the StatsD metrics exported from this server. With the configuration below, metrics would appear as `my_rippled.metric_name`. The prefix must not include whitespace, colons ":", or the vertical bar "|". [insight] server=statsd @@ -21,17 +26,17 @@ $ sudo systemctl restart rippled -For a quick way to check if metrics are being exported, try the following command: +0. Check that the metrics are being exported by executing the following command. $ tcpdump -i en0 | grep UDP -Replace en0 with the appropriate network interface for your machine. +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 -If you periodically see the 8125 port suffix on the destination address, you can be confident that your server is properly exporting StatsD metrics. +Assuming you are using the default destination port in your config file, you should periodically see the 8125 suffix on the destination address. For descriptions of each StatsD metric see the `rippledmon` [repository](https://github.com/ripple/rippledmon) diff --git a/dactyl-config.yml b/dactyl-config.yml index 7f0a37945b..019ad675ff 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2394,6 +2394,7 @@ pages: blurb: Monitor your rippled server with StatsD metrics. #TODO:translate targets: - en + - ja - md: tutorials/manage-the-rippled-server/configuration/run-rippled-as-a-validator.ja.md html: run-rippled-as-a-validator.html From 3f96b7257cd4205a449159c44602802257a27ac4 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Fri, 27 Mar 2020 14:04:08 -0700 Subject: [PATCH 5/5] Configure statsd: copy-edits --- .../configuration/configure-statsd.md | 30 +++++++++---------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md index 28f343d278..b44c833e63 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-statsd.md @@ -1,44 +1,48 @@ # Configure StatsD - `rippled` can export health and behavioral information about itself in [StatsD](https://github.com/statsd/statsd) format. Those metrics can be consumed and visualized through [`rippledmon`](https://github.com/ripple/rippledmon) or any other collector that accepts StatsD formatted metrics. +`rippled` can export health and behavioral information about itself in [StatsD](https://github.com/statsd/statsd) format. Those metrics can be consumed and visualized through [`rippledmon`](https://github.com/ripple/rippledmon) or any other collector that accepts StatsD formatted metrics. ## Configuration Steps - To enable StatsD on your `rippled` server, perform the following 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. For more information about configuring `rippledmon`, see the [`rippledmon` repository](https://github.com/ripple/rippledmon). +1. Set up a `rippledmon` instance on another machine to receive and aggregate stats. $ git clone https://github.com/rippled/rippledmon.git $ cd rippledmon $ docker-compose up - Make sure [Docker](https://docs.docker.com/) and [Docker Compose](https://docs.docker.com/compose/install/) are installed on your machine when performing the steps above. + Make sure [Docker](https://docs.docker.com/) and [Docker Compose](https://docs.docker.com/compose/install/) are installed on your machine when performing the steps above. For more information about configuring `rippledmon`, see the [`rippledmon` repository](https://github.com/ripple/rippledmon). -0. Add the `[insight]` stanza to your `rippled`'s config file. 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 will appear on all of the StatsD metrics exported from this server. With the configuration below, metrics would appear as `my_rippled.metric_name`. The prefix must not include whitespace, colons ":", or the vertical bar "|". +0. 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. + + {% include '_snippets/conf-file-location.md' %} 0. Restart the `rippled` service. $ sudo systemctl restart rippled -0. Check that the metrics are being exported by executing the following command. +0. 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`. + 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: + Sample Output: 00:41:53.066333 IP 192.0.2.2.63409 > 192.0.2.0.8125: UDP, length 196 -Assuming you are using the default destination port in your config file, you should periodically see the 8125 suffix on the destination address. + 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](https://github.com/ripple/rippledmon) +For descriptions of each StatsD metric, see the [`rippledmon` repository](https://github.com/ripple/rippledmon). @@ -51,12 +55,6 @@ For descriptions of each StatsD metric see the `rippledmon` [repository](https:/ - **Tutorials:** - [Install `rippled`](install-rippled.html) - [Capacity Planning](capacity-planning.html) - - **References:** - [server_info method](server_info.html) - [print method](print.html) - - - - -