aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2018-02-10 10:00:07 +0000
committerMaryam Tahhan <maryam.tahhan@intel.com>2018-02-10 10:08:48 +0000
commit441dc55df6e051b145b04be756317085413149b3 (patch)
treeb51622019ab906c9003e679ce6c798c70725aeb8
parent7be7d9aea103e9bd1073bbb1e8fd7583e5c598c4 (diff)
docs: update PMU documentation
Change-Id: Ib6256df8a7911aa43d86026d6c40d99ba98c971a Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
-rw-r--r--docs/release/userguide/feature.userguide.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
index 21b29dc..acef423 100644
--- a/docs/release/userguide/feature.userguide.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -376,6 +376,18 @@ Building and installing *jevents* library:
$ make
$ sudo make install
+Download the Hardware Events that are relevant to your CPU, download the appropriate
+CPU event list json file:
+
+.. code:: bash
+
+ $ wget https://raw.githubusercontent.com/andikleen/pmu-tools/master/event_download.py
+ $ python event_download.py
+
+This will download the json files to the location: $HOME/.cache/pmu-events/. If you don't want to
+download these files to the aforementioned location, set the environment variable XDG_CACHE_HOME to
+the location you want the files downloaded to.
+
Building and installing collectd:
.. code:: bash
@@ -403,6 +415,23 @@ include:
ReportSoftwareEvents true
</Plugin>
+If you want to monitor Intel CPU specific CPU events, make sure to enable the
+additional two options shown below:
+
+.. code:: bash
+
+ <Plugin intel_pmu>
+ ReportHardwareCacheEvents true
+ ReportKernelPMUEvents true
+ ReportSoftwareEvents true
+ EventList "$HOME/.cache/pmu-events/GenuineIntel-6-2D-core.json"
+ HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
+ </Plugin>
+
+.. note::
+ If you set XDG_CACHE_HOME to anything other than the variable above - you will need to modify
+ the path for the EventList configuration.
+
For more information on the plugin parameters, please see:
https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod