From 4590ae6202d7f3fbf932a57e4d9500ce5ac1e473 Mon Sep 17 00:00:00 2001
From: Alberto Compagno <acompagn+fdio@cisco.com>
Date: Tue, 11 Feb 2020 08:54:33 +0100
Subject: [HICN-510] Adding collectd plugins to get telemetry from vpp and
 hicn-plugin

Change-Id: Idb322dc712b52301c66c5256ad8d1a6a65b503b9
Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
---
 docs/source/index.rst    |   3 +-
 docs/source/telemetry.md | 116 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 118 insertions(+), 1 deletion(-)
 create mode 100644 docs/source/telemetry.md

(limited to 'docs')

diff --git a/docs/source/index.rst b/docs/source/index.rst
index af8818388..17aeb3a1c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -2,7 +2,7 @@ Hybrid Information-Centric Networking
 =====================================
 
 .. toctree::
-   
+
    started
    lib
    vpp-plugin
@@ -10,6 +10,7 @@ Hybrid Information-Centric Networking
    hicn-light
    interface
    control
+   telemetry
    utils
    apps
 
diff --git a/docs/source/telemetry.md b/docs/source/telemetry.md
new file mode 100644
index 000000000..0af3b0e02
--- /dev/null
+++ b/docs/source/telemetry.md
@@ -0,0 +1,116 @@
+# Telemetry
+
+Tools to collect telemetry from hICN forwarders.
+
+## Introduction ##
+
+The project containes 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 followign funtionalities:
+
+* VPP: statistics (rx/tx bytes and packets) for each available interface.
+* HICN-VPP: statistics (rx/tx bytes and packets) for each available face.
+
+## Quick Start ##
+
+```
+From the code tree root
+
+$ cd telemetry
+$ mkdir -p build
+$ cd build
+$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
+$ make
+$ sudo make install
+```
+
+## Using hICN collectd plugins ##
+
+### Platforms ###
+
+hICN collectd plugins have been tested in:
+
+- Ubuntu 16.04 LTS (x86_64)
+- Ubuntu 18.04 LTS (x86_64)
+- Debian Stable/Testing
+- Red Hat Enterprise Linux 7
+- CentOS 7
+
+
+### Dependencies ###
+
+Build dependencies:
+
+- VPP 20.01
+  - DEB packages (can be found https://packagecloud.io/fdio/release/install):
+  - vpp
+  - libvppinfra-dev
+  - vpp-dev
+  - hicn-plugin-dev
+
+## 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:
+
+```
+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
+
+### Example: use rrdtool and csv plugin to store statistics from vpp and vpp-hicn plugins
+
+Edit the configuration file as the following:
+
+```
+######################################################################
+# Global                                                             #
+######################################################################
+FQDNLookup true
+BaseDir "/collectd"
+Interval 2
+
+######################################################################
+# Logging                                                            #
+######################################################################
+LoadPlugin logfile
+
+<Plugin logfile>
+  LogLevel "info"
+  File "/var/log/collectd.log"
+  Timestamp true
+  PrintSeverity true
+</Plugin>
+
+######################################################################
+# Plugins                                                            #
+######################################################################
+LoadPlugin csv
+LoadPlugin rrdtool
+LoadPlugin vpp
+LoadPlugin vpp_hicn
+
+######################################################################
+# Plugin configuration                                               #
+######################################################################
+<Plugin csv>
+  DataDir "/collectd/csv" # the folder under which statistics are written in csv
+  StoreRates true
+</Plugin>
+
+<Plugin rrdtool>
+  DataDir "/collectd/rrd" # the folder under which statistics are written in csv
+</Plugin>
+```
+
+Run vpp and collectd
+
+```
+$ systemctl start vpp
+$ systemctl start collectd
+```
-- 
cgit 1.2.3-korg