diff options
| author |   Olivier Roques <oroques+fdio@cisco.com> | 2020-03-17 18:08:58 +0100 |
|---|---|---|
| committer | Olivier Roques <oroques+fdio@cisco.com> | 2020-03-18 10:49:41 +0100 |
| commit | cea861e99637525358c1908485304d78282816be (patch) | |
| tree | e5e6ac0a12c47138159725a8d7988af5496efedc /docs | |
| parent | b60a9ca0fc0703e876412035101de4f70942eef0 (diff) | |
[HICN-562] Add new options to VPP collectd plugins
Add two options to the vpp and vpp-hicn plugins:
* Verbose, to enable additional statistics
* Tag, to tag the data with a given string
Change-Id: Ifee6c979654f87a13787095dddab0076b218e334
Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/telemetry.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/source/telemetry.md b/docs/source/telemetry.md index 041c032b4..8887b8f1f 100644 --- a/docs/source/telemetry.md +++ b/docs/source/telemetry.md @@ -66,6 +66,11 @@ If you need the custom types that the two plugins define, they are present in 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. @@ -113,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: |