exchange: enable all collectors as default (#1572)

Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>

config.yaml

@@ -0,0 +1,7 @@
+collectors:
+  enabled: cpu,cpu_info,cs,exchange,iis,logical_disk,logon,memory,net,os,process,remote_fx,service,system,tcp,time,terminal_services,textfile
+collector:
+  service:
+    services-where: "Name='windows_exporter'"
+log:
+  level: warn

docs/collector.time.md

@@ -5,11 +5,11 @@ If the Windows Time Service is stopped after collection has started, collector m
 
 Please note the Time Service perflib counters are only available on [Windows Server 2016 or newer](https://docs.microsoft.com/en-us/windows-server/networking/windows-time-service/windows-server-2016-improvements).
 
-|||
--|-
-Metric name prefix  | `time`
-Data source         | Perflib
-Enabled by default? | No
+|                     |         |
+|---------------------|---------|
+| Metric name prefix  | `time`  |
+| Data source         | Perflib |
+| Enabled by default? | No      |
 
 ## Flags
 
@@ -17,14 +17,14 @@ None
 
 ## Metrics
 
-Name | Description | Type | Labels
------|-------------|------|-------
-`windows_time_clock_frequency_Adjustment_ppb_total` | Total adjustment made to the local system clock frequency by W32Time in parts per billion (PPB) units. 1 PPB adjustment implies the system clock was adjusted at a rate of 1 nanosecond per second (1 ns/s). The smallest possible adjustment can vary and is expected to be in the order of 100's of PPB. | counter | None
-`windows_time_computed_time_offset_seconds` | Absolute time offset between the system clock and the chosen time source, in seconds. | counter | None
-`windows_time_ntp_client_time_sources` | Active number of NTP Time sources being used by the client. This is a count of active, distinct IP addresses of time servers that are responding to this client's requests. | gauge | None
-`windows_time_ntp_round_trip_delay_seconds` | Total roundtrip delay experienced by the NTP client in receiving a response from the server for the most recent request, in seconds. This is the time elapsed on the NTP client between transmitting a request to the NTP server and receiving a valid response from the server. | gauge | None
-`windows_time_ntp_server_outgoing_responses_total` | Total number of requests responded to by the NTP server. | counter | None
-`windows_time_ntp_server_incoming_requests_total` | Total number of requests received by the NTP server. | counter | None
+| Name                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Type    | Labels |
+|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------|
+| `windows_time_clock_frequency_adjustment_ppb_total` | Total adjustment made to the local system clock frequency by W32Time in parts per billion (PPB) units. 1 PPB adjustment implies the system clock was adjusted at a rate of 1 nanosecond per second (1 ns/s). The smallest possible adjustment can vary and is expected to be in the order of 100's of PPB.                                                                                                                                                                                                                                                                                                                                                                                                            | counter | None   |
+| `windows_time_computed_time_offset_seconds`         | The absolute time offset between the system clock and the chosen time source, as computed by the W32Time service in microseconds. When a new valid sample is available, the computed time is updated with the time offset indicated by the sample. This time is the actual time offset of the local clock. W32Time initiates clock correction by using this offset and updates the computed time in between samples with the remaining time offset that needs to be applied to the local clock. Clock accuracy can be tracked by using this performance counter with a low polling interval (for example, 256 seconds or less) and looking for the counter value to be smaller than the desired clock accuracy limit. | gauge   | None   |
+| `windows_time_ntp_client_time_sources`              | Active number of NTP Time sources being used by the client. This is a count of active, distinct IP addresses of time servers that are responding to this client's requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | gauge   | None   |
+| `windows_time_ntp_round_trip_delay_seconds`         | Total roundtrip delay experienced by the NTP client in receiving a response from the server for the most recent request, in seconds. This is the time elapsed on the NTP client between transmitting a request to the NTP server and receiving a valid response from the server.                                                                                                                                                                                                                                                                                                                                                                                                                                      | gauge   | None   |
+| `windows_time_ntp_server_outgoing_responses_total`  | Total number of requests responded to by the NTP server.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | counter | None   |
+| `windows_time_ntp_server_incoming_requests_total`   | Total number of requests received by the NTP server.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | counter | None   |
 
 ### Example metric
 _This collector does not yet have explained examples, we would appreciate your help adding them!_

go.mod

@@ -17,7 +17,7 @@ require (
 	github.com/yusufpapurcu/wmi v1.2.4
 	go.opencensus.io v0.24.0 // indirect
 	golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa
-	golang.org/x/sys v0.23.0
+	golang.org/x/sys v0.24.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 

go.sum

@@ -141,8 +141,8 @@ golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.23.0 h1:YfKFowiIMvtgl1UERQoTPPToxltDeZfbj4H7dVUCwmM=
-golang.org/x/sys v0.23.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.24.0 h1:Twjiwq9dn6R1fQcyiK+wQyHWfaz/BJB+YIpzU/Cv3Xg=
+golang.org/x/sys v0.24.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=

pkg/collector/dfsr/dfsr.go

@@ -120,10 +120,17 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 	c := &Collector{
 		config: ConfigDefaults,
 	}
-	c.config.CollectorsEnabled = make([]string, 0)
+
+	var collectorsEnabled string
 
 	app.Flag("collectors.dfsr.sources-enabled", "Comma-separated list of DFSR Perflib sources to use.").
-		Default(strings.Join(ConfigDefaults.CollectorsEnabled, ",")).StringsVar(&c.config.CollectorsEnabled)
+		Default(strings.Join(ConfigDefaults.CollectorsEnabled, ",")).StringVar(&collectorsEnabled)
+
+	app.Action(func(*kingpin.ParseContext) error {
+		c.config.CollectorsEnabled = strings.Split(collectorsEnabled, ",")
+
+		return nil
+	})
 
 	return c
 }

pkg/collector/exchange/exchange.go

@@ -23,7 +23,18 @@ type Config struct {
 }
 
 var ConfigDefaults = Config{
-	CollectorsEnabled: []string{},
+	CollectorsEnabled: []string{
+		"ADAccessProcesses",
+		"TransportQueues",
+		"HttpProxy",
+		"ActiveSync",
+		"AvailabilityService",
+		"OutlookWebAccess",
+		"Autodiscover",
+		"WorkloadManagement",
+		"RpcClientAccess",
+		"MapiHttpEmsmdb",
+	},
 }
 
 type Collector struct {
@@ -72,20 +83,6 @@ type Collector struct {
 	enabledCollectors []string
 }
 
-// All available Collector functions.
-var exchangeAllCollectorNames = []string{
-	"ADAccessProcesses",
-	"TransportQueues",
-	"HttpProxy",
-	"ActiveSync",
-	"AvailabilityService",
-	"OutlookWebAccess",
-	"Autodiscover",
-	"WorkloadManagement",
-	"RpcClientAccess",
-	"MapiHttpEmsmdb",
-}
-
 func New(logger log.Logger, config *Config) *Collector {
 	if config == nil {
 		config = &ConfigDefaults
@@ -111,6 +108,7 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 	c.config.CollectorsEnabled = make([]string, 0)
 
 	var listAllCollectors bool
+	var collectorsEnabled string
 
 	app.Flag(
 		"collectors.exchange.list",
@@ -120,7 +118,7 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 	app.Flag(
 		"collectors.exchange.enabled",
 		"Comma-separated list of collectors to use. Defaults to all, if not specified.",
-	).Default(strings.Join(ConfigDefaults.CollectorsEnabled, ",")).StringsVar(&c.config.CollectorsEnabled)
+	).Default(strings.Join(ConfigDefaults.CollectorsEnabled, ",")).StringVar(&collectorsEnabled)
 
 	app.PreAction(func(*kingpin.ParseContext) error {
 		if listAllCollectors {
@@ -140,7 +138,7 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 			sb := strings.Builder{}
 			sb.WriteString(fmt.Sprintf("%-32s %-32s\n", "Collector Name", "[PerfID] Perflib Object"))
 
-			for _, cname := range exchangeAllCollectorNames {
+			for _, cname := range ConfigDefaults.CollectorsEnabled {
 				sb.WriteString(fmt.Sprintf("%-32s %-32s\n", cname, collectorDesc[cname]))
 			}
 
@@ -152,6 +150,12 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 		return nil
 	})
 
+	app.Action(func(*kingpin.ParseContext) error {
+		c.config.CollectorsEnabled = strings.Split(collectorsEnabled, ",")
+
+		return nil
+	})
+
 	return c
 }
 
@@ -232,22 +236,18 @@ func (c *Collector) Build() error {
 	c.syncCommandsPerSec = desc("activesync_sync_cmds_total", "Number of sync commands processed per second. Clients use this command to synchronize items within a folder")
 	c.activeUserCountMapiHttpEmsMDB = desc("mapihttp_emsmdb_active_user_count", "Number of unique outlook users that have shown some kind of activity in the last 2 minutes")
 
-	if len(c.config.CollectorsEnabled) == 0 {
-		c.enabledCollectors = exchangeAllCollectorNames
-	} else {
-		c.enabledCollectors = make([]string, 0, len(exchangeAllCollectorNames))
+	c.enabledCollectors = make([]string, 0, len(ConfigDefaults.CollectorsEnabled))
 
-		for _, collectorName := range c.config.CollectorsEnabled {
-			if !slices.Contains(exchangeAllCollectorNames, collectorName) {
-				return fmt.Errorf("unknown exchange collector: %s", collectorName)
-			}
-
-			c.enabledCollectors = append(c.enabledCollectors, collectorName)
+	for _, collectorName := range c.config.CollectorsEnabled {
+		if !slices.Contains(ConfigDefaults.CollectorsEnabled, collectorName) {
+			return fmt.Errorf("unknown exchange collector: %s", collectorName)
 		}
 
-		c.enabledCollectors = slices.Clip(c.enabledCollectors)
+		c.enabledCollectors = append(c.enabledCollectors, collectorName)
 	}
 
+	c.enabledCollectors = slices.Clip(c.enabledCollectors)
+
 	return nil
 }
 

pkg/collector/mssql/mssql.go

@@ -6,7 +6,6 @@ import (
 	"errors"
 	"fmt"
 	"os"
-	"slices"
 	"sort"
 	"strings"
 	"sync"
@@ -437,9 +436,9 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 	c := &Collector{
 		config: ConfigDefaults,
 	}
-	c.config.CollectorsEnabled = make([]string, 0)
 
 	var listAllCollectors bool
+	var collectorsEnabled string
 
 	app.Flag(
 		"collectors.mssql.class-print",
@@ -449,7 +448,7 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 	app.Flag(
 		"collectors.mssql.classes-enabled",
 		"Comma-separated list of mssql WMI classes to use.",
-	).Default(strings.Join(ConfigDefaults.CollectorsEnabled, ",")).StringsVar(&c.config.CollectorsEnabled)
+	).Default(strings.Join(c.config.CollectorsEnabled, ",")).StringVar(&collectorsEnabled)
 
 	app.PreAction(func(*kingpin.ParseContext) error {
 		if listAllCollectors {
@@ -468,6 +467,12 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 		return nil
 	})
 
+	app.Action(func(*kingpin.ParseContext) error {
+		c.config.CollectorsEnabled = strings.Split(collectorsEnabled, ",")
+
+		return nil
+	})
+
 	return c
 }
 
@@ -480,16 +485,11 @@ func (c *Collector) SetLogger(logger log.Logger) {
 }
 
 func (c *Collector) GetPerfCounter() ([]string, error) {
-	enabled := slices.Compact(c.config.CollectorsEnabled)
-
-	// Result must order, to prevent test failures.
-	sort.Strings(enabled)
-
 	c.mssqlInstances = getMSSQLInstances(c.logger)
-	perfCounters := make([]string, 0, len(c.mssqlInstances)*len(enabled))
+	perfCounters := make([]string, 0, len(c.mssqlInstances)*len(c.config.CollectorsEnabled))
 
 	for instance := range c.mssqlInstances {
-		for _, c := range enabled {
+		for _, c := range c.config.CollectorsEnabled {
 			perfCounters = append(perfCounters, mssqlGetPerfObjectName(instance, c))
 		}
 	}
@@ -502,6 +502,9 @@ func (c *Collector) Close() error {
 }
 
 func (c *Collector) Build() error {
+	// Result must order, to prevent test failures.
+	sort.Strings(c.config.CollectorsEnabled)
+
 	// meta
 	c.mssqlScrapeDurationDesc = prometheus.NewDesc(
 		prometheus.BuildFQName(types.Namespace, Name, "collector_duration_seconds"),
@@ -1965,6 +1968,12 @@ func (c *Collector) Build() error {
 
 	c.mssqlCollectors = c.getMSSQLCollectors()
 
+	for _, name := range c.config.CollectorsEnabled {
+		if _, ok := c.mssqlCollectors[name]; !ok {
+			return errors.New("unknown mssql collector: " + name)
+		}
+	}
+
 	return nil
 }
 
@@ -2007,13 +2016,8 @@ func (c *Collector) execute(ctx *types.ScrapeContext, name string, fn mssqlColle
 func (c *Collector) Collect(ctx *types.ScrapeContext, ch chan<- prometheus.Metric) error {
 	wg := sync.WaitGroup{}
 
-	enabled := slices.Compact(c.config.CollectorsEnabled)
-
-	// Result must order, to prevent test failures.
-	sort.Strings(enabled)
-
 	for sqlInstance := range c.mssqlInstances {
-		for _, name := range enabled {
+		for _, name := range c.config.CollectorsEnabled {
 			function := c.mssqlCollectors[name]
 
 			wg.Add(1)

pkg/collector/textfile/textfile.go

@@ -78,12 +78,19 @@ func NewWithFlags(app *kingpin.Application) *Collector {
 	c := &Collector{
 		config: ConfigDefaults,
 	}
-	c.config.TextFileDirectories = make([]string, 0)
+
+	var textFileDirectories string
 
 	app.Flag(
 		"collector.textfile.directories",
 		"Directory or Directories to read text files with metrics from.",
-	).Default(strings.Join(ConfigDefaults.TextFileDirectories, ",")).StringsVar(&c.config.TextFileDirectories)
+	).Default(strings.Join(ConfigDefaults.TextFileDirectories, ",")).StringVar(&textFileDirectories)
+
+	app.Action(func(*kingpin.ParseContext) error {
+		c.config.TextFileDirectories = strings.Split(textFileDirectories, ",")
+
+		return nil
+	})
 
 	return c
 }