// 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 collector import ( "context" "errors" "fmt" "log/slog" "maps" "slices" "sync" gotime "time" "github.com/alecthomas/kingpin/v2" "github.com/prometheus-community/windows_exporter/internal/collector/ad" "github.com/prometheus-community/windows_exporter/internal/collector/adcs" "github.com/prometheus-community/windows_exporter/internal/collector/adfs" "github.com/prometheus-community/windows_exporter/internal/collector/cache" "github.com/prometheus-community/windows_exporter/internal/collector/container" "github.com/prometheus-community/windows_exporter/internal/collector/cpu" "github.com/prometheus-community/windows_exporter/internal/collector/cpu_info" "github.com/prometheus-community/windows_exporter/internal/collector/dfsr" "github.com/prometheus-community/windows_exporter/internal/collector/dhcp" "github.com/prometheus-community/windows_exporter/internal/collector/diskdrive" "github.com/prometheus-community/windows_exporter/internal/collector/dns" "github.com/prometheus-community/windows_exporter/internal/collector/exchange" "github.com/prometheus-community/windows_exporter/internal/collector/file" "github.com/prometheus-community/windows_exporter/internal/collector/fsrmquota" "github.com/prometheus-community/windows_exporter/internal/collector/gpu" "github.com/prometheus-community/windows_exporter/internal/collector/hyperv" "github.com/prometheus-community/windows_exporter/internal/collector/iis" "github.com/prometheus-community/windows_exporter/internal/collector/license" "github.com/prometheus-community/windows_exporter/internal/collector/logical_disk" "github.com/prometheus-community/windows_exporter/internal/collector/memory" "github.com/prometheus-community/windows_exporter/internal/collector/mscluster" "github.com/prometheus-community/windows_exporter/internal/collector/msmq" "github.com/prometheus-community/windows_exporter/internal/collector/mssql" "github.com/prometheus-community/windows_exporter/internal/collector/net" "github.com/prometheus-community/windows_exporter/internal/collector/netframework" "github.com/prometheus-community/windows_exporter/internal/collector/nps" "github.com/prometheus-community/windows_exporter/internal/collector/os" "github.com/prometheus-community/windows_exporter/internal/collector/pagefile" "github.com/prometheus-community/windows_exporter/internal/collector/performancecounter" "github.com/prometheus-community/windows_exporter/internal/collector/physical_disk" "github.com/prometheus-community/windows_exporter/internal/collector/printer" "github.com/prometheus-community/windows_exporter/internal/collector/process" "github.com/prometheus-community/windows_exporter/internal/collector/remote_fx" "github.com/prometheus-community/windows_exporter/internal/collector/scheduled_task" "github.com/prometheus-community/windows_exporter/internal/collector/service" "github.com/prometheus-community/windows_exporter/internal/collector/smb" "github.com/prometheus-community/windows_exporter/internal/collector/smbclient" "github.com/prometheus-community/windows_exporter/internal/collector/smtp" "github.com/prometheus-community/windows_exporter/internal/collector/system" "github.com/prometheus-community/windows_exporter/internal/collector/tcp" "github.com/prometheus-community/windows_exporter/internal/collector/terminal_services" "github.com/prometheus-community/windows_exporter/internal/collector/textfile" "github.com/prometheus-community/windows_exporter/internal/collector/thermalzone" "github.com/prometheus-community/windows_exporter/internal/collector/time" "github.com/prometheus-community/windows_exporter/internal/collector/udp" "github.com/prometheus-community/windows_exporter/internal/collector/update" "github.com/prometheus-community/windows_exporter/internal/collector/vmware" "github.com/prometheus-community/windows_exporter/internal/mi" "github.com/prometheus-community/windows_exporter/internal/pdh" "github.com/prometheus-community/windows_exporter/internal/types" "github.com/prometheus/client_golang/prometheus" "golang.org/x/sys/windows/registry" ) // NewWithFlags To be called by the exporter for collector initialization before running kingpin.Parse. func NewWithFlags(app *kingpin.Application) *Collection { collectors := map[string]Collector{} for name, builder := range BuildersWithFlags { collectors[name] = builder(app) } return New(collectors) } // NewWithConfig To be called by the external libraries for collector initialization without running [kingpin.Parse]. // //goland:noinspection GoUnusedExportedFunction func NewWithConfig(config Config) *Collection { collectors := Map{} collectors[ad.Name] = ad.New(&config.AD) collectors[adcs.Name] = adcs.New(&config.ADCS) collectors[adfs.Name] = adfs.New(&config.ADFS) collectors[cache.Name] = cache.New(&config.Cache) collectors[container.Name] = container.New(&config.Container) collectors[cpu.Name] = cpu.New(&config.CPU) collectors[cpu_info.Name] = cpu_info.New(&config.CPUInfo) collectors[dfsr.Name] = dfsr.New(&config.DFSR) collectors[dhcp.Name] = dhcp.New(&config.Dhcp) collectors[diskdrive.Name] = diskdrive.New(&config.DiskDrive) collectors[dns.Name] = dns.New(&config.DNS) collectors[exchange.Name] = exchange.New(&config.Exchange) collectors[file.Name] = file.New(&config.File) collectors[fsrmquota.Name] = fsrmquota.New(&config.Fsrmquota) collectors[gpu.Name] = gpu.New(&config.GPU) collectors[hyperv.Name] = hyperv.New(&config.HyperV) collectors[iis.Name] = iis.New(&config.IIS) collectors[license.Name] = license.New(&config.License) collectors[logical_disk.Name] = logical_disk.New(&config.LogicalDisk) collectors[memory.Name] = memory.New(&config.Memory) collectors[mscluster.Name] = mscluster.New(&config.MSCluster) collectors[msmq.Name] = msmq.New(&config.Msmq) collectors[mssql.Name] = mssql.New(&config.Mssql) collectors[net.Name] = net.New(&config.Net) collectors[netframework.Name] = netframework.New(&config.NetFramework) collectors[nps.Name] = nps.New(&config.Nps) collectors[os.Name] = os.New(&config.OS) collectors[pagefile.Name] = pagefile.New(&config.Paging) collectors[performancecounter.Name] = performancecounter.New(&config.PerformanceCounter) collectors[physical_disk.Name] = physical_disk.New(&config.PhysicalDisk) collectors[printer.Name] = printer.New(&config.Printer) collectors[process.Name] = process.New(&config.Process) collectors[remote_fx.Name] = remote_fx.New(&config.RemoteFx) collectors[scheduled_task.Name] = scheduled_task.New(&config.ScheduledTask) collectors[service.Name] = service.New(&config.Service) collectors[smb.Name] = smb.New(&config.SMB) collectors[smbclient.Name] = smbclient.New(&config.SMBClient) collectors[smtp.Name] = smtp.New(&config.SMTP) collectors[system.Name] = system.New(&config.System) collectors[tcp.Name] = tcp.New(&config.TCP) collectors[terminal_services.Name] = terminal_services.New(&config.TerminalServices) collectors[textfile.Name] = textfile.New(&config.Textfile) collectors[thermalzone.Name] = thermalzone.New(&config.ThermalZone) collectors[time.Name] = time.New(&config.Time) collectors[udp.Name] = udp.New(&config.UDP) collectors[update.Name] = update.New(&config.Update) collectors[vmware.Name] = vmware.New(&config.Vmware) return New(collectors) } // New To be called by the external libraries for collector initialization. func New(collectors Map) *Collection { return &Collection{ collectors: collectors, concurrencyCh: make(chan struct{}, 1), scrapeDurationDesc: prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, "exporter", "scrape_duration_seconds"), "windows_exporter: Total scrape duration.", nil, nil, ), collectorScrapeDurationDesc: prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, "exporter", "collector_duration_seconds"), "windows_exporter: Duration of a collection.", []string{"collector"}, nil, ), collectorScrapeSuccessDesc: prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, "exporter", "collector_success"), "windows_exporter: Whether the collector was successful.", []string{"collector"}, nil, ), collectorScrapeTimeoutDesc: prometheus.NewDesc( prometheus.BuildFQName(types.Namespace, "exporter", "collector_timeout"), "windows_exporter: Whether the collector timed out.", []string{"collector"}, nil, ), } } // Enable removes all collectors that not enabledCollectors. func (c *Collection) Enable(enabledCollectors []string) error { for _, name := range enabledCollectors { if _, ok := c.collectors[name]; !ok { return fmt.Errorf("unknown collector %s", name) } } for name := range c.collectors { if !slices.Contains(enabledCollectors, name) { delete(c.collectors, name) } } return nil } // Disable removes all collectors that are listed in disabledCollectors. func (c *Collection) Disable(disabledCollectors []string) { for name := range c.collectors { if slices.Contains(disabledCollectors, name) { delete(c.collectors, name) } } } // Build To be called by the exporter for collector initialization. // Instead, fail fast, it will try to build all collectors and return all errors. // errors are joined with errors.Join. func (c *Collection) Build(ctx context.Context, logger *slog.Logger) error { c.startTime = gotime.Now() err := c.initMI() if err != nil { return fmt.Errorf("error from initialize MI: %w", err) } wg := sync.WaitGroup{} wg.Add(len(c.collectors)) errCh := make(chan error, len(c.collectors)) for _, collector := range c.collectors { go func() { defer wg.Done() if err = collector.Build(logger, c.miSession); err != nil { errCh <- fmt.Errorf("error build collector %s: %w", collector.GetName(), err) } }() } wg.Wait() close(errCh) errs := make([]error, 0, len(c.collectors)) for err := range errCh { if errors.Is(err, pdh.ErrNoData) || errors.Is(err, registry.ErrNotExist) || errors.Is(err, pdh.NewPdhError(pdh.CstatusNoObject)) || errors.Is(err, pdh.NewPdhError(pdh.CstatusNoCounter)) || errors.Is(err, mi.MI_RESULT_INVALID_NAMESPACE) { logger.LogAttrs(ctx, slog.LevelWarn, "couldn't initialize collector", slog.Any("err", err)) continue } errs = append(errs, err) } return errors.Join(errs...) } // Close To be called by the exporter for collector cleanup. func (c *Collection) Close() error { errs := make([]error, 0, len(c.collectors)) for _, collector := range c.collectors { if err := collector.Close(); err != nil { errs = append(errs, fmt.Errorf("error from close collector %s: %w", collector.GetName(), err)) } } app, err := c.miSession.GetApplication() if err != nil && !errors.Is(err, mi.ErrNotInitialized) { errs = append(errs, fmt.Errorf("error from get MI application: %w", err)) } if err := c.miSession.Close(); err != nil && !errors.Is(err, mi.ErrNotInitialized) { errs = append(errs, fmt.Errorf("error from close MI session: %w", err)) } if err := app.Close(); err != nil && !errors.Is(err, mi.ErrNotInitialized) { errs = append(errs, fmt.Errorf("error from close MI application: %w", err)) } return errors.Join(errs...) } // initMI To be called by the exporter for collector initialization. func (c *Collection) initMI() error { app, err := mi.ApplicationInitialize() if err != nil { return fmt.Errorf("error from initialize MI application: %w", err) } destinationOptions, err := app.NewDestinationOptions() if err != nil { return fmt.Errorf("error from create NewDestinationOptions: %w", err) } if err = destinationOptions.SetLocale(mi.LocaleEnglish); err != nil { return fmt.Errorf("error from set locale: %w", err) } if err = destinationOptions.SetTimeout(gotime.Second); err != nil { return fmt.Errorf("error from set timeout: %w", err) } c.miSession, err = app.NewSession(destinationOptions) if err != nil { return fmt.Errorf("error from create NewSession: %w", err) } return nil } // WithCollectors To be called by the exporter for collector initialization. func (c *Collection) WithCollectors(collectors []string) (*Collection, error) { metricCollectors := &Collection{ miSession: c.miSession, startTime: c.startTime, concurrencyCh: c.concurrencyCh, scrapeDurationDesc: c.scrapeDurationDesc, collectorScrapeDurationDesc: c.collectorScrapeDurationDesc, collectorScrapeSuccessDesc: c.collectorScrapeSuccessDesc, collectorScrapeTimeoutDesc: c.collectorScrapeTimeoutDesc, collectors: maps.Clone(c.collectors), } if err := metricCollectors.Enable(collectors); err != nil { return nil, err } return metricCollectors, nil } func (c *Collection) GetStartTime() gotime.Time { return c.startTime }