node_exporter/collector/drm_linux.go

// Copyright 2021 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 !nogpu

package collector

import (
	"fmt"
	"log/slog"

	"github.com/prometheus/client_golang/prometheus"
	"github.com/prometheus/procfs/sysfs"
)

const (
	drmCollectorSubsystem = "drm"
)

type drmCollector struct {
	fs     sysfs.FS
	logger *slog.Logger
}

func init() {
	registerCollector("drm", defaultDisabled, NewDrmCollector)
}

var (
	drmCardInfo = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "card_info"),
		"Card information",
		[]string{"card", "memory_vendor", "power_performance_level", "unique_id", "chip", "vendor"}, nil,
	)
	drmGPUBusyPercent = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "gpu_busy_percent"),
		"How busy the GPU is as a percentage.",
		[]string{"card"}, nil,
	)
	drmMemoryGTTSize = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "memory_gtt_size_bytes"),
		"The size of the graphics translation table (GTT) block in bytes.",
		[]string{"card"}, nil,
	)
	drmMemoryGTTUsed = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "memory_gtt_used_bytes"),
		"The used amount of the graphics translation table (GTT) block in bytes.",
		[]string{"card"}, nil,
	)
	drmMemoryVisibleVRAMSize = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "memory_vis_vram_size_bytes"),
		"The size of visible VRAM in bytes.",
		[]string{"card"}, nil,
	)
	drmMemoryVisibleVRAMUsed = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "memory_vis_vram_used_bytes"),
		"The used amount of visible VRAM in bytes.",
		[]string{"card"}, nil,
	)
	drmMemoryVRAMSize = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "memory_vram_size_bytes"),
		"The size of VRAM in bytes.",
		[]string{"card"}, nil,
	)
	drmMemoryVRAMUsed = prometheus.NewDesc(
		prometheus.BuildFQName(namespace, drmCollectorSubsystem, "memory_vram_used_bytes"),
		"The used amount of VRAM in bytes.",
		[]string{"card"}, nil,
	)
)

// NewDrmCollector returns a new Collector exposing /sys/class/drm/card?/device stats.
func NewDrmCollector(logger *slog.Logger) (Collector, error) {
	fs, err := sysfs.NewFS(*sysPath)
	if err != nil {
		return nil, fmt.Errorf("failed to open sysfs: %w", err)
	}

	return &drmCollector{
		fs:     fs,
		logger: logger,
	}, nil
}

func (c *drmCollector) Update(ch chan<- prometheus.Metric) error {
	return c.updateAMDCards(ch)
}

func chipName(s sysfs.ClassDRMCardAMDGPUStats) string {
	// generate a chip name based on the deviceType and devName
	cleanDevName := cleanMetricName(s.DevName)
	cleanDevType := cleanMetricName(s.DevType)

	if cleanDevType != "" && cleanDevName != "" {
		return cleanDevType + "_" + cleanDevName
	}
	return cleanDevName
}

func (c *drmCollector) updateAMDCards(ch chan<- prometheus.Metric) error {
	vendor := "amd"
	stats, err := c.fs.ClassDRMCardAMDGPUStats()
	if err != nil {
		return err
	}

	for _, s := range stats {
		ch <- prometheus.MustNewConstMetric(
			drmCardInfo, prometheus.GaugeValue, 1,
			s.Name, s.MemoryVRAMVendor, s.PowerDPMForcePerformanceLevel, s.UniqueID, chipName(s), vendor)

		ch <- prometheus.MustNewConstMetric(
			drmGPUBusyPercent, prometheus.GaugeValue, float64(s.GPUBusyPercent), s.Name)

		ch <- prometheus.MustNewConstMetric(
			drmMemoryGTTSize, prometheus.GaugeValue, float64(s.MemoryGTTSize), s.Name)

		ch <- prometheus.MustNewConstMetric(
			drmMemoryGTTUsed, prometheus.GaugeValue, float64(s.MemoryGTTUsed), s.Name)

		ch <- prometheus.MustNewConstMetric(
			drmMemoryVRAMSize, prometheus.GaugeValue, float64(s.MemoryVRAMSize), s.Name)

		ch <- prometheus.MustNewConstMetric(
			drmMemoryVRAMUsed, prometheus.GaugeValue, float64(s.MemoryVRAMUsed), s.Name)

		ch <- prometheus.MustNewConstMetric(
			drmMemoryVisibleVRAMSize, prometheus.GaugeValue, float64(s.MemoryVisibleVRAMSize), s.Name)

		ch <- prometheus.MustNewConstMetric(
			drmMemoryVisibleVRAMUsed, prometheus.GaugeValue, float64(s.MemoryVisibleVRAMUsed), s.Name)
	}

	return nil
}