From 69fba6677df52a6f357935060732f404200a80c2 Mon Sep 17 00:00:00 2001 From: Kamil Wiatrowski Date: Wed, 30 May 2018 00:42:08 +0100 Subject: docs: update userguide with new option for intel_pmu plugin Update the userguide for intel_pmu with new "Cores" option available in plugin configuration. Added sample config with default configuration. Change-Id: Ibe4d451131dc2c9ae0282f018c7e23596f4bf2c1 Signed-off-by: Kamil Wiatrowski --- docs/release/userguide/feature.userguide.rst | 10 ++++++++++ src/collectd/collectd_sample_configs/intel_pmu.conf | 1 + 2 files changed, 11 insertions(+) diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index 55a248b9..eeec7a2e 100644 --- a/docs/release/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -413,6 +413,7 @@ include: ReportHardwareCacheEvents true ReportKernelPMUEvents true ReportSoftwareEvents true + Cores "" If you want to monitor Intel CPU specific CPU events, make sure to enable the @@ -426,12 +427,21 @@ additional two options shown below: 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" + Cores "" .. 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. +Use "Cores" option to monitor metrics only for configured cores. If an empty string is provided +as value for this field default cores configuration is applied - that is all available cores +are monitored separately. To limit monitoring to cores 0-7 set the option as shown below: + +.. code:: bash + + Cores "[0-7]" + For more information on the plugin parameters, please see: https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod diff --git a/src/collectd/collectd_sample_configs/intel_pmu.conf b/src/collectd/collectd_sample_configs/intel_pmu.conf index db83e4bb..959fb8a1 100644 --- a/src/collectd/collectd_sample_configs/intel_pmu.conf +++ b/src/collectd/collectd_sample_configs/intel_pmu.conf @@ -19,4 +19,5 @@ LoadPlugin intel_pmu ReportSoftwareEvents true # EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json" # HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD" + Cores "[0-4]" -- cgit 1.2.3-korg