392 lines
12 KiB
Go
392 lines
12 KiB
Go
//go:build windows
|
|
|
|
package smbclient
|
|
|
|
import (
|
|
"log/slog"
|
|
"strings"
|
|
|
|
"github.com/alecthomas/kingpin/v2"
|
|
"github.com/prometheus-community/windows_exporter/internal/perfdata/perftypes"
|
|
v1 "github.com/prometheus-community/windows_exporter/internal/perfdata/v1"
|
|
"github.com/prometheus-community/windows_exporter/internal/types"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/yusufpapurcu/wmi"
|
|
)
|
|
|
|
const (
|
|
Name = "smbclient"
|
|
)
|
|
|
|
type Config struct{}
|
|
|
|
var ConfigDefaults = Config{}
|
|
|
|
type Collector struct {
|
|
config Config
|
|
|
|
readBytesTotal *prometheus.Desc
|
|
readBytesTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
readRequestQueueSecsTotal *prometheus.Desc
|
|
readRequestsTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
readSecsTotal *prometheus.Desc
|
|
readsTotal *prometheus.Desc
|
|
turboIOReadsTotal *prometheus.Desc
|
|
TurboIOWritesTotal *prometheus.Desc
|
|
writeBytesTotal *prometheus.Desc
|
|
writeBytesTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
writeRequestQueueSecsTotal *prometheus.Desc
|
|
writeRequestsTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
writeSecsTotal *prometheus.Desc
|
|
writesTotal *prometheus.Desc
|
|
|
|
creditStallsTotal *prometheus.Desc
|
|
currentDataQueued *prometheus.Desc
|
|
dataBytesTotal *prometheus.Desc
|
|
dataRequestsTotal *prometheus.Desc
|
|
metadataRequestsTotal *prometheus.Desc
|
|
requestQueueSecsTotal *prometheus.Desc
|
|
requestSecs *prometheus.Desc
|
|
}
|
|
|
|
func New(config *Config) *Collector {
|
|
if config == nil {
|
|
config = &ConfigDefaults
|
|
}
|
|
|
|
c := &Collector{
|
|
config: *config,
|
|
}
|
|
|
|
return c
|
|
}
|
|
|
|
func NewWithFlags(_ *kingpin.Application) *Collector {
|
|
return &Collector{}
|
|
}
|
|
|
|
func (c *Collector) GetName() string {
|
|
return Name
|
|
}
|
|
|
|
func (c *Collector) GetPerfCounter(_ *slog.Logger) ([]string, error) {
|
|
return []string{
|
|
"SMB Client Shares",
|
|
}, nil
|
|
}
|
|
|
|
func (c *Collector) Close(_ *slog.Logger) error {
|
|
return nil
|
|
}
|
|
|
|
func (c *Collector) Build(_ *slog.Logger, _ *wmi.Client) error {
|
|
// desc creates a new prometheus description
|
|
desc := func(metricName string, description string, labels []string) *prometheus.Desc {
|
|
return prometheus.NewDesc(
|
|
prometheus.BuildFQName(types.Namespace, "smbclient", metricName),
|
|
description,
|
|
labels,
|
|
nil,
|
|
)
|
|
}
|
|
|
|
c.requestQueueSecsTotal = desc("data_queue_seconds_total",
|
|
"Seconds requests waited on queue on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.readRequestQueueSecsTotal = desc("read_queue_seconds_total",
|
|
"Seconds read requests waited on queue on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.writeRequestQueueSecsTotal = desc("write_queue_seconds_total",
|
|
"Seconds write requests waited on queue on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.requestSecs = desc("request_seconds_total",
|
|
"Seconds waiting for requests on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.creditStallsTotal = desc("stalls_total",
|
|
"The number of requests delayed based on insufficient credits on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.currentDataQueued = desc("requests_queued",
|
|
"The point in time number of requests outstanding on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.dataBytesTotal = desc("data_bytes_total",
|
|
"The bytes read or written on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.dataRequestsTotal = desc("requests_total",
|
|
"The requests on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.metadataRequestsTotal = desc("metadata_requests_total",
|
|
"The metadata requests on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.readBytesTransmittedViaSMBDirectTotal = desc("read_bytes_via_smbdirect_total",
|
|
"The bytes read from this share via RDMA direct placement",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.readBytesTotal = desc("read_bytes_total",
|
|
"The bytes read on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.readRequestsTransmittedViaSMBDirectTotal = desc("read_requests_via_smbdirect_total",
|
|
"The read requests on this share via RDMA direct placement",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.readsTotal = desc("read_requests_total",
|
|
"The read requests on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.turboIOReadsTotal = desc("turbo_io_reads_total",
|
|
"The read requests that go through Turbo I/O",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.TurboIOWritesTotal = desc("turbo_io_writes_total",
|
|
"The write requests that go through Turbo I/O",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.writeBytesTransmittedViaSMBDirectTotal = desc("write_bytes_via_smbdirect_total",
|
|
"The written bytes to this share via RDMA direct placement",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.writeBytesTotal = desc("write_bytes_total",
|
|
"The bytes written on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.writeRequestsTransmittedViaSMBDirectTotal = desc("write_requests_via_smbdirect_total",
|
|
"The write requests to this share via RDMA direct placement",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.writesTotal = desc("write_requests_total",
|
|
"The write requests on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.readSecsTotal = desc("read_seconds_total",
|
|
"Seconds waiting for read requests on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
c.writeSecsTotal = desc("write_seconds_total",
|
|
"Seconds waiting for write requests on this share",
|
|
[]string{"server", "share"},
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
// Collect collects smb client metrics and sends them to prometheus.
|
|
func (c *Collector) Collect(ctx *types.ScrapeContext, logger *slog.Logger, ch chan<- prometheus.Metric) error {
|
|
logger = logger.With(slog.String("collector", Name))
|
|
if err := c.collectClientShares(ctx, logger, ch); err != nil {
|
|
logger.Error("Error in ClientShares",
|
|
slog.Any("err", err),
|
|
)
|
|
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Perflib: SMB Client Shares.
|
|
type perflibClientShares struct {
|
|
Name string
|
|
|
|
AvgDataQueueLength float64 `perflib:"Avg. Data Queue Length"`
|
|
AvgReadQueueLength float64 `perflib:"Avg. Read Queue Length"`
|
|
AvgSecPerRead float64 `perflib:"Avg. sec/Read"`
|
|
AvgSecPerWrite float64 `perflib:"Avg. sec/Write"`
|
|
AvgSecPerDataRequest float64 `perflib:"Avg. sec/Data Request"`
|
|
AvgWriteQueueLength float64 `perflib:"Avg. Write Queue Length"`
|
|
CreditStallsPerSec float64 `perflib:"Credit Stalls/sec"`
|
|
CurrentDataQueueLength float64 `perflib:"Current Data Queue Length"`
|
|
DataBytesPerSec float64 `perflib:"Data Bytes/sec"`
|
|
DataRequestsPerSec float64 `perflib:"Data Requests/sec"`
|
|
MetadataRequestsPerSec float64 `perflib:"Metadata Requests/sec"`
|
|
ReadBytesTransmittedViaSMBDirectPerSec float64 `perflib:"Read Bytes transmitted via SMB Direct/sec"`
|
|
ReadBytesPerSec float64 `perflib:"Read Bytes/sec"`
|
|
ReadRequestsTransmittedViaSMBDirectPerSec float64 `perflib:"Read Requests transmitted via SMB Direct/sec"`
|
|
ReadRequestsPerSec float64 `perflib:"Read Requests/sec"`
|
|
TurboIOReadsPerSec float64 `perflib:"Turbo I/O Reads/sec"`
|
|
TurboIOWritesPerSec float64 `perflib:"Turbo I/O Writes/sec"`
|
|
WriteBytesTransmittedViaSMBDirectPerSec float64 `perflib:"Write Bytes transmitted via SMB Direct/sec"`
|
|
WriteBytesPerSec float64 `perflib:"Write Bytes/sec"`
|
|
WriteRequestsTransmittedViaSMBDirectPerSec float64 `perflib:"Write Requests transmitted via SMB Direct/sec"`
|
|
WriteRequestsPerSec float64 `perflib:"Write Requests/sec"`
|
|
}
|
|
|
|
func (c *Collector) collectClientShares(ctx *types.ScrapeContext, logger *slog.Logger, ch chan<- prometheus.Metric) error {
|
|
logger = logger.With(slog.String("collector", Name))
|
|
|
|
var data []perflibClientShares
|
|
|
|
if err := v1.UnmarshalObject(ctx.PerfObjects["SMB Client Shares"], &data, logger); err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, instance := range data {
|
|
if instance.Name == "_Total" {
|
|
continue
|
|
}
|
|
|
|
parsed := strings.FieldsFunc(instance.Name, func(r rune) bool { return r == '\\' })
|
|
serverValue := parsed[0]
|
|
shareValue := parsed[1]
|
|
// Request time spent on queue. Convert from ticks to seconds.
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.requestQueueSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgDataQueueLength*perftypes.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
// Read time spent on queue. Convert from ticks to seconds.
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.readRequestQueueSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgReadQueueLength*perftypes.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.readSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgSecPerRead*perftypes.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.writeSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgSecPerWrite*perftypes.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.requestSecs,
|
|
prometheus.CounterValue,
|
|
instance.AvgSecPerDataRequest*perftypes.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
// Write time spent on queue. Convert from ticks to seconds.
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.writeRequestQueueSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgWriteQueueLength*perftypes.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.creditStallsTotal,
|
|
prometheus.CounterValue,
|
|
instance.CreditStallsPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.currentDataQueued,
|
|
prometheus.GaugeValue,
|
|
instance.CurrentDataQueueLength,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.dataBytesTotal,
|
|
prometheus.CounterValue,
|
|
instance.DataBytesPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.dataRequestsTotal,
|
|
prometheus.CounterValue,
|
|
instance.DataRequestsPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.metadataRequestsTotal,
|
|
prometheus.CounterValue,
|
|
instance.MetadataRequestsPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.readBytesTransmittedViaSMBDirectTotal,
|
|
prometheus.CounterValue,
|
|
instance.ReadBytesTransmittedViaSMBDirectPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.readBytesTotal,
|
|
prometheus.CounterValue,
|
|
instance.ReadBytesPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.readRequestsTransmittedViaSMBDirectTotal,
|
|
prometheus.CounterValue,
|
|
instance.ReadRequestsTransmittedViaSMBDirectPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.readsTotal,
|
|
prometheus.CounterValue,
|
|
instance.ReadRequestsPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.turboIOReadsTotal,
|
|
prometheus.CounterValue,
|
|
instance.TurboIOReadsPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.TurboIOWritesTotal,
|
|
prometheus.CounterValue,
|
|
instance.TurboIOWritesPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.writeBytesTransmittedViaSMBDirectTotal,
|
|
prometheus.CounterValue,
|
|
instance.WriteBytesTransmittedViaSMBDirectPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.writeBytesTotal,
|
|
prometheus.CounterValue,
|
|
instance.WriteBytesPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.writeRequestsTransmittedViaSMBDirectTotal,
|
|
prometheus.CounterValue,
|
|
instance.WriteRequestsTransmittedViaSMBDirectPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.writesTotal,
|
|
prometheus.CounterValue,
|
|
instance.WriteRequestsPerSec,
|
|
serverValue, shareValue,
|
|
)
|
|
}
|
|
|
|
return nil
|
|
}
|