intel_powerstat

README

Intel PowerStat Input Plugin

This input plugin monitors power statistics on Intel-based platforms and assumes presence of Linux based OS.

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 systems to take preventive/corrective actions based on platform busyness, CPU temperature, actual CPU utilization and power statistics.

Configuration

# Intel PowerStat plugin enables monitoring of platform metrics (power, TDP) and per-CPU metrics like temperature, power and utilization.
[[inputs.intel_powerstat]]
  ## All global metrics are always collected by Intel PowerStat plugin.
  ## User can choose which per-CPU metrics are monitored by the plugin in cpu_metrics array.
  ## Empty array means no per-CPU specific metrics will be collected by the plugin - in this case only platform level
  ## telemetry will be exposed by Intel PowerStat plugin.
  ## Supported options:
  ## "cpu_frequency", "cpu_busy_frequency", "cpu_temperature", "cpu_c1_state_residency", "cpu_c6_state_residency", "cpu_busy_cycles"
  # cpu_metrics = []

Example: Configuration with no per-CPU telemetry

This configuration allows getting global metrics (processor package specific), no per-CPU metrics are collected:

[[inputs.intel_powerstat]]
  cpu_metrics = []

Example: Configuration with no per-CPU telemetry - equivalent case

This configuration allows getting global metrics (processor package specific), no per-CPU metrics are collected:

[[inputs.intel_powerstat]]

Example: Configuration for CPU Temperature and Frequency only

This configuration allows getting global metrics plus subset of per-CPU metrics (CPU Temperature and Current Frequency):

[[inputs.intel_powerstat]]
  cpu_metrics = ["cpu_frequency", "cpu_temperature"]

Example: Configuration with all available metrics

This configuration allows getting global metrics and all per-CPU metrics:

[[inputs.intel_powerstat]]
  cpu_metrics = ["cpu_frequency", "cpu_busy_frequency", "cpu_temperature", "cpu_c1_state_residency", "cpu_c6_state_residency", "cpu_busy_cycles"]

SW Dependencies

Plugin is based on Linux Kernel modules that expose specific metrics over sysfs or devfs interfaces. The following dependencies are expected by plugin:

• intel-rapl module which exposes Intel Runtime Power Limiting metrics over sysfs (/sys/devices/virtual/powercap/intel-rapl),
• msr kernel module that provides access to processor model specific registers over devfs (/dev/cpu/cpu%d/msr),
• cpufreq kernel module - which exposes per-CPU Frequency over sysfs (/sys/devices/system/cpu/cpu%d/cpufreq/scaling_cur_freq).

Minimum kernel version required is 3.13 to satisfy all requirements.

Please make sure that kernel modules are loaded and running. You might have to manually enable them by using modprobe. Exact commands to be executed are:

sudo modprobe cpufreq-stats
sudo modprobe msr
sudo modprobe intel_rapl

Telegraf with Intel PowerStat plugin enabled may require root access to read model specific registers (MSRs) to retrieve data for calculation of most critical per-CPU specific metrics:

• cpu_busy_frequency_mhz
• cpu_temperature_celsius
• cpu_c1_state_residency_percent
• cpu_c6_state_residency_percent
• cpu_busy_cycles_percent

To expose other Intel PowerStat metrics root access may or may not be required (depending on OS type or configuration).

HW Dependencies

Specific metrics require certain processor features to be present, otherwise Intel PowerStat plugin won't be able to read them. When using Linux Kernel based OS, user can detect supported processor features reading /proc/cpuinfo file. Plugin assumes crucial properties are the same for all CPU cores in the system. The following processor properties are examined in more detail in this section: processor cpu family, model and flags. The following processor properties are required by the plugin:

• Processor cpu family must be Intel (0x6) - since data used by the plugin assumes Intel specific model specific registers for all features
• The following processor flags shall be present:
  • "msr" shall be present for plugin to read platform data from processor model specific registers and collect the following metrics: powerstat_core.cpu_temperature, powerstat_core.cpu_busy_frequency, powerstat_core.cpu_busy_cycles, powerstat_core.cpu_c1_state_residency, _powerstat_core.cpu_c6_state_residency
  • "aperfmperf" shall be present to collect the following metrics: powerstat_core.cpu_busy_frequency, powerstat_core.cpu_busy_cycles, powerstat_core.cpu_c1_state_residency
  • "dts" shall be present to collect powerstat_core.cpu_temperature
• Processor Model number must be one of the following values for plugin to read powerstat_core.cpu_c1_state_residency and powerstat_core.cpu_c6_state_residency metrics:

Model number	Processor name
0x37	Intel Atom® Bay Trail
0x4D	Intel Atom® Avaton
0x5C	Intel Atom® Apollo Lake
0x5F	Intel Atom® Denverton
0x7A	Intel Atom® Goldmont
0x4C	Intel Atom® Airmont
0x86	Intel Atom® Jacobsville
0x96	Intel Atom® Elkhart Lake
0x9C	Intel Atom® Jasper Lake
0x1A	Intel Nehalem-EP
0x1E	Intel Nehalem
0x1F	Intel Nehalem-G
0x2E	Intel Nehalem-EX
0x25	Intel Westmere
0x2C	Intel Westmere-EP
0x2F	Intel Westmere-EX
0x2A	Intel Sandybridge
0x2D	Intel Sandybridge-X
0x3A	Intel Ivybridge
0x3E	Intel Ivybridge-X
0x4E	Intel Atom® Silvermont-MID
0x5E	Intel Skylake
0x55	Intel Skylake-X
0x8E	Intel Kabylake-L
0x9E	Intel Kabylake
0x6A	Intel Icelake-X
0x6C	Intel Icelake-D
0x7D	Intel Icelake
0x7E	Intel Icelake-L
0x9D	Intel Icelake-NNPI
0x3C	Intel Haswell
0x3F	Intel Haswell-X
0x45	Intel Haswell-L
0x46	Intel Haswell-G
0x3D	Intel Broadwell
0x47	Intel Broadwell-G
0x4F	Intel Broadwell-X
0x56	Intel Broadwell-D
0x66	Intel Cannonlake-L
0x57	Intel Xeon® PHI Knights Landing
0x85	Intel Xeon® PHI Knights Mill
0xA5	Intel CometLake
0xA6	Intel CometLake-L
0x8F	Intel Sapphire Rapids X
0x8C	Intel TigerLake-L
0x8D	Intel TigerLake

