diff options
Diffstat (limited to 'docs/source/telemetry.md')
| -rw-r--r-- | docs/source/telemetry.md | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/docs/source/telemetry.md b/docs/source/telemetry.md index 84800c8b2..8887b8f1f 100644 --- a/docs/source/telemetry.md +++ b/docs/source/telemetry.md @@ -61,19 +61,31 @@ 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/)). + +## Plugin options +`vpp` and `vpp-hicn` have the same two options: +- `Verbose` enables additional statistics. You can check the sources to have an exact list of available metrics. +- `Tag` tags the data with the given string. Useful for identifying the context in which the data was retrieved in InfluxDB for instance. If the tag value is `None`, no tag is applied. + ### 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 # @@ -106,6 +118,16 @@ LoadPlugin vpp_hicn <Plugin rrdtool> DataDir "/var/lib/collectd/rrd" # the folder where statistics are stored in rrd </Plugin> + +<Plugin vpp> + Verbose true + Tag "None" +</Plugin> + +<Plugin vpp_hicn> + Verbose true + Tag "None" +</Plugin> ``` Run vpp and collectd: |