service: Breaking split service collector into two separate collectors

Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>
prometheus-community · Aug 13, 2024 · 58e4de5 · 58e4de5
1 parent ca4ad46
commit 58e4de5
Show file tree

Hide file tree

Showing 9 changed files with 389 additions and 441 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ Name     | Description | Enabled by default
 [remote_fx](docs/collector.remote_fx.md) | RemoteFX protocol (RDP) metrics |
 [scheduled_task](docs/collector.scheduled_task.md) | Scheduled Tasks metrics |
 [service](docs/collector.service.md) | Service state metrics | &#10003;
+[service_info](docs/collector.service_info.md) | Service info metrics | &#10003;
 [smb](docs/collector.smb.md) | SMB Server |
 [smbclient](docs/collector.smbclient.md) | SMB Client |
 [smtp](docs/collector.smtp.md) | IIS SMTP Server |

diff --git a/docs/collector.service.md b/docs/collector.service.md
@@ -2,121 +2,22 @@
 
 The service collector exposes metrics about Windows Services
 
-The collector exists in 2 different version. Version 1 is using WMI to query all services and is able to provide additional
-information. Version 2 is a more efficient solution by directly connecting to the service manager, but is not able to
-provide additional information like `run_as` or start configuration
-
-## Flags
-
-### `--collector.service.services-where`
-
-A WMI filter on which services to include. Recommended to keep down number of returned metrics.
-
-Example: `--collector.service.services-where="Name='windows_exporter'"`
-
-Example config win_exporter.yml for multiple services: `services-where: Name='SQLServer' OR Name='Couchbase' OR Name='Spooler' OR Name='ActiveMQ'`
-
-### `--collector.service.use-api`
-
-Uses API calls instead of WMI for performance optimization. **Note** the previous flag (`--collector.service.services-where`) won't have any effect on this mode.
-
-### `--collector.service.v2`
-
-Version 2 of the service collector. Is using API calls for performance optimization. **Note** the previous flag (`--collector.service.services-where`) won't have any effect on this mode.
-For additional performance reasons, it doesn't provide any additional information like `run_as` or start configuration.
-
-# collector V1
-
-|||
--|-
-Metric name prefix  | `service`
-Classes             | [`Win32_Service`](https://msdn.microsoft.com/en-us/library/aa394418(v=vs.85).aspx)
-Enabled by default? | Yes
-
-## Metrics
-
-Name | Description | Type | Labels
------|-------------|------|-------
-`windows_service_info` | Contains service information in labels, constant 1 | gauge | name, display_name, process_id, run_as
-`windows_service_state` | The state of the service, 1 if the current state, 0 otherwise | gauge | name, state
-`windows_service_start_mode` | The start mode of the service, 1 if the current start mode, 0 otherwise | gauge | name, start_mode
-`windows_service_status` | The status of the service, 1 if the current status, 0 otherwise | gauge | name, status
-
-For the values of the `state`, `start_mode`, `status` and `run_as` labels, see below.
-
-### States
-
-A service can be in the following states:
-- `stopped`
-- `start pending`
-- `stop pending`
-- `running`
-- `continue pending`
-- `pause pending`
-- `paused`
-- `unknown`
-
-### Start modes
-
-A service can have the following start modes:
-- `boot`
-- `system`
-- `auto`
-- `manual`
-- `disabled`
-
-### Status (not available in API mode)
-
-A service can have any of the following statuses:
-- `ok`
-- `error`
-- `degraded`
-- `unknown`
-- `pred fail`
-- `starting`
-- `stopping`
-- `service`
-- `stressed`
-- `nonrecover`
-- `no contact`
-- `lost comm`
-
-Note that there is some overlap with service state.
-
-### Run As
-
-Account name under which a service runs. Depending on the service type, the account name may be in the form of "DomainName\Username" or UPN format ("Username@DomainName").
-
-It corresponds to the `StartName` attribute of the `Win32_Service` class.
-`StartName` attribute can be NULL and in such case the label is reported as an empty string. Notice that if the attribute is NULL the service is logged on as the `LocalSystem` account or, for kernel or system-level drive, it runs with a default object name created by the I/O system based on the service name, for example, DWDOM\Admin.
-
-### Example metric
-Lists the services that have a 'disabled' start mode.
-```
-windows_service_start_mode{exported_name=~"(mssqlserver|sqlserveragent)",start_mode="disabled"}
-```
-
-## Useful queries
-Counts the number of Microsoft SQL Server/Agent Processes
-```
-count(windows_service_state{exported_name=~"(sqlserveragent|mssqlserver)",state="running"})
-```
-
-# collector V2
-
-
 |||
 -|-
 Metric name prefix  | `service`
 Classes             | none
 Enabled by default? | No
 
+## Flags
+
+None
 
 ## Metrics
 
-Name | Description | Type | Labels
------|-------------|------|-------
-`windows_service_state` | The state of the service, 1 if the current state, 0 otherwise | gauge | name, display_name, state
+| Name                         | Description                                                          | Type  | Labels                    |
+|------------------------------|----------------------------------------------------------------------|-------|---------------------------|
+| `windows_service_state`      | The state of the service, 1 if the current state, 0 otherwise        | gauge | name, display_name, state |
+| `windows_service_process_id` | Contains the process_id of the service process in labels, constant 1 | gauge | name, process_id          |
 
 ### States
 

diff --git a/docs/collector.service_info.md b/docs/collector.service_info.md
@@ -0,0 +1,68 @@
+# service collector
+
+The service collector exposes information as metrics about Windows Services
+
+|||
+-|-
+Metric name prefix  | `service_info`
+Classes             | -
+Enabled by default? | Yes
+
+
+
+## Flags
+
+None
+
+## Metrics
+
+| Name                              | Description                                                             | Type  | Labels           |
+|-----------------------------------|-------------------------------------------------------------------------|-------|------------------|
+| `windows_service_info_run_as`     | Contains service information run as user in labels, constant 1          | gauge | name, run_as     |
+| `windows_service_info_start_mode` | The start mode of the service, 1 if the current start mode, 0 otherwise | gauge | name, start_mode |
+
+For the values of the `start_mode`, `status` and `run_as` labels, see below.
+
+
+### Start modes
+
+A service can have the following start modes:
+- `boot`
+- `system`
+- `auto`
+- `manual`
+- `disabled`
+
+Note that there is some overlap with service state.
+
+### Run As
+
+Account name under which a service runs. Depending on the service type, the account name may be in the form of "DomainName\Username" or UPN format ("Username@DomainName").
+
+
+### Example metric
+
+```
+# HELP windows_service_info_run_as The start mode of the service (StartMode)
+# TYPE windows_service_info_run_as gauge
+windows_service_info_run_as{name="AGSService",run_as="LocalSystem"} 1
+windows_service_info_run_as{name="AJRouter",run_as="NT AUTHORITY\\LocalService"} 1
+windows_service_info_run_as{name="ALG",run_as="NT AUTHORITY\\LocalService"} 1
+# HELP windows_service_info_start_mode The start mode of the service (StartMode)
+# TYPE windows_service_info_start_mode gauge
+windows_service_info_start_mode{name="AGSService",start_mode="auto"} 0
+windows_service_info_start_mode{name="AGSService",start_mode="boot"} 0
+windows_service_info_start_mode{name="AGSService",start_mode="disabled"} 1
+windows_service_info_start_mode{name="AGSService",start_mode="manual"} 0
+windows_service_info_start_mode{name="AGSService",start_mode="system"} 0
+windows_service_info_start_mode{name="AJRouter",start_mode="auto"} 0
+windows_service_info_start_mode{name="AJRouter",start_mode="boot"} 0
+windows_service_info_start_mode{name="AJRouter",start_mode="disabled"} 0
+windows_service_info_start_mode{name="AJRouter",start_mode="manual"} 1
+windows_service_info_start_mode{name="AJRouter",start_mode="system"} 0
+windows_service_info_start_mode{name="ALG",start_mode="auto"} 0
+windows_service_info_start_mode{name="ALG",start_mode="boot"} 0
+windows_service_info_start_mode{name="ALG",start_mode="disabled"} 0
+windows_service_info_start_mode{name="ALG",start_mode="manual"} 1
+windows_service_info_start_mode{name="ALG",start_mode="system"} 0   
+```
diff --git a/pkg/collector/collector.go b/pkg/collector/collector.go
@@ -53,6 +53,7 @@ import (
 	"github.com/prometheus-community/windows_exporter/pkg/collector/remote_fx"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/scheduled_task"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/service"
+	"github.com/prometheus-community/windows_exporter/pkg/collector/service_info"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smb"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smbclient"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smtp"
@@ -135,6 +136,7 @@ func NewWithConfig(logger log.Logger, config Config) Collectors {
 	collectors[remote_fx.Name] = remote_fx.New(logger, &config.RemoteFx)
 	collectors[scheduled_task.Name] = scheduled_task.New(logger, &config.ScheduledTask)
 	collectors[service.Name] = service.New(logger, &config.Service)
+	collectors[service_info.Name] = service_info.New(logger, &config.ServiceInfo)
 	collectors[smb.Name] = smb.New(logger, &config.SMB)
 	collectors[smbclient.Name] = smbclient.New(logger, &config.SMBClient)
 	collectors[smtp.Name] = smtp.New(logger, &config.SMTP)

diff --git a/pkg/collector/config.go b/pkg/collector/config.go
@@ -45,6 +45,7 @@ import (
 	"github.com/prometheus-community/windows_exporter/pkg/collector/remote_fx"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/scheduled_task"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/service"
+	"github.com/prometheus-community/windows_exporter/pkg/collector/service_info"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smb"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smbclient"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smtp"
@@ -104,6 +105,7 @@ type Config struct {
 	RemoteFx                       remote_fx.Config                       `yaml:"remote_fx"`
 	ScheduledTask                  scheduled_task.Config                  `yaml:"scheduled_task"`
 	Service                        service.Config                         `yaml:"service"`
+	ServiceInfo                    service_info.Config                    `yaml:"service_info"`
 	SMB                            smb.Config                             `yaml:"smb"`
 	SMBClient                      smbclient.Config                       `yaml:"smbclient"` //nolint:tagliatelle
 	SMTP                           smtp.Config                            `yaml:"smtp"`
@@ -166,6 +168,7 @@ var ConfigDefaults = Config{
 	RemoteFx:                       remote_fx.ConfigDefaults,
 	ScheduledTask:                  scheduled_task.ConfigDefaults,
 	Service:                        service.ConfigDefaults,
+	ServiceInfo:                    service_info.ConfigDefaults,
 	SMB:                            smb.ConfigDefaults,
 	SMBClient:                      smbclient.ConfigDefaults,
 	SMTP:                           smtp.ConfigDefaults,

diff --git a/pkg/collector/map.go b/pkg/collector/map.go
@@ -45,6 +45,7 @@ import (
 	"github.com/prometheus-community/windows_exporter/pkg/collector/remote_fx"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/scheduled_task"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/service"
+	"github.com/prometheus-community/windows_exporter/pkg/collector/service_info"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smb"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smbclient"
 	"github.com/prometheus-community/windows_exporter/pkg/collector/smtp"
@@ -105,6 +106,7 @@ var BuildersWithFlags = map[string]BuilderWithFlags[Collector]{
 	remote_fx.Name:                       NewBuilderWithFlags(remote_fx.NewWithFlags),
 	scheduled_task.Name:                  NewBuilderWithFlags(scheduled_task.NewWithFlags),
 	service.Name:                         NewBuilderWithFlags(service.NewWithFlags),
+	service_info.Name:                    NewBuilderWithFlags(service_info.NewWithFlags),
 	smb.Name:                             NewBuilderWithFlags(smb.NewWithFlags),
 	smbclient.Name:                       NewBuilderWithFlags(smbclient.NewWithFlags),
 	smtp.Name:                            NewBuilderWithFlags(smtp.NewWithFlags),