windows_exporter/internal/collector/mscluster/mscluster_virtualdisk.go

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 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 windows

package mscluster

import (
	"fmt"

	"github.com/prometheus-community/windows_exporter/internal/mi"
	"github.com/prometheus-community/windows_exporter/internal/types"
	"github.com/prometheus/client_golang/prometheus"
)

const nameVirtualDisk = Name + "_virtualdisk"

type collectorVirtualDisk struct {
	virtualDiskMIQuery mi.Query

	virtualDiskInfo              *prometheus.Desc
	virtualDiskHealthStatus      *prometheus.Desc
	virtualDiskSize              *prometheus.Desc
	virtualDiskFootprintOnPool   *prometheus.Desc
	virtualDiskStorageEfficiency *prometheus.Desc
}

// msftVirtualDisk represents the MSFT_VirtualDisk WMI class
type msftVirtualDisk struct {
	FriendlyName    string `mi:"FriendlyName"`
	UniqueId        string `mi:"UniqueId"`
	HealthStatus    uint16 `mi:"HealthStatus"`
	Size            uint64 `mi:"Size"`
	FootprintOnPool uint64 `mi:"FootprintOnPool"`
	// OperationalStatus []uint16 `mi:"OperationalStatus"`  Not supported my mi query: https://github.com/prometheus-community/windows_exporter/pull/2296#issuecomment-3736584632
}

func (c *Collector) buildVirtualDisk() error {
	wmiSelect := "FriendlyName,UniqueId,HealthStatus,Size,FootprintOnPool"

	virtualDiskMIQuery, err := mi.NewQuery(fmt.Sprintf("SELECT %s FROM MSFT_VirtualDisk", wmiSelect))
	if err != nil {
		return fmt.Errorf("failed to create WMI query: %w", err)
	}

	c.virtualDiskMIQuery = virtualDiskMIQuery

	c.virtualDiskInfo = prometheus.NewDesc(
		prometheus.BuildFQName(types.Namespace, nameVirtualDisk, "info"),
		"Virtual Disk information (value is always 1)",
		[]string{"name", "unique_id"},
		nil,
	)

	c.virtualDiskHealthStatus = prometheus.NewDesc(
		prometheus.BuildFQName(types.Namespace, nameVirtualDisk, "health_status"),
		"Health status of the virtual disk. 0: Healthy, 1: Warning, 2: Unhealthy, 5: Unknown",
		[]string{"name", "unique_id"},
		nil,
	)

	c.virtualDiskSize = prometheus.NewDesc(
		prometheus.BuildFQName(types.Namespace, nameVirtualDisk, "size_bytes"),
		"Total size of the virtual disk in bytes",
		[]string{"name", "unique_id"},
		nil,
	)

	c.virtualDiskFootprintOnPool = prometheus.NewDesc(
		prometheus.BuildFQName(types.Namespace, nameVirtualDisk, "footprint_on_pool_bytes"),
		"Physical storage consumed by the virtual disk on the storage pool in bytes",
		[]string{"name", "unique_id"},
		nil,
	)

	c.virtualDiskStorageEfficiency = prometheus.NewDesc(
		prometheus.BuildFQName(types.Namespace, nameVirtualDisk, "storage_efficiency_percent"),
		"Storage efficiency percentage (Size / FootprintOnPool * 100)",
		[]string{"name", "unique_id"},
		nil,
	)

	return nil
}

func (c *Collector) collectVirtualDisk(ch chan<- prometheus.Metric) error {
	var dst []msftVirtualDisk

	if err := c.miSession.Query(&dst, mi.NamespaceRootStorage, c.virtualDiskMIQuery); err != nil {
		return fmt.Errorf("WMI query failed: %w", err)
	}

	for _, vdisk := range dst {
		ch <- prometheus.MustNewConstMetric(
			c.virtualDiskInfo,
			prometheus.GaugeValue,
			1.0,
			vdisk.FriendlyName,
			vdisk.UniqueId,
		)

		ch <- prometheus.MustNewConstMetric(
			c.virtualDiskHealthStatus,
			prometheus.GaugeValue,
			float64(vdisk.HealthStatus),
			vdisk.FriendlyName,
			vdisk.UniqueId,
		)

		ch <- prometheus.MustNewConstMetric(
			c.virtualDiskSize,
			prometheus.GaugeValue,
			float64(vdisk.Size),
			vdisk.FriendlyName,
			vdisk.UniqueId,
		)

		ch <- prometheus.MustNewConstMetric(
			c.virtualDiskFootprintOnPool,
			prometheus.GaugeValue,
			float64(vdisk.FootprintOnPool),
			vdisk.FriendlyName,
			vdisk.UniqueId,
		)

		// Calculate storage efficiency (avoid division by zero)
		var storageEfficiency float64
		if vdisk.FootprintOnPool > 0 {
			storageEfficiency = float64(vdisk.Size) / float64(vdisk.FootprintOnPool) * 100
		} else {
			storageEfficiency = 0
		}

		ch <- prometheus.MustNewConstMetric(
			c.virtualDiskStorageEfficiency,
			prometheus.GaugeValue,
			storageEfficiency,
			vdisk.FriendlyName,
			vdisk.UniqueId,
		)
	}

	return nil
}