aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSridhar K. N. Rao <sridhar.rao@spirent.com>2019-03-20 17:37:40 +0530
committerSridhar K. N. Rao <sridhar.rao@spirent.com>2019-03-29 09:22:26 +0530
commit3f822e804d0f5037e76d6cfb57b7098e7179f0e9 (patch)
tree7f2bce9c9418dc51e4a66ce504452187f8481536 /docs
parente255889356b90ea74f7f2fa4e8b88b461682d995 (diff)
Collector: Add Multi-command collector.
This patch adds support to run following commands as 'collector' 1. collectd 2. PROX IRQ Latency 3. CROND (currently to collect ovs-port's CPU-mapping information) 4. Filebeat (send logs to elasticsearch) Fixed pylint issues Added description to control prox-runrapid. The use of 'stop' file. Added a print in print_results. JIRA: VSPERF-599 Change-Id: I583325ef14ddb0b292e8abddef1518d24b5e52d8 Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/testing/user/configguide/tools.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/testing/user/configguide/tools.rst b/docs/testing/user/configguide/tools.rst
index 907e86d2..fbc0c71a 100644
--- a/docs/testing/user/configguide/tools.rst
+++ b/docs/testing/user/configguide/tools.rst
@@ -53,6 +53,9 @@ VSPERF assumes that collectd is installed and configured to send metrics over lo
The metrics sent should be for the following categories: CPU, Processes, Interface,
OVS, DPDK, Intel-RDT.
+For multicmd, apart from collectd, installation of PROX is also necessary.
+Installation steps for PROX can be found here - `DPPD-PROX <https://github.com/opnfv/samplevnf/tree/master/VNFs/DPPD-PROX>`_
+
Configuration
^^^^^^^^^^^^^
@@ -79,6 +82,13 @@ The *collectd* configuration option includes:
* ``COLLECTD_INTELRDT_KEYS`` - Interesting metrics from Intel-RDT
* ``COLLECTD_INTERFACE_XKEYS`` - Metrics to exclude from Interface
* ``COLLECTD_INTELRDT_XKEYS`` - Metrics to exclude from Intel-RDT
+* ``MC_COLLECTD_CSV`` - Path where collectd writes its metrics as CSV.
+* ``MC_COLLECTD_CMD`` - Path where Collectd is installed
+* ``MC_PROX_HOME`` - Path where PROX-IRQ is installed.
+* ``MC_PROX_CMD`` - Command to run PROX-IRQ
+* ``MC_PROX_OUT`` - Output file generated by PROX-IRQ stats collector.
+* ``MC_CRON_OUT`` - Output file path of the command run through CROND
+* ``MC_BEAT_CFILE`` - Filebeat configuration file path.
.. _`Load Generators`: