windows_exporter

package
v1.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	EnabledCollectors string `yaml:"enabled_collectors"`

	Dfsr               DfsrConfig               `yaml:"dfsr,omitempty"`
	Exchange           ExchangeConfig           `yaml:"exchange,omitempty"`
	MSCluster          MSClusterConfig          `yaml:"mscluster,omitempty"`
	NetFramework       NetFrameworkConfig       `yaml:"netframework,omitempty"`
	IIS                IISConfig                `yaml:"iis,omitempty"`
	TextFile           TextFileConfig           `yaml:"text_file,omitempty"`
	SMTP               SMTPConfig               `yaml:"smtp,omitempty"`
	Service            ServiceConfig            `yaml:"service,omitempty"`
	PhysicalDisk       PhysicalDiskConfig       `yaml:"physical_disk,omitempty"`
	Process            ProcessConfig            `yaml:"process,omitempty"`
	Network            NetworkConfig            `yaml:"network,omitempty"`
	MSSQL              MSSQLConfig              `yaml:"mssql,omitempty"`
	LogicalDisk        LogicalDiskConfig        `yaml:"logical_disk,omitempty"`
	ScheduledTask      ScheduledTaskConfig      `yaml:"scheduled_task,omitempty"`
	Printer            PrinterConfig            `yaml:"printer,omitempty"`
	SMB                SMBConfig                `yaml:"smb,omitempty"`
	SMBClient          SMBClientConfig          `yaml:"smb_client,omitempty"`
	TCP                TCPConfig                `yaml:"tcp,omitempty"`
	Update             UpdateConfig             `yaml:"update,omitempty"`
	Filetime           FiletimeConfig           `yaml:"filetime,omitempty"`
	PerformanceCounter PerformanceCounterConfig `yaml:"performancecounter,omitempty"`
	DNS                DNSConfig                `yaml:"dns,omitempty"`
	Net                NetConfig                `yaml:"net,omitempty"`
}

Config controls the windows_exporter integration. All of these and their child fields are pointers, so we can determine if the value was set or not.

func (*Config) InstanceKey

func (c *Config) InstanceKey(agentKey string) (string, error)

InstanceKey returns the hostname:port of the agent.

func (*Config) Name

func (c *Config) Name() string

Name returns the name used, "windows_explorer"

func (*Config) NewIntegration

func (c *Config) NewIntegration(l log.Logger) (integrations.Integration, error)

NewIntegration creates an integration based on the given configuration

type DNSConfig added in v1.9.1

type DNSConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
}

DNSConfig handles settings for the windows_exporter DNS collector

type DfsrConfig

type DfsrConfig struct {
	SourcesEnabled string `yaml:"sources_enabled,omitempty"`
}

DfsrConfig handles settings for the windows_exporter dfsr collector

type ExchangeConfig

type ExchangeConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
}

ExchangeConfig handles settings for the windows_exporter Exchange collector

type FiletimeConfig added in v1.9.0

type FiletimeConfig struct {
	FilePatterns []string `yaml:"file_patterns,omitempty"`
}

FiletimeConfig handles settings for the windows_exporter filetime collector

type IISConfig

type IISConfig struct {
	SiteWhiteList string `yaml:"site_whitelist,omitempty"`
	SiteBlackList string `yaml:"site_blacklist,omitempty"`
	AppWhiteList  string `yaml:"app_whitelist,omitempty"`
	AppBlackList  string `yaml:"app_blacklist,omitempty"`
	SiteInclude   string `yaml:"site_include,omitempty"`
	SiteExclude   string `yaml:"site_exclude,omitempty"`
	AppInclude    string `yaml:"app_include,omitempty"`
	AppExclude    string `yaml:"app_exclude,omitempty"`
}

IISConfig handles settings for the windows_exporter IIS collector

type Integration

type Integration struct {
}

Integration is the windows_exporter integration. On non-Windows platforms, this integration does nothing and will print a warning if enabled.

func New

func New(logger log.Logger, _ *Config) (*Integration, error)

New creates a fake windows_exporter integration.

func (*Integration) MetricsHandler

func (i *Integration) MetricsHandler() (http.Handler, error)

MetricsHandler satisfies Integration.RegisterRoutes.

func (*Integration) Run

func (i *Integration) Run(ctx context.Context) error

Run satisfies Integration.Run.

func (*Integration) ScrapeConfigs

func (i *Integration) ScrapeConfigs() []config.ScrapeConfig

ScrapeConfigs satisfies Integration.ScrapeConfigs.

type LogicalDiskConfig

type LogicalDiskConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
	BlackList   string `yaml:"blacklist,omitempty"`
	WhiteList   string `yaml:"whitelist,omitempty"`
	Include     string `yaml:"include,omitempty"`
	Exclude     string `yaml:"exclude,omitempty"`
}

LogicalDiskConfig handles settings for the windows_exporter logical disk collector

type MSClusterConfig added in v1.9.0

type MSClusterConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
}

MSClusterConfig handles settings for the windows_exporter MSCluster collector

type MSSQLConfig

type MSSQLConfig struct {
	EnabledClasses string `yaml:"enabled_classes,omitempty"`
}

MSSQLConfig handles settings for the windows_exporter SQL server collector

type NetConfig added in v1.11.0

type NetConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
	Exclude     string `yaml:"exclude,omitempty"`
	Include     string `yaml:"include,omitempty"`
}

NetConfig handles settings for the windows_exporter net collector

type NetFrameworkConfig added in v1.9.0

type NetFrameworkConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
}

NetFrameworkConfig handles settings for the windows_exporter NetFramework collector

type NetworkConfig

type NetworkConfig struct {
	BlackList string `yaml:"blacklist,omitempty"`
	WhiteList string `yaml:"whitelist,omitempty"`
	Include   string `yaml:"include,omitempty"`
	Exclude   string `yaml:"exclude,omitempty"`
}

NetworkConfig handles settings for the windows_exporter network collector

type PerformanceCounterConfig added in v1.9.0

type PerformanceCounterConfig struct {
	Objects string `yaml:"objects,omitempty"`
}

PerformanceCounterConfig handles settings for the windows_exporter performance counter collector

type PhysicalDiskConfig

type PhysicalDiskConfig struct {
	Include string `yaml:"include,omitempty"`
	Exclude string `yaml:"exclude,omitempty"`
}

PhysicalDiskConfig handles settings for the windows_exporter physical disk collector

type PrinterConfig added in v1.4.0

type PrinterConfig struct {
	Include string `yaml:"include,omitempty"`
	Exclude string `yaml:"exclude,omitempty"`
}

PrinterConfig handles settings for the windows_exporter printer collector

type ProcessConfig

type ProcessConfig struct {
	BlackList              string `yaml:"blacklist,omitempty"`
	WhiteList              string `yaml:"whitelist,omitempty"`
	Include                string `yaml:"include,omitempty"`
	Exclude                string `yaml:"exclude,omitempty"`
	EnableIISWorkerProcess bool   `yaml:"enable_iis_worker_process,omitempty"`
	CounterVersion         uint8  `yaml:"counter_version,omitempty"` // 0 for autoselect, 1 for v1, 2 for v2
}

ProcessConfig handles settings for the windows_exporter process collector

type SMBClientConfig added in v1.4.0

type SMBClientConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
}

SMBClientConfig handles settings for the windows_exporter smb client collector Deprecated: This is not used by the windows_exporter

type SMBConfig added in v1.4.0

type SMBConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
}

SMBConfig handles settings for the windows_exporter smb collector Deprecated: This is not used by the windows_exporter

type SMTPConfig

type SMTPConfig struct {
	BlackList string `yaml:"blacklist,omitempty"`
	WhiteList string `yaml:"whitelist,omitempty"`
	Include   string `yaml:"include,omitempty"`
	Exclude   string `yaml:"exclude,omitempty"`
}

SMTPConfig handles settings for the windows_exporter SMTP collector

type ScheduledTaskConfig

type ScheduledTaskConfig struct {
	Include string `yaml:"include,omitempty"`
	Exclude string `yaml:"exclude,omitempty"`
}

ScheduledTaskConfig handles settings for the windows_exporter scheduled_task collector

type ServiceConfig

type ServiceConfig struct {
	Include string `yaml:"include,omitempty"`
	Exclude string `yaml:"exclude,omitempty"`
}

ServiceConfig handles settings for the windows_exporter service collector

type TCPConfig added in v1.9.0

type TCPConfig struct {
	EnabledList string `yaml:"enabled_list,omitempty"`
}

TCPConfig handles settings for the windows_exporter TCP collector

type TextFileConfig

type TextFileConfig struct {
	TextFileDirectory string `yaml:"text_file_directory,omitempty"`
}

TextFileConfig handles settings for the windows_exporter Text File collector

type UpdateConfig added in v1.9.0

type UpdateConfig struct {
	Online         bool          `yaml:"online,omitempty"`
	ScrapeInterval time.Duration `yaml:"scrape_interval,omitempty"`
}

UpdateConfig handles settings for the windows_exporter Update collector

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL