docs(inputs.intel_powerstat): Add notes about hw/sw dependencies (#14263)
This commit is contained in:
parent
7d79111135
commit
06959a1c78
|
|
@ -3,6 +3,9 @@
|
||||||
This input plugin monitors power statistics on Intel-based platforms and
|
This input plugin monitors power statistics on Intel-based platforms and
|
||||||
assumes presence of Linux based OS.
|
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
|
Main use cases are power saving and workload migration. Telemetry frameworks
|
||||||
allow users to monitor critical platform level metrics. Key source of platform
|
allow users to monitor critical platform level metrics. Key source of platform
|
||||||
telemetry is power domain that is beneficial for MANO Monitoring&Analytics
|
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
|
```toml @sample.conf
|
||||||
# Intel PowerStat plugin enables monitoring of platform metrics (power, TDP)
|
# 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
|
# This plugin ONLY supports Linux
|
||||||
[[inputs.intel_powerstat]]
|
[[inputs.intel_powerstat]]
|
||||||
## The user can choose which package metrics are monitored by the plugin with
|
## 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 |
|
| 0xAC | Intel MeteorLake |
|
||||||
| 0xAA | Intel MeteorLake-L |
|
| 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
|
## Metrics
|
||||||
|
|
||||||
All metrics collected by Intel PowerStat plugin are collected in fixed
|
All metrics collected by Intel PowerStat plugin are collected in fixed
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
# Intel PowerStat plugin enables monitoring of platform metrics (power, TDP)
|
# 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
|
# This plugin ONLY supports Linux
|
||||||
[[inputs.intel_powerstat]]
|
[[inputs.intel_powerstat]]
|
||||||
## The user can choose which package metrics are monitored by the plugin with
|
## The user can choose which package metrics are monitored by the plugin with
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue