mirror of
https://github.com/prometheus-community/windows_exporter
synced 2025-01-12 09:19:31 +00:00
448 lines
14 KiB
Go
448 lines
14 KiB
Go
//go:build windows
|
|
|
|
package smbclient
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"slices"
|
|
"strings"
|
|
|
|
"github.com/alecthomas/kingpin/v2"
|
|
"github.com/go-kit/log"
|
|
"github.com/go-kit/log/level"
|
|
"github.com/prometheus-community/windows_exporter/pkg/perflib"
|
|
"github.com/prometheus-community/windows_exporter/pkg/types"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
const (
|
|
Name = "smbclient"
|
|
FlagSmbClientListAllCollectors = "collectors.smbclient.list"
|
|
FlagSmbClientCollectorsEnabled = "collectors.smbclient.enabled"
|
|
)
|
|
|
|
type Config struct {
|
|
CollectorsEnabled string `yaml:"collectors_enabled"`
|
|
}
|
|
|
|
var ConfigDefaults = Config{
|
|
CollectorsEnabled: "",
|
|
}
|
|
|
|
type collector struct {
|
|
logger log.Logger
|
|
|
|
smbclientListAllCollectors *bool
|
|
smbclientCollectorsEnabled *string
|
|
|
|
ReadRequestQueueSecsTotal *prometheus.Desc
|
|
ReadBytesTotal *prometheus.Desc
|
|
ReadsTotal *prometheus.Desc
|
|
ReadBytesTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
ReadRequestsTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
TurboIOReadsTotal *prometheus.Desc
|
|
ReadSecsTotal *prometheus.Desc
|
|
|
|
WriteRequestQueueSecsTotal *prometheus.Desc
|
|
WriteBytesTotal *prometheus.Desc
|
|
WritesTotal *prometheus.Desc
|
|
WriteBytesTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
WriteRequestsTransmittedViaSMBDirectTotal *prometheus.Desc
|
|
TurboIOWritesTotal *prometheus.Desc
|
|
WriteSecsTotal *prometheus.Desc
|
|
|
|
RequestQueueSecsTotal *prometheus.Desc
|
|
RequestSecs *prometheus.Desc
|
|
CreditStallsTotal *prometheus.Desc
|
|
CurrentDataQueued *prometheus.Desc
|
|
DataBytesTotal *prometheus.Desc
|
|
DataRequestsTotal *prometheus.Desc
|
|
MetadataRequestsTotal *prometheus.Desc
|
|
|
|
enabledCollectors []string
|
|
}
|
|
|
|
// All available collector functions
|
|
var smbclientAllCollectorNames = []string{
|
|
"ClientShares",
|
|
}
|
|
|
|
func New(logger log.Logger, config *Config) types.Collector {
|
|
if config == nil {
|
|
config = &ConfigDefaults
|
|
}
|
|
|
|
smbclientListAllCollectors := false
|
|
c := &collector{
|
|
smbclientCollectorsEnabled: &config.CollectorsEnabled,
|
|
smbclientListAllCollectors: &smbclientListAllCollectors,
|
|
}
|
|
c.SetLogger(logger)
|
|
return c
|
|
}
|
|
|
|
func NewWithFlags(app *kingpin.Application) types.Collector {
|
|
return &collector{
|
|
smbclientListAllCollectors: app.Flag(
|
|
FlagSmbClientListAllCollectors,
|
|
"List the collectors along with their perflib object name/ids",
|
|
).Bool(),
|
|
|
|
smbclientCollectorsEnabled: app.Flag(
|
|
FlagSmbClientCollectorsEnabled,
|
|
"Comma-separated list of collectors to use. Defaults to all, if not specified.",
|
|
).Default(ConfigDefaults.CollectorsEnabled).String(),
|
|
}
|
|
}
|
|
|
|
func (c *collector) GetName() string {
|
|
return Name
|
|
}
|
|
|
|
func (c *collector) SetLogger(logger log.Logger) {
|
|
c.logger = log.With(logger, "collector", Name)
|
|
}
|
|
|
|
func (c *collector) GetPerfCounter() ([]string, error) {
|
|
return []string{
|
|
"SMB Client Shares",
|
|
}, nil
|
|
}
|
|
|
|
func (c *collector) Build() 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"},
|
|
)
|
|
|
|
c.enabledCollectors = make([]string, 0, len(smbclientAllCollectorNames))
|
|
|
|
collectorDesc := map[string]string{
|
|
"ClientShares": "SMB Client Shares",
|
|
}
|
|
|
|
if *c.smbclientListAllCollectors {
|
|
fmt.Printf("%-32s %-32s\n", "Collector Name", "Perflib Object")
|
|
for _, cname := range smbclientAllCollectorNames {
|
|
fmt.Printf("%-32s %-32s\n", cname, collectorDesc[cname])
|
|
}
|
|
os.Exit(0)
|
|
}
|
|
|
|
if *c.smbclientCollectorsEnabled == "" {
|
|
for _, collectorName := range smbclientAllCollectorNames {
|
|
c.enabledCollectors = append(c.enabledCollectors, collectorName)
|
|
}
|
|
} else {
|
|
for _, collectorName := range strings.Split(*c.smbclientCollectorsEnabled, ",") {
|
|
if slices.Contains(smbclientAllCollectorNames, collectorName) {
|
|
c.enabledCollectors = append(c.enabledCollectors, collectorName)
|
|
} else {
|
|
return fmt.Errorf("unknown smbclient collector: %s", collectorName)
|
|
}
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Collect collects smb client metrics and sends them to prometheus
|
|
func (c *collector) Collect(ctx *types.ScrapeContext, ch chan<- prometheus.Metric) error {
|
|
collectorFuncs := map[string]func(ctx *types.ScrapeContext, ch chan<- prometheus.Metric) error{
|
|
"ClientShares": c.collectClientShares,
|
|
}
|
|
|
|
for _, collectorName := range c.enabledCollectors {
|
|
if err := collectorFuncs[collectorName](ctx, ch); err != nil {
|
|
_ = level.Error(c.logger).Log("msg", "Error in "+collectorName, "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, ch chan<- prometheus.Metric) error {
|
|
var data []perflibClientShares
|
|
if err := perflib.UnmarshalObject(ctx.PerfObjects["SMB Client Shares"], &data, c.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*perflib.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
// Read time spent on queue. Convert from ticks to seconds.
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.ReadRequestQueueSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgReadQueueLength*perflib.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.ReadSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgSecPerRead*perflib.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.WriteSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgSecPerWrite*perflib.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.RequestSecs,
|
|
prometheus.CounterValue,
|
|
instance.AvgSecPerDataRequest*perflib.TicksToSecondScaleFactor,
|
|
serverValue, shareValue,
|
|
)
|
|
|
|
// Write time spent on queue. Convert from ticks to seconds.
|
|
ch <- prometheus.MustNewConstMetric(
|
|
c.WriteRequestQueueSecsTotal,
|
|
prometheus.CounterValue,
|
|
instance.AvgWriteQueueLength*perflib.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
|
|
}
|