1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
|
// 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 !nopowersupplyclass
// +build !nopowersupplyclass
package collector
/*
#cgo LDFLAGS: -framework IOKit -framework CoreFoundation
#include <CoreFoundation/CFNumber.h>
#include <CoreFoundation/CFRunLoop.h>
#include <CoreFoundation/CFString.h>
#include <IOKit/ps/IOPowerSources.h>
#include <IOKit/ps/IOPSKeys.h>
// values collected from IOKit Power Source APIs
// Functions documentation available at
// https://developer.apple.com/documentation/iokit/iopowersources_h
// CFDictionary keys definition
// https://developer.apple.com/documentation/iokit/iopskeys_h/defines
struct macos_powersupply {
char *Name;
char *PowerSourceState;
char *Type;
char *TransportType;
char *BatteryHealth;
char *HardwareSerialNumber;
int *PowerSourceID;
int *CurrentCapacity;
int *MaxCapacity;
int *DesignCapacity;
int *NominalCapacity;
int *TimeToEmpty;
int *TimeToFullCharge;
int *Voltage;
int *Current;
int *Temperature;
// boolean values
int *IsCharged;
int *IsCharging;
int *InternalFailure;
int *IsPresent;
};
int *CFDictionaryGetInt(CFDictionaryRef theDict, const void *key) {
CFNumberRef tmp;
int *value;
tmp = CFDictionaryGetValue(theDict, key);
if (tmp == NULL)
return NULL;
value = (int*)malloc(sizeof(int));
if (CFNumberGetValue(tmp, kCFNumberIntType, value)) {
return value;
}
free(value);
return NULL;
}
int *CFDictionaryGetBoolean(CFDictionaryRef theDict, const void *key) {
CFBooleanRef tmp;
int *value;
tmp = CFDictionaryGetValue(theDict, key);
if (tmp == NULL)
return NULL;
value = (int*)malloc(sizeof(int));
if (CFBooleanGetValue(tmp)) {
*value = 1;
} else {
*value = 0;
}
return value;
}
char *CFDictionaryGetSring(CFDictionaryRef theDict, const void *key) {
CFStringRef tmp;
CFIndex size;
char *value;
tmp = CFDictionaryGetValue(theDict, key);
if (tmp == NULL)
return NULL;
size = CFStringGetLength(tmp) + 1;
value = (char*)malloc(size);
if(CFStringGetCString(tmp, value, size, kCFStringEncodingUTF8)) {
return value;
}
free(value);
return NULL;
}
struct macos_powersupply* getPowerSupplyInfo(CFDictionaryRef powerSourceInformation) {
struct macos_powersupply *ret;
if (powerSourceInformation == NULL)
return NULL;
ret = (struct macos_powersupply*)malloc(sizeof(struct macos_powersupply));
ret->PowerSourceID = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSPowerSourceIDKey));
ret->CurrentCapacity = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSCurrentCapacityKey));
ret->MaxCapacity = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSMaxCapacityKey));
ret->DesignCapacity = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSDesignCapacityKey));
ret->NominalCapacity = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSNominalCapacityKey));
ret->TimeToEmpty = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSTimeToEmptyKey));
ret->TimeToFullCharge = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSTimeToFullChargeKey));
ret->Voltage = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSVoltageKey));
ret->Current = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSCurrentKey));
ret->Temperature = CFDictionaryGetInt(powerSourceInformation, CFSTR(kIOPSTemperatureKey));
ret->Name = CFDictionaryGetSring(powerSourceInformation, CFSTR(kIOPSNameKey));
ret->PowerSourceState = CFDictionaryGetSring(powerSourceInformation, CFSTR(kIOPSPowerSourceStateKey));
ret->Type = CFDictionaryGetSring(powerSourceInformation, CFSTR(kIOPSTypeKey));
ret->TransportType = CFDictionaryGetSring(powerSourceInformation, CFSTR(kIOPSTransportTypeKey));
ret->BatteryHealth = CFDictionaryGetSring(powerSourceInformation, CFSTR(kIOPSBatteryHealthKey));
ret->HardwareSerialNumber = CFDictionaryGetSring(powerSourceInformation, CFSTR(kIOPSHardwareSerialNumberKey));
ret->IsCharged = CFDictionaryGetBoolean(powerSourceInformation, CFSTR(kIOPSIsChargedKey));
ret->IsCharging = CFDictionaryGetBoolean(powerSourceInformation, CFSTR(kIOPSIsChargingKey));
ret->InternalFailure = CFDictionaryGetBoolean(powerSourceInformation, CFSTR(kIOPSInternalFailureKey));
ret->IsPresent = CFDictionaryGetBoolean(powerSourceInformation, CFSTR(kIOPSIsPresentKey));
return ret;
}
void releasePowerSupply(struct macos_powersupply *ps) {
free(ps->Name);
free(ps->PowerSourceState);
free(ps->Type);
free(ps->TransportType);
free(ps->BatteryHealth);
free(ps->HardwareSerialNumber);
free(ps->PowerSourceID);
free(ps->CurrentCapacity);
free(ps->MaxCapacity);
free(ps->DesignCapacity);
free(ps->NominalCapacity);
free(ps->TimeToEmpty);
free(ps->TimeToFullCharge);
free(ps->Voltage);
free(ps->Current);
free(ps->Temperature);
free(ps->IsCharged);
free(ps->IsCharging);
free(ps->InternalFailure);
free(ps->IsPresent);
free(ps);
}
*/
import "C"
import (
"fmt"
"strconv"
"github.com/prometheus/client_golang/prometheus"
)
func (c *powerSupplyClassCollector) Update(ch chan<- prometheus.Metric) error {
psList, err := getPowerSourceList()
if err != nil {
return fmt.Errorf("couldn't get IOPPowerSourcesList: %w", err)
}
for _, info := range psList {
labels := getPowerSourceDescriptorLabels(info)
powerSupplyName := labels["power_supply"]
if c.ignoredPattern.MatchString(powerSupplyName) {
continue
}
for name, value := range getPowerSourceDescriptorMap(info) {
if value == nil {
continue
}
ch <- prometheus.MustNewConstMetric(
prometheus.NewDesc(
prometheus.BuildFQName(namespace, c.subsystem, name),
fmt.Sprintf("IOKit Power Source information field %s for <power_supply>.", name),
[]string{"power_supply"}, nil,
),
prometheus.GaugeValue, *value, powerSupplyName,
)
}
pushEnumMetric(
ch,
getPowerSourceDescriptorState(info),
"power_source_state",
c.subsystem,
powerSupplyName,
)
pushEnumMetric(
ch,
getPowerSourceDescriptorBatteryHealth(info),
"battery_health",
c.subsystem,
powerSupplyName,
)
var (
keys []string
values []string
)
for name, value := range labels {
if value != "" {
keys = append(keys, name)
values = append(values, value)
}
}
fieldDesc := prometheus.NewDesc(
prometheus.BuildFQName(namespace, c.subsystem, "info"),
"IOKit Power Source information for <power_supply>.",
keys,
nil,
)
ch <- prometheus.MustNewConstMetric(fieldDesc, prometheus.GaugeValue, 1.0, values...)
C.releasePowerSupply(info)
}
return nil
}
// getPowerSourceList fetches information from IOKit APIs
//
// Data is provided as opaque CoreFoundation references
// C.getPowerSupplyInfo will convert those objects in something
// easily manageable in Go.
// https://developer.apple.com/documentation/iokit/iopowersources_h
func getPowerSourceList() ([]*C.struct_macos_powersupply, error) {
infos, err := C.IOPSCopyPowerSourcesInfo()
if err != nil {
return nil, err
}
defer C.CFRelease(infos)
psList, err := C.IOPSCopyPowerSourcesList(infos)
if err != nil {
return nil, err
}
if psList == C.CFArrayRef(0) {
return nil, nil
}
defer C.CFRelease(C.CFTypeRef(psList))
size, err := C.CFArrayGetCount(psList)
if err != nil {
return nil, err
}
ret := make([]*C.struct_macos_powersupply, size)
for i := C.CFIndex(0); i < size; i++ {
ps, err := C.CFArrayGetValueAtIndex(psList, i)
if err != nil {
return nil, err
}
dict, err := C.IOPSGetPowerSourceDescription(infos, (C.CFTypeRef)(ps))
if err != nil {
return nil, err
}
info, err := C.getPowerSupplyInfo(dict)
if err != nil {
return nil, err
}
ret[int(i)] = info
}
return ret, nil
}
func getPowerSourceDescriptorMap(info *C.struct_macos_powersupply) map[string]*float64 {
return map[string]*float64{
"current_capacity": convertValue(info.CurrentCapacity),
"max_capacity": convertValue(info.MaxCapacity),
"design_capacity": convertValue(info.DesignCapacity),
"nominal_capacity": convertValue(info.NominalCapacity),
"time_to_empty_seconds": minutesToSeconds(info.TimeToEmpty),
"time_to_full_seconds": minutesToSeconds(info.TimeToFullCharge),
"voltage_volt": scaleValue(info.Voltage, 1e3),
"current_ampere": scaleValue(info.Current, 1e3),
"temp_celsius": convertValue(info.Temperature),
"present": convertValue(info.IsPresent),
"charging": convertValue(info.IsCharging),
"charged": convertValue(info.IsCharged),
"internal_failure": convertValue(info.InternalFailure),
}
}
func getPowerSourceDescriptorLabels(info *C.struct_macos_powersupply) map[string]string {
return map[string]string{
"id": strconv.FormatInt(int64(*info.PowerSourceID), 10),
"power_supply": C.GoString(info.Name),
"type": C.GoString(info.Type),
"transport_type": C.GoString(info.TransportType),
"serial_number": C.GoString(info.HardwareSerialNumber),
}
}
func getPowerSourceDescriptorState(info *C.struct_macos_powersupply) map[string]float64 {
stateMap := map[string]float64{
"Off Line": 0,
"AC Power": 0,
"Battery Power": 0,
}
// This field is always present
// https://developer.apple.com/documentation/iokit/kiopspowersourcestatekey
stateMap[C.GoString(info.PowerSourceState)] = 1
return stateMap
}
func getPowerSourceDescriptorBatteryHealth(info *C.struct_macos_powersupply) map[string]float64 {
// This field is optional
// https://developer.apple.com/documentation/iokit/kiopsBatteryHealthkey
if info.BatteryHealth == nil {
return nil
}
stateMap := map[string]float64{
"Good": 0,
"Fair": 0,
"Poor": 0,
}
stateMap[C.GoString(info.BatteryHealth)] = 1
return stateMap
}
func convertValue(value *C.int) *float64 {
if value == nil {
return nil
}
ret := new(float64)
*ret = (float64)(*value)
return ret
}
func scaleValue(value *C.int, scale float64) *float64 {
ret := convertValue(value)
if ret == nil {
return nil
}
*ret /= scale
return ret
}
// minutesToSeconds converts *C.int minutes into *float64 seconds.
//
// Only positive values will be scaled to seconds, because negative ones
// have special meanings. I.e. -1 indicates "Still Calculating the Time"
func minutesToSeconds(minutes *C.int) *float64 {
ret := convertValue(minutes)
if ret == nil {
return nil
}
if *ret > 0 {
*ret *= 60
}
return ret
}
func pushEnumMetric(ch chan<- prometheus.Metric, values map[string]float64, name, subsystem, powerSupply string) {
for state, value := range values {
ch <- prometheus.MustNewConstMetric(
prometheus.NewDesc(
prometheus.BuildFQName(namespace, subsystem, name),
fmt.Sprintf("IOKit Power Source information field %s for <power_supply>.", name),
[]string{"power_supply", "state"}, nil,
),
prometheus.GaugeValue, value, powerSupply, state,
)
}
}
|