aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorOlivier Roques <oroques+fdio@cisco.com>2020-03-05 19:10:21 +0100
committerOlivier Roques <oroques+fdio@cisco.com>2020-03-05 20:18:58 +0100
commit0f7b6da4aeeb6ed9baffb47d72aa176556145501 (patch)
treee82d8c17792de4a4998a6d99bdb7ec00d3885a4a /docs
parent24841120071b95f1a05167898b33091576ba15b8 (diff)
[HICN-541] Add custom type database of collectd plugins
This patch adds the database containing the types that the two collectd plugins, vpp and vpp-hicn, defines. It is useful when using InfluxDB as it requires the type database for multi-value metrics (see https://docs.influxdata.com/influxdb/v1.7/supported_protocols/collectd/). Change-Id: Ia3e630b134e58e942be38cacb9b23379066c6e63 Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/telemetry.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/source/telemetry.md b/docs/source/telemetry.md
index 84800c8b2..041c032b4 100644
--- a/docs/source/telemetry.md
+++ b/docs/source/telemetry.md
@@ -61,19 +61,26 @@ 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.
+If you need the custom types that the two plugins define, they are present in
+`telemetry/custom_types.db`. It is useful if you are using InfluxDB as it requires
+the type database for multi-value metrics
+(see [CollectD protocol support in InfluxDB](https://docs.influxdata.com/influxdb/v1.7/supported_protocols/collectd/)).
+
### Example: storing statistics from vpp and vpp-hicn
We'll use the rrdtool and csv plugins to store statistics from vpp and vpp-hicn.
+Copy the configuration below in a file called `collectd.conf` and move
+it to `/etc/collectd`:
-Edit the configuration file as the following:
-
-```html
+```
######################################################################
# Global #
######################################################################
FQDNLookup true
BaseDir "/var/lib/collectd"
Interval 1
+# if you are using custom_types.db, you can specify it
+TypesDB "/usr/share/collectd/types.db" "/etc/collectd/custom_types.db"
######################################################################
# Logging #