windows_exporter

Documentation

Index

• Variables
• type Config
  • func (c *Config) InstanceKey(agentKey string) (string, error)
  • func (c *Config) Name() string
  • func (c *Config) NewIntegration(l log.Logger) (integrations.Integration, error)
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type DfsrConfig
• type ExchangeConfig
• type IISConfig
• type Integration
  • func New(logger log.Logger, _ *Config) (*Integration, error)
  • func (i *Integration) MetricsHandler() (http.Handler, error)
  • func (i *Integration) Run(ctx context.Context) error
  • func (i *Integration) ScrapeConfigs() []config.ScrapeConfig
• type LogicalDiskConfig
• type MSMQConfig
• type MSSQLConfig
• type NetworkConfig
• type ProcessConfig
• type SMTPConfig
• type ScheduledTaskConfig
• type ServiceConfig
• type TextFileConfig

Variables

var DefaultConfig = Config{

	EnabledCollectors: "cpu,cs,logical_disk,net,os,service,system",

	Dfsr: DfsrConfig{
		SourcesEnabled: "",
	},
	Exchange: ExchangeConfig{
		EnabledList: "",
	},
	IIS: IISConfig{
		AppBlackList:  "",
		AppWhiteList:  "",
		SiteBlackList: "",
		SiteWhiteList: "",
		AppInclude:    "",
		AppExclude:    "",
		SiteInclude:   "",
		SiteExclude:   "",
	},
	LogicalDisk: LogicalDiskConfig{
		BlackList: "",
		WhiteList: "",
		Include:   "",
		Exclude:   "",
	},
	MSMQ: MSMQConfig{
		Where: "",
	},
	MSSQL: MSSQLConfig{
		EnabledClasses: "",
	},
	Network: NetworkConfig{
		BlackList: "",
		WhiteList: "",
		Include:   "",
		Exclude:   "",
	},
	Process: ProcessConfig{
		BlackList: "",
		WhiteList: "",
		Include:   "",
		Exclude:   "",
	},
	ScheduledTask: ScheduledTaskConfig{
		Include: "",
		Exclude: "",
	},
	Service: ServiceConfig{
		UseApi: "",
		Where:  "",
	},
	SMTP: SMTPConfig{
		BlackList: "",
		WhiteList: "",
		Include:   "",
		Exclude:   "",
	},
	TextFile: TextFileConfig{
		TextFileDirectory: "",
	},
}

DefaultConfig holds the default settings for the windows_exporter integration.

Types

type Config

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

	Dfsr          DfsrConfig          `yaml:"dfsr,omitempty"`
	Exchange      ExchangeConfig      `yaml:"exchange,omitempty"`
	IIS           IISConfig           `yaml:"iis,omitempty"`
	TextFile      TextFileConfig      `yaml:"text_file,omitempty"`
	SMTP          SMTPConfig          `yaml:"smtp,omitempty"`
	Service       ServiceConfig       `yaml:"service,omitempty"`
	Process       ProcessConfig       `yaml:"process,omitempty"`
	Network       NetworkConfig       `yaml:"network,omitempty"`
	MSSQL         MSSQLConfig         `yaml:"mssql,omitempty"`
	MSMQ          MSMQConfig          `yaml:"msmq,omitempty"`
	LogicalDisk   LogicalDiskConfig   `yaml:"logical_disk,omitempty"`
	ScheduledTask ScheduledTaskConfig `yaml:"scheduled_task,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

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler for Config.

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 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 {
	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 MSMQConfig

type MSMQConfig struct {
	Where string `yaml:"where_clause,omitempty"`
}

MSMQConfig handles settings for the windows_exporter MSMQ collector

type MSSQLConfig

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

MSSQLConfig handles settings for the windows_exporter SQL server 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 ProcessConfig

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

ProcessConfig handles settings for the windows_exporter process collector

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 {
	UseApi string `yaml:"use_api,omitempty"`
	Where  string `yaml:"where_clause,omitempty"`
}

ServiceConfig handles settings for the windows_exporter service collector

type TextFileConfig

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

TextFileConfig handles settings for the windows_exporter Text File collector