diff --git a/plugins/inputs/intel_powerstat/README.md b/plugins/inputs/intel_powerstat/README.md index 05c15936f..76f340027 100644 --- a/plugins/inputs/intel_powerstat/README.md +++ b/plugins/inputs/intel_powerstat/README.md @@ -3,6 +3,9 @@ This input plugin monitors power statistics on Intel-based platforms and assumes presence of Linux based OS. +Not all CPUs are supported, please see the software and hardware dependencies +sections below to ensure platform support. + Main use cases are power saving and workload migration. Telemetry frameworks allow users to monitor critical platform level metrics. Key source of platform telemetry is power domain that is beneficial for MANO Monitoring&Analytics @@ -22,7 +25,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Intel PowerStat plugin enables monitoring of platform metrics (power, TDP) -# and per-CPU metrics like temperature, power and utilization. +# and per-CPU metrics like temperature, power and utilization. Please see the +# plugin readme for details on software and hardware compatability. # This plugin ONLY supports Linux [[inputs.intel_powerstat]] ## The user can choose which package metrics are monitored by the plugin with @@ -246,6 +250,21 @@ are required by the plugin: | 0xAC | Intel MeteorLake | | 0xAA | Intel MeteorLake-L | +### uncore frequency + +Note that only certain processors support the uncore frequency module as well: + +| Model number | Processor name | +|--------------|---------------------------------| +| 0x55 | Intel Skylake-X | +| 0x6A | Intel IceLake-X | +| 0x6C | Intel IceLake-D | +| 0x47 | Intel Broadwell-G | +| 0x4F | Intel Broadwell-X | +| 0x56 | Intel Broadwell-D | +| 0x8F | Intel Sapphire Rapids X | +| 0xCF | Intel Emerald Rapids X | + ## Metrics All metrics collected by Intel PowerStat plugin are collected in fixed diff --git a/plugins/inputs/intel_powerstat/sample.conf b/plugins/inputs/intel_powerstat/sample.conf index 6ffa36511..fdad448fd 100644 --- a/plugins/inputs/intel_powerstat/sample.conf +++ b/plugins/inputs/intel_powerstat/sample.conf @@ -1,5 +1,6 @@ # Intel PowerStat plugin enables monitoring of platform metrics (power, TDP) -# and per-CPU metrics like temperature, power and utilization. +# and per-CPU metrics like temperature, power and utilization. Please see the +# plugin readme for details on software and hardware compatability. # This plugin ONLY supports Linux [[inputs.intel_powerstat]] ## The user can choose which package metrics are monitored by the plugin with