windows

Documentation

Index

• Variables
• type Arguments
  • func (a *Arguments) Convert() *windows_integration.Config
  • func (a *Arguments) SetToDefault()
• type DfsrConfig
  • func (t DfsrConfig) Convert() windows_integration.DfsrConfig
• type ExchangeConfig
  • func (t ExchangeConfig) Convert() windows_integration.ExchangeConfig
• type IISConfig
  • func (t IISConfig) Convert() windows_integration.IISConfig
• type LogicalDiskConfig
  • func (t LogicalDiskConfig) Convert() windows_integration.LogicalDiskConfig
• type MSMQConfig
  • func (t MSMQConfig) Convert() windows_integration.MSMQConfig
• type MSSQLConfig
  • func (t MSSQLConfig) Convert() windows_integration.MSSQLConfig
• type NetworkConfig
  • func (t NetworkConfig) Convert() windows_integration.NetworkConfig
• type ProcessConfig
  • func (t ProcessConfig) Convert() windows_integration.ProcessConfig
• type SMTPConfig
  • func (t SMTPConfig) Convert() windows_integration.SMTPConfig
• type ScheduledTaskConfig
  • func (t ScheduledTaskConfig) Convert() windows_integration.ScheduledTaskConfig
• type ServiceConfig
  • func (t ServiceConfig) Convert() windows_integration.ServiceConfig
• type TextFileConfig
  • func (t TextFileConfig) Convert() windows_integration.TextFileConfig

Variables

var DefaultArguments = Arguments{
	EnabledCollectors: strings.Split(windows_integration.DefaultConfig.EnabledCollectors, ","),
	Dfsr: DfsrConfig{
		SourcesEnabled: strings.Split(windows_integration.DefaultConfig.Dfsr.SourcesEnabled, ","),
	},
	Exchange: ExchangeConfig{
		EnabledList: strings.Split(windows_integration.DefaultConfig.Exchange.EnabledList, ","),
	},
	IIS: IISConfig{
		AppBlackList:  windows_integration.DefaultConfig.IIS.AppBlackList,
		AppWhiteList:  windows_integration.DefaultConfig.IIS.AppWhiteList,
		SiteBlackList: windows_integration.DefaultConfig.IIS.SiteBlackList,
		SiteWhiteList: windows_integration.DefaultConfig.IIS.SiteWhiteList,
		AppInclude:    windows_integration.DefaultConfig.IIS.AppInclude,
		AppExclude:    windows_integration.DefaultConfig.IIS.AppExclude,
		SiteInclude:   windows_integration.DefaultConfig.IIS.SiteInclude,
		SiteExclude:   windows_integration.DefaultConfig.IIS.SiteExclude,
	},
	LogicalDisk: LogicalDiskConfig{
		BlackList: windows_integration.DefaultConfig.LogicalDisk.BlackList,
		WhiteList: windows_integration.DefaultConfig.LogicalDisk.WhiteList,
		Include:   windows_integration.DefaultConfig.LogicalDisk.Include,
		Exclude:   windows_integration.DefaultConfig.LogicalDisk.Exclude,
	},
	MSMQ: MSMQConfig{
		Where: windows_integration.DefaultConfig.MSMQ.Where,
	},
	MSSQL: MSSQLConfig{
		EnabledClasses: strings.Split(windows_integration.DefaultConfig.MSSQL.EnabledClasses, ","),
	},
	Network: NetworkConfig{
		BlackList: windows_integration.DefaultConfig.Network.BlackList,
		WhiteList: windows_integration.DefaultConfig.Network.WhiteList,
		Include:   windows_integration.DefaultConfig.Network.Include,
		Exclude:   windows_integration.DefaultConfig.Network.Exclude,
	},
	Process: ProcessConfig{
		BlackList: windows_integration.DefaultConfig.Process.BlackList,
		WhiteList: windows_integration.DefaultConfig.Process.WhiteList,
		Include:   windows_integration.DefaultConfig.Process.Include,
		Exclude:   windows_integration.DefaultConfig.Process.Exclude,
	},
	ScheduledTask: ScheduledTaskConfig{
		Include: windows_integration.DefaultConfig.ScheduledTask.Include,
		Exclude: windows_integration.DefaultConfig.ScheduledTask.Exclude,
	},
	Service: ServiceConfig{
		UseApi: windows_integration.DefaultConfig.Service.UseApi,
		Where:  windows_integration.DefaultConfig.Service.Where,
	},
	SMTP: SMTPConfig{
		BlackList: windows_integration.DefaultConfig.SMTP.BlackList,
		WhiteList: windows_integration.DefaultConfig.SMTP.WhiteList,
		Include:   windows_integration.DefaultConfig.SMTP.Include,
		Exclude:   windows_integration.DefaultConfig.SMTP.Exclude,
	},
	TextFile: TextFileConfig{
		TextFileDirectory: windows_integration.DefaultConfig.TextFile.TextFileDirectory,
	},
}

Types

type Arguments

type Arguments struct {
	// Collectors to mark as enabled
	EnabledCollectors []string `river:"enabled_collectors,attr,optional"`

	// Collector-specific config options
	Dfsr          DfsrConfig          `river:"dfsr,block,optional"`
	Exchange      ExchangeConfig      `river:"exchange,block,optional"`
	IIS           IISConfig           `river:"iis,block,optional"`
	LogicalDisk   LogicalDiskConfig   `river:"logical_disk,block,optional"`
	MSMQ          MSMQConfig          `river:"msmq,block,optional"`
	MSSQL         MSSQLConfig         `river:"mssql,block,optional"`
	Network       NetworkConfig       `river:"network,block,optional"`
	Process       ProcessConfig       `river:"process,block,optional"`
	ScheduledTask ScheduledTaskConfig `river:"scheduled_task,block,optional"`
	Service       ServiceConfig       `river:"service,block,optional"`
	SMTP          SMTPConfig          `river:"smtp,block,optional"`
	TextFile      TextFileConfig      `river:"text_file,block,optional"`
}

