summaryrefslogtreecommitdiffstats
path: root/docs/source/telemetry.md
diff options
context:
space:
mode:
authorOlivier Roques <oroques+fdio@cisco.com>2020-02-25 18:00:42 +0100
committerOlivier Roques <oroques+fdio@cisco.com>2020-02-25 19:00:34 +0100
commita2c5df5ce653ba6362931cb7eda0fb53b002f8ac (patch)
treed71176391a1654c17bb6836e94f23c2944368b35 /docs/source/telemetry.md
parent0e7669445b6be1163189521eabed7dd0124043c8 (diff)
[HICN-533] Update and format documentation
This patch fixes misspells, improves readability and tries to make the different source files consistent between each other. It also updates hiperf usage and hicn + VPP installation (in utils.md) and fixes some mistakes related to collectd plugins (in telemetry.md). Change-Id: I100a1c7e40dbe9c485ae4548ffc653765f4421b9 Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
Diffstat (limited to 'docs/source/telemetry.md')
-rw-r--r--docs/source/telemetry.md52
1 files changed, 26 insertions, 26 deletions
diff --git a/docs/source/telemetry.md b/docs/source/telemetry.md
index 868958f2b..4296f1c12 100644
--- a/docs/source/telemetry.md
+++ b/docs/source/telemetry.md
@@ -2,29 +2,27 @@
Tools to collect telemetry from hICN forwarders.
-## Introduction ##
+## Introduction
-The project containes two plugins for [collectd](https://github.com/collectd/collectd):
+The project contains two plugins for [collectd](https://github.com/collectd/collectd):
* vpp: to collect statistics for VPP
* vpp-hicn: to collect statistics for [hICN](https://github.com/FDio/hicn)
+Currently the two plugins provide the following functionalities:
+* vpp: statistics (rx/tx bytes and packets) for each available interface.
+* vpp-hicn: statistics (rx/tx bytes and packets) for each available face.
-Currently the two plugins provide the followign funtionalities:
+## Quick start
-* VPP: statistics (rx/tx bytes and packets) for each available interface.
-* HICN-VPP: statistics (rx/tx bytes and packets) for each available face.
+From the code tree root:
-## Quick Start ##
-
-```
-From the code tree root
-
-$ cd telemetry
-$ mkdir -p build
-$ cd build
-$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
-$ make
-$ sudo make install
+```bash
+cd telemetry
+mkdir -p build
+cd build
+cmake .. -DCMAKE_INSTALL_PREFIX=/usr
+make
+sudo make install
```
## Using hICN collectd plugins
@@ -39,7 +37,6 @@ hICN collectd plugins have been tested in:
- Red Hat Enterprise Linux 7
- CentOS 7
-
### Dependencies
Build dependencies:
@@ -54,16 +51,19 @@ Build dependencies:
## Getting started
Collectd needs to be configured in order to use the hICN collectd plugins.
-The configuration can be achieved editing the file '/etc/collectd/collectd.conf' and adding the following lines:
-
+The configuration can be achieved editing the file '/etc/collectd/collectd.conf'
+and adding the following lines:
```
LoadPlugin vpp
LoadPlugin vpp_hicn
```
-Before running collectd, a vpp forwarder must be started. If the vpp-hicn plugin is used, the hicn-plugin must be available in the vpp forwarder
+Before running collectd, a vpp forwarder must be started. If the vpp-hicn plugin
+is used, the hicn-plugin must be available in the vpp forwarder.
+
+### Example: storing statistics from vpp and vpp-hicn
-### Example: use rrdtool and csv plugin to store statistics from vpp and vpp-hicn plugins
+We'll use the rrdtool and csv plugins to store statistics from vpp and vpp-hicn.
Edit the configuration file as the following:
@@ -73,7 +73,7 @@ Edit the configuration file as the following:
######################################################################
FQDNLookup true
BaseDir "/collectd"
-Interval 2
+Interval 1
######################################################################
# Logging #
@@ -104,13 +104,13 @@ LoadPlugin vpp_hicn
</Plugin>
<Plugin rrdtool>
- DataDir "/collectd/rrd" # the folder under which statistics are written in csv
+ DataDir "/collectd/rrd" # the folder under which statistics are written in rrd
</Plugin>
```
-Run vpp and collectd
+Run vpp and collectd:
```
-$ systemctl start vpp
-$ systemctl start collectd
+systemctl start vpp
+systemctl start collectd
```