//go:build windows package cache import ( "github.com/alecthomas/kingpin/v2" "github.com/go-kit/log" "github.com/go-kit/log/level" "github.com/pkg/errors" "github.com/prometheus-community/windows_exporter/pkg/perflib" "github.com/prometheus-community/windows_exporter/pkg/types" "github.com/prometheus/client_golang/prometheus" ) const Name = "cache" type Config struct{} var ConfigDefaults = Config{} // A Collector is a Prometheus Collector for Perflib Cache metrics. type Collector struct { config Config asyncCopyReadsTotal *prometheus.Desc asyncDataMapsTotal *prometheus.Desc asyncFastReadsTotal *prometheus.Desc asyncMDLReadsTotal *prometheus.Desc asyncPinReadsTotal *prometheus.Desc copyReadHitsTotal *prometheus.Desc copyReadsTotal *prometheus.Desc dataFlushesTotal *prometheus.Desc dataFlushPagesTotal *prometheus.Desc dataMapHitsPercent *prometheus.Desc dataMapPinsTotal *prometheus.Desc dataMapsTotal *prometheus.Desc dirtyPages *prometheus.Desc dirtyPageThreshold *prometheus.Desc fastReadNotPossiblesTotal *prometheus.Desc fastReadResourceMissesTotal *prometheus.Desc fastReadsTotal *prometheus.Desc lazyWriteFlushesTotal *prometheus.Desc lazyWritePagesTotal *prometheus.Desc mdlReadHitsTotal *prometheus.Desc mdlReadsTotal *prometheus.Desc pinReadHitsTotal *prometheus.Desc pinReadsTotal *prometheus.Desc readAheadsTotal *prometheus.Desc syncCopyReadsTotal *prometheus.Desc syncDataMapsTotal *prometheus.Desc syncFastReadsTotal *prometheus.Desc syncMDLReadsTotal *prometheus.Desc syncPinReadsTotal *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(_ log.Logger) ([]string, error) { return []string{"Cache"}, nil } func (c *Collector) Close() error { return nil } func (c *Collector) Build(_ log.Logger) error { c.asyncCopyReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "async_copy_reads_total"), "(AsyncCopyReadsTotal)", nil, nil, ) c.asyncDataMapsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "async_data_maps_total"), "(AsyncDataMapsTotal)", nil, nil, ) c.asyncFastReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "async_fast_reads_total"), "(AsyncFastReadsTotal)", nil, nil, ) c.asyncMDLReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "async_mdl_reads_total"), "(AsyncMDLReadsTotal)", nil, nil, ) c.asyncPinReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "async_pin_reads_total"), "(AsyncPinReadsTotal)", nil, nil, ) c.copyReadHitsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "copy_read_hits_total"), "(CopyReadHitsTotal)", nil, nil, ) c.copyReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "copy_reads_total"), "(CopyReadsTotal)", nil, nil, ) c.dataFlushesTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "data_flushes_total"), "(DataFlushesTotal)", nil, nil, ) c.dataFlushPagesTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "data_flush_pages_total"), "(DataFlushPagesTotal)", nil, nil, ) c.dataMapHitsPercent = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "data_map_hits_percent"), "(DataMapHitsPercent)", nil, nil, ) c.dataMapPinsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "data_map_pins_total"), "(DataMapPinsTotal)", nil, nil, ) c.dataMapsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "data_maps_total"), "(DataMapsTotal)", nil, nil, ) c.dirtyPages = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "dirty_pages"), "(DirtyPages)", nil, nil, ) c.dirtyPageThreshold = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "dirty_page_threshold"), "(DirtyPageThreshold)", nil, nil, ) c.fastReadNotPossiblesTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "fast_read_not_possibles_total"), "(FastReadNotPossiblesTotal)", nil, nil, ) c.fastReadResourceMissesTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "fast_read_resource_misses_total"), "(FastReadResourceMissesTotal)", nil, nil, ) c.fastReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "fast_reads_total"), "(FastReadsTotal)", nil, nil, ) c.lazyWriteFlushesTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "lazy_write_flushes_total"), "(LazyWriteFlushesTotal)", nil, nil, ) c.lazyWritePagesTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "lazy_write_pages_total"), "(LazyWritePagesTotal)", nil, nil, ) c.mdlReadHitsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "mdl_read_hits_total"), "(MDLReadHitsTotal)", nil, nil, ) c.mdlReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "mdl_reads_total"), "(MDLReadsTotal)", nil, nil, ) c.pinReadHitsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "pin_read_hits_total"), "(PinReadHitsTotal)", nil, nil, ) c.pinReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "pin_reads_total"), "(PinReadsTotal)", nil, nil, ) c.readAheadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "read_aheads_total"), "(ReadAheadsTotal)", nil, nil, ) c.syncCopyReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "sync_copy_reads_total"), "(SyncCopyReadsTotal)", nil, nil, ) c.syncDataMapsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "sync_data_maps_total"), "(SyncDataMapsTotal)", nil, nil, ) c.syncFastReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "sync_fast_reads_total"), "(SyncFastReadsTotal)", nil, nil, ) c.syncMDLReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "sync_mdl_reads_total"), "(SyncMDLReadsTotal)", nil, nil, ) c.syncPinReadsTotal = prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, Name, "sync_pin_reads_total"), "(SyncPinReadsTotal)", nil, nil, ) return nil } // Collect implements the Collector interface. func (c *Collector) Collect(ctx *types.ScrapeContext, logger log.Logger, ch chan<- prometheus.Metric) error { logger = log.With(logger, "collector", Name) if err := c.collect(ctx, logger, ch); err != nil { _ = level.Error(logger).Log("msg", "failed collecting cache metrics", "err", err) return err } return nil } // Perflib "Cache": // - https://docs.microsoft.com/en-us/previous-versions/aa394267(v=vs.85) type perflibCache struct { AsyncCopyReadsTotal float64 `perflib:"Async Copy Reads/sec"` AsyncDataMapsTotal float64 `perflib:"Async Data Maps/sec"` AsyncFastReadsTotal float64 `perflib:"Async Fast Reads/sec"` AsyncMDLReadsTotal float64 `perflib:"Async MDL Reads/sec"` AsyncPinReadsTotal float64 `perflib:"Async Pin Reads/sec"` CopyReadHitsTotal float64 `perflib:"Copy Read Hits/sec"` CopyReadsTotal float64 `perflib:"Copy Reads/sec"` DataFlushesTotal float64 `perflib:"Data Flushes/sec"` DataFlushPagesTotal float64 `perflib:"Data Flush Pages/sec"` DataMapPinsTotal float64 `perflib:"Data Map Pins/sec"` DataMapsTotal float64 `perflib:"Data Maps/sec"` FastReadNotPossiblesTotal float64 `perflib:"Fast Read Not Possibles/sec"` FastReadResourceMissesTotal float64 `perflib:"Fast Read Resource Misses/sec"` FastReadsTotal float64 `perflib:"Fast Reads/sec"` LazyWriteFlushesTotal float64 `perflib:"Lazy Write Flushes/sec"` LazyWritePagesTotal float64 `perflib:"Lazy Write Pages/sec"` MDLReadHitsTotal float64 `perflib:"MDL Read Hits/sec"` MDLReadsTotal float64 `perflib:"MDL Reads/sec"` PinReadHitsTotal float64 `perflib:"Pin Read Hits/sec"` PinReadsTotal float64 `perflib:"Pin Reads/sec"` ReadAheadsTotal float64 `perflib:"Read Aheads/sec"` SyncCopyReadsTotal float64 `perflib:"Sync Copy Reads/sec"` SyncDataMapsTotal float64 `perflib:"Sync Data Maps/sec"` SyncFastReadsTotal float64 `perflib:"Sync Fast Reads/sec"` SyncMDLReadsTotal float64 `perflib:"Sync MDL Reads/sec"` SyncPinReadsTotal float64 `perflib:"Sync Pin Reads/sec"` DirtyPages float64 `perflib:"Dirty Pages"` DirtyPageThreshold float64 `perflib:"Dirty Page Threshold"` DataMapHitsPercent float64 `perflib:"Data Map Hits %"` } func (c *Collector) collect(ctx *types.ScrapeContext, logger log.Logger, ch chan<- prometheus.Metric) error { logger = log.With(logger, "collector", Name) var dst []perflibCache // Single-instance class, array is required but will have single entry. if err := perflib.UnmarshalObject(ctx.PerfObjects["Cache"], &dst, logger); err != nil { return err } if len(dst) != 1 { return errors.New("expected single instance of Cache") } ch <- prometheus.MustNewConstMetric( c.asyncCopyReadsTotal, prometheus.CounterValue, dst[0].AsyncCopyReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.asyncDataMapsTotal, prometheus.CounterValue, dst[0].AsyncDataMapsTotal, ) ch <- prometheus.MustNewConstMetric( c.asyncFastReadsTotal, prometheus.CounterValue, dst[0].AsyncFastReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.asyncMDLReadsTotal, prometheus.CounterValue, dst[0].AsyncMDLReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.asyncPinReadsTotal, prometheus.CounterValue, dst[0].AsyncPinReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.copyReadHitsTotal, prometheus.CounterValue, dst[0].CopyReadHitsTotal, ) ch <- prometheus.MustNewConstMetric( c.copyReadsTotal, prometheus.CounterValue, dst[0].CopyReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.dataFlushesTotal, prometheus.CounterValue, dst[0].DataFlushesTotal, ) ch <- prometheus.MustNewConstMetric( c.dataFlushPagesTotal, prometheus.CounterValue, dst[0].DataFlushPagesTotal, ) ch <- prometheus.MustNewConstMetric( c.dataMapPinsTotal, prometheus.CounterValue, dst[0].DataMapPinsTotal, ) ch <- prometheus.MustNewConstMetric( c.dataMapsTotal, prometheus.CounterValue, dst[0].DataMapsTotal, ) ch <- prometheus.MustNewConstMetric( c.fastReadNotPossiblesTotal, prometheus.CounterValue, dst[0].FastReadNotPossiblesTotal, ) ch <- prometheus.MustNewConstMetric( c.fastReadResourceMissesTotal, prometheus.CounterValue, dst[0].FastReadResourceMissesTotal, ) ch <- prometheus.MustNewConstMetric( c.fastReadsTotal, prometheus.CounterValue, dst[0].FastReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.lazyWriteFlushesTotal, prometheus.CounterValue, dst[0].LazyWriteFlushesTotal, ) ch <- prometheus.MustNewConstMetric( c.lazyWritePagesTotal, prometheus.CounterValue, dst[0].LazyWritePagesTotal, ) ch <- prometheus.MustNewConstMetric( c.mdlReadHitsTotal, prometheus.CounterValue, dst[0].MDLReadHitsTotal, ) ch <- prometheus.MustNewConstMetric( c.mdlReadsTotal, prometheus.CounterValue, dst[0].MDLReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.pinReadHitsTotal, prometheus.CounterValue, dst[0].PinReadHitsTotal, ) ch <- prometheus.MustNewConstMetric( c.pinReadsTotal, prometheus.CounterValue, dst[0].PinReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.readAheadsTotal, prometheus.CounterValue, dst[0].ReadAheadsTotal, ) ch <- prometheus.MustNewConstMetric( c.syncCopyReadsTotal, prometheus.CounterValue, dst[0].SyncCopyReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.syncDataMapsTotal, prometheus.CounterValue, dst[0].SyncDataMapsTotal, ) ch <- prometheus.MustNewConstMetric( c.syncFastReadsTotal, prometheus.CounterValue, dst[0].SyncFastReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.syncMDLReadsTotal, prometheus.CounterValue, dst[0].SyncMDLReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.syncPinReadsTotal, prometheus.CounterValue, dst[0].SyncPinReadsTotal, ) ch <- prometheus.MustNewConstMetric( c.dirtyPages, prometheus.GaugeValue, dst[0].DirtyPages, ) ch <- prometheus.MustNewConstMetric( c.dirtyPageThreshold, prometheus.GaugeValue, dst[0].DirtyPageThreshold, ) ch <- prometheus.MustNewConstMetric( c.dataMapHitsPercent, prometheus.GaugeValue, dst[0].DataMapHitsPercent, ) return nil }