Metrics

All metrics collected by Intel PowerStat plugin are collected in fixed intervals. Metrics that reports processor C-state residency or power are calculated over elapsed intervals. When starting to measure metrics, plugin skips first iteration of metrics if they are based on deltas with previous value.

The following measurements are supported by Intel PowerStat plugin:

• powerstat_core

  • The following Tags are returned by plugin with powerstat_core measurements:

        | Tag | Description |
        |-----|-------------|
        | `package_id` | ID of platform package/socket |
        | `core_id` | ID of physical processor core |
        | `cpu_id` | ID of logical processor core  |
   Measurement powerstat_core metrics are collected per-CPU (cpu_id is the key)
   while core_id and package_id tags are additional topology information.
  

  • Available metrics for powerstat_core measurement

        | Metric name (field) | Description | Units |
        |-----|-------------|-----|
        | `cpu_frequency_mhz` | Current operational frequency of CPU Core | MHz |
        | `cpu_busy_frequency_mhz` | CPU Core Busy Frequency measured as frequency adjusted to CPU Core busy cycles | MHz |
        | `cpu_temperature_celsius` | Current temperature of CPU Core | Celsius degrees |
        | `cpu_c1_state_residency_percent` | Percentage of time that CPU Core spent in C1 Core residency state | % |
        | `cpu_c6_state_residency_percent` | Percentage of time that CPU Core spent in C6 Core residency state | % |
        | `cpu_busy_cycles_percent` | CPU Core Busy cycles as a ratio of Cycles spent in C0 state residency to all cycles executed by CPU Core | % |
  

• powerstat_package

  • The following Tags are returned by plugin with powerstat_package measurements:

        | Tag | Description |
        |-----|-------------|
        | `package_id` | ID of platform package/socket |
   Measurement powerstat_package metrics are collected per processor package -_package_id_ tag indicates which
   package metric refers to.
  

  • Available metrics for powerstat_package measurement

        | Metric name (field) | Description | Units |
        |-----|-------------|-----|
        | `thermal_design_power_watts` |  Maximum Thermal Design Power (TDP) available for processor package | Watts |
        | `current_power_consumption_watts` | Current power consumption of processor package | Watts |
        | `current_dram_power_consumption_watts` | Current power consumption of processor package DRAM subsystem | Watts |
  

Example Output

powerstat_package,host=ubuntu,package_id=0 thermal_design_power_watts=160 1606494744000000000
powerstat_package,host=ubuntu,package_id=0 current_power_consumption_watts=35 1606494744000000000
powerstat_package,host=ubuntu,package_id=0 current_dram_power_consumption_watts=13.94 1606494744000000000
powerstat_core,core_id=0,cpu_id=0,host=ubuntu,package_id=0 cpu_frequency_mhz=1200.29 1606494744000000000
powerstat_core,core_id=0,cpu_id=0,host=ubuntu,package_id=0 cpu_temperature_celsius=34i 1606494744000000000
powerstat_core,core_id=0,cpu_id=0,host=ubuntu,package_id=0 cpu_c6_state_residency_percent=92.52 1606494744000000000
powerstat_core,core_id=0,cpu_id=0,host=ubuntu,package_id=0 cpu_busy_cycles_percent=0.8 1606494744000000000
powerstat_core,core_id=0,cpu_id=0,host=ubuntu,package_id=0 cpu_c1_state_residency_percent=6.68 1606494744000000000
powerstat_core,core_id=0,cpu_id=0,host=ubuntu,package_id=0 cpu_busy_frequency_mhz=1213.24 1606494744000000000

Documentation

Index

• type PowerStat
  • func (p *PowerStat) Description() string
  • func (p *PowerStat) Gather(acc telegraf.Accumulator) error
  • func (p *PowerStat) Init() error
  • func (p *PowerStat) SampleConfig() string

Types

type PowerStat

type PowerStat struct {
	CPUMetrics []string        `toml:"cpu_metrics"`
	Log        telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

PowerStat plugin enables monitoring of platform metrics (power, TDP) and Core metrics like temperature, power and utilization.

func (*PowerStat) Description

func (p *PowerStat) Description() string

Description returns a one-sentence description on the plugin.

func (*PowerStat) Gather

func (p *PowerStat) Gather(acc telegraf.Accumulator) error

Gather takes in an accumulator and adds the metrics that the Input gathers.

func (*PowerStat) Init

func (p *PowerStat) Init() error

Init performs one time setup of the plugin.

func (*PowerStat) SampleConfig

func (p *PowerStat) SampleConfig() string

SampleConfig returns the default configuration of the plugin.