Arguments is used for controlling for this exporter.

func (*Arguments) Convert

func (a *Arguments) Convert() *windows_integration.Config

Convert converts the component's Arguments to the integration's Config.

func (*Arguments) SetToDefault

func (a *Arguments) SetToDefault()

SetToDefault implements river.Defaulter.

type DfsrConfig

type DfsrConfig struct {
	SourcesEnabled []string `river:"sources_enabled,attr,optional"`
}

DfsrConfig handles settings for the windows_exporter Exchange collector

func (DfsrConfig) Convert

func (t DfsrConfig) Convert() windows_integration.DfsrConfig

Convert converts the component's DfsrConfig to the integration's ExchangeConfig.

type ExchangeConfig

type ExchangeConfig struct {
	EnabledList []string `river:"enabled_list,attr,optional"`
}

ExchangeConfig handles settings for the windows_exporter Exchange collector

func (ExchangeConfig) Convert

func (t ExchangeConfig) Convert() windows_integration.ExchangeConfig

Convert converts the component's ExchangeConfig to the integration's ExchangeConfig.

type IISConfig

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

IISConfig handles settings for the windows_exporter IIS collector

func (IISConfig) Convert

func (t IISConfig) Convert() windows_integration.IISConfig

Convert converts the component's IISConfig to the integration's IISConfig.

type LogicalDiskConfig

type LogicalDiskConfig struct {
	BlackList string `river:"blacklist,attr,optional"`
	WhiteList string `river:"whitelist,attr,optional"`
	Include   string `river:"include,attr,optional"`
	Exclude   string `river:"exclude,attr,optional"`
}

LogicalDiskConfig handles settings for the windows_exporter logical disk collector

func (LogicalDiskConfig) Convert

func (t LogicalDiskConfig) Convert() windows_integration.LogicalDiskConfig

Convert converts the component's LogicalDiskConfig to the integration's LogicalDiskConfig.

type MSMQConfig

type MSMQConfig struct {
	Where string `river:"where_clause,attr,optional"`
}

MSMQConfig handles settings for the windows_exporter MSMQ collector

func (MSMQConfig) Convert

func (t MSMQConfig) Convert() windows_integration.MSMQConfig

Convert converts the component's MSMQConfig to the integration's MSMQConfig.

type MSSQLConfig

type MSSQLConfig struct {
	EnabledClasses []string `river:"enabled_classes,attr,optional"`
}

MSSQLConfig handles settings for the windows_exporter SQL server collector

func (MSSQLConfig) Convert

func (t MSSQLConfig) Convert() windows_integration.MSSQLConfig

Convert converts the component's MSSQLConfig to the integration's MSSQLConfig.

type NetworkConfig

type NetworkConfig struct {
	BlackList string `river:"blacklist,attr,optional"`
	WhiteList string `river:"whitelist,attr,optional"`
	Exclude   string `river:"exclude,attr,optional"`
	Include   string `river:"include,attr,optional"`
}

NetworkConfig handles settings for the windows_exporter network collector

func (NetworkConfig) Convert

func (t NetworkConfig) Convert() windows_integration.NetworkConfig

Convert converts the component's NetworkConfig to the integration's NetworkConfig.

type ProcessConfig

type ProcessConfig struct {
	BlackList string `river:"blacklist,attr,optional"`
	WhiteList string `river:"whitelist,attr,optional"`
	Exclude   string `river:"exclude,attr,optional"`
	Include   string `river:"include,attr,optional"`
}

ProcessConfig handles settings for the windows_exporter process collector

func (ProcessConfig) Convert

func (t ProcessConfig) Convert() windows_integration.ProcessConfig

Convert converts the component's ProcessConfig to the integration's ProcessConfig.

type SMTPConfig

type SMTPConfig struct {
	BlackList string `river:"blacklist,attr,optional"`
	WhiteList string `river:"whitelist,attr,optional"`
	Exclude   string `river:"exclude,attr,optional"`
	Include   string `river:"include,attr,optional"`
}

SMTPConfig handles settings for the windows_exporter SMTP collector

func (SMTPConfig) Convert

func (t SMTPConfig) Convert() windows_integration.SMTPConfig

Convert converts the component's SMTPConfig to the integration's SMTPConfig.

type ScheduledTaskConfig

type ScheduledTaskConfig struct {
	Exclude string `river:"exclude,attr,optional"`
	Include string `river:"include,attr,optional"`
}

ScheduledTaskConfig handles settings for the windows_exporter process collector

func (ScheduledTaskConfig) Convert

func (t ScheduledTaskConfig) Convert() windows_integration.ScheduledTaskConfig

Convert converts the component's ScheduledTaskConfig to the integration's ScheduledTaskConfig.

type ServiceConfig

type ServiceConfig struct {
	UseApi string `river:"use_api,attr,optional"`
	Where  string `river:"where_clause,attr,optional"`
}

ServiceConfig handles settings for the windows_exporter service collector

func (ServiceConfig) Convert

func (t ServiceConfig) Convert() windows_integration.ServiceConfig

Convert converts the component's ServiceConfig to the integration's ServiceConfig.

type TextFileConfig

type TextFileConfig struct {
	TextFileDirectory string `river:"text_file_directory,attr,optional"`
}

TextFileConfig handles settings for the windows_exporter Text File collector

func (TextFileConfig) Convert

func (t TextFileConfig) Convert() windows_integration.TextFileConfig

Convert converts the component's TextFileConfig to the integration's TextFileConfig.