// Copyright 2019 The Prometheus Authors // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //go:build !nocpu // +build !nocpu package collector import ( "fmt" "github.com/go-kit/log" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/procfs/sysfs" ) type cpuFreqCollector struct { fs sysfs.FS cpuFreq *prometheus.Desc cpuFreqMin *prometheus.Desc cpuFreqMax *prometheus.Desc scalingFreq *prometheus.Desc scalingFreqMin *prometheus.Desc scalingFreqMax *prometheus.Desc logger log.Logger } func init() { registerCollector("cpufreq", defaultEnabled, NewCPUFreqCollector) } // NewCPUFreqCollector returns a new Collector exposing kernel/system statistics. func NewCPUFreqCollector(logger log.Logger) (Collector, error) { fs, err := sysfs.NewFS(*sysPath) if err != nil { return nil, fmt.Errorf("failed to open sysfs: %w", err) } return &cpuFreqCollector{ fs: fs, cpuFreq: prometheus.NewDesc( prometheus.BuildFQName(namespace, cpuCollectorSubsystem, "frequency_hertz"), "Current cpu thread frequency in hertz.", []string{"cpu"}, nil, ), cpuFreqMin: prometheus.NewDesc( prometheus.BuildFQName(namespace, cpuCollectorSubsystem, "frequency_min_hertz"), "Minimum cpu thread frequency in hertz.", []string{"cpu"}, nil, ), cpuFreqMax: prometheus.NewDesc( prometheus.BuildFQName(namespace, cpuCollectorSubsystem, "frequency_max_hertz"), "Maximum cpu thread frequency in hertz.", []string{"cpu"}, nil, ), scalingFreq: prometheus.NewDesc( prometheus.BuildFQName(namespace, cpuCollectorSubsystem, "scaling_frequency_hertz"), "Current scaled CPU thread frequency in hertz.", []string{"cpu"}, nil, ), scalingFreqMin: prometheus.NewDesc( prometheus.BuildFQName(namespace, cpuCollectorSubsystem, "scaling_frequency_min_hertz"), "Minimum scaled CPU thread frequency in hertz.", []string{"cpu"}, nil, ), scalingFreqMax: prometheus.NewDesc( prometheus.BuildFQName(namespace, cpuCollectorSubsystem, "scaling_frequency_max_hertz"), "Maximum scaled CPU thread frequency in hertz.", []string{"cpu"}, nil, ), logger: logger, }, nil } // Update implements Collector and exposes cpu related metrics from /proc/stat and /sys/.../cpu/. func (c *cpuFreqCollector) Update(ch chan<- prometheus.Metric) error { cpuFreqs, err := c.fs.SystemCpufreq() if err != nil { return err } // sysfs cpufreq values are kHz, thus multiply by 1000 to export base units (hz). // See https://www.kernel.org/doc/Documentation/cpu-freq/user-guide.txt for _, stats := range cpuFreqs { if stats.CpuinfoCurrentFrequency != nil { ch <- prometheus.MustNewConstMetric( c.cpuFreq, prometheus.GaugeValue, float64(*stats.CpuinfoCurrentFrequency)*1000.0, stats.Name, ) } if stats.CpuinfoMinimumFrequency != nil { ch <- prometheus.MustNewConstMetric( c.cpuFreqMin, prometheus.GaugeValue, float64(*stats.CpuinfoMinimumFrequency)*1000.0, stats.Name, ) } if stats.CpuinfoMaximumFrequency != nil { ch <- prometheus.MustNewConstMetric( c.cpuFreqMax, prometheus.GaugeValue, float64(*stats.CpuinfoMaximumFrequency)*1000.0, stats.Name, ) } if stats.ScalingCurrentFrequency != nil { ch <- prometheus.MustNewConstMetric( c.scalingFreq, prometheus.GaugeValue, float64(*stats.ScalingCurrentFrequency)*1000.0, stats.Name, ) } if stats.ScalingMinimumFrequency != nil { ch <- prometheus.MustNewConstMetric( c.scalingFreqMin, prometheus.GaugeValue, float64(*stats.ScalingMinimumFrequency)*1000.0, stats.Name, ) } if stats.ScalingMaximumFrequency != nil { ch <- prometheus.MustNewConstMetric( c.scalingFreqMax, prometheus.GaugeValue, float64(*stats.ScalingMaximumFrequency)*1000.0, stats.Name, ) } } return nil }