check_service: make service filter case insensitive

Author: sni

Changes

@@ -6,7 +6,8 @@ next:
          - change like operator to be case insensitive
          - add new slike operator which is case sensitive
          - add support for str() operator
-         - check_process: make process filter is case insensitive
+         - check_process: make process filter case insensitive
+         - check_service: make service filter case insensitive
 
 0.31     Wed Feb 12 18:14:54 CET 2025
          - fix check_files thresholds on total_size

docs/checks/commands/check_service_linux.md

@@ -67,10 +67,10 @@ Naemon Config
 
 ## Check Specific Arguments
 
-| Argument | Description                                                                        |
-| -------- | ---------------------------------------------------------------------------------- |
-| exclude  | List of services to exclude from the check (mainly used when service is set to \*) |
-| service  | Name of the service to check (set to \* to check all services). Default: \*        |
+| Argument | Description                                                                                           |
+| -------- | ----------------------------------------------------------------------------------------------------- |
+| exclude  | List of services to exclude from the check (mainly used when service is set to \*) (case insensitive) |
+| service  | Name of the service to check (set to \* to check all services). (case insensitive) Default: \*        |
 
 ## Attributes
 

docs/checks/commands/check_service_windows.md

@@ -63,10 +63,10 @@ Naemon Config
 
 ## Check Specific Arguments
 
-| Argument | Description                                                                        |
-| -------- | ---------------------------------------------------------------------------------- |
-| exclude  | List of services to exclude from the check (mainly used when service is set to \*) |
-| service  | Name of the service to check (set to \* to check all services). Default: \*        |
+| Argument | Description                                                                                           |
+| -------- | ----------------------------------------------------------------------------------------------------- |
+| exclude  | List of services to exclude from the check (mainly used when service is set to \*) (case insensitive) |
+| service  | Name of the service to check (set to \* to check all services). (case insensitive) Default: \*        |
 
 ## Attributes
 

pkg/snclient/check_service_common.go

@@ -147,8 +147,8 @@ func (l *CheckService) addServiceMetrics(service string, serviceState float64, c
 }
 
 func (l *CheckService) isRequired(check *CheckData, entry map[string]string, services, excludes []string) bool {
-	name := entry["name"]
-	desc := entry["desc"]
+	name := strings.ToLower(entry["name"])
+	desc := strings.ToLower(entry["desc"])
 	if slices.Contains(excludes, name) || slices.Contains(excludes, desc) {
 		log.Tracef("service %s excluded by exclude list", name)
 
@@ -157,7 +157,11 @@ func (l *CheckService) isRequired(check *CheckData, entry map[string]string, ser
 	if slices.Contains(services, "*") {
 		return true
 	}
-	if len(services) > 0 && !slices.Contains(services, name) && !slices.Contains(services, desc) {
+
+	foundByName := slices.ContainsFunc(services, func(e string) bool { return strings.EqualFold(e, name) })
+	foundByDesc := slices.ContainsFunc(services, func(e string) bool { return strings.EqualFold(e, desc) })
+
+	if len(services) > 0 && !foundByName && !foundByDesc {
 		log.Tracef("service %s excluded by not matching service list", name)
 
 		return false

pkg/snclient/check_service_linux.go

@@ -22,10 +22,12 @@ var (
 	reSvcStatic    = regexp.MustCompile(`;\sstatic\)`)
 	reSvcActive    = regexp.MustCompile(`\s*Active:\s+(\S+)`)
 	reSvcFirstLine = regexp.MustCompile(`^.\s(\S+)\.service\s+`)
+	reSvcNameLine  = regexp.MustCompile(`^\s*(\S+)\.service\s+`)
 )
 
 const (
 	systemctlStatusCmd = "systemctl status --lines=0 --no-pager --quiet"
+	systemctlNames     = "systemctl list-units --lines=0 --no-pager --quiet --no-legend"
 )
 
 type CheckService struct {
@@ -61,10 +63,10 @@ There is a specific [check_service for windows](../check_service_windows) as wel
 			"service": {
 				value:           &l.services,
 				isFilter:        true,
-				description:     "Name of the service to check (set to * to check all services). Default: *",
+				description:     "Name of the service to check (set to * to check all services). (case insensitive) Default: *",
 				defaultCritical: stateCondition,
 			},
-			"exclude": {value: &l.excludes, description: "List of services to exclude from the check (mainly used when service is set to *)"},
+			"exclude": {value: &l.excludes, description: "List of services to exclude from the check (mainly used when service is set to *) (case insensitive)"},
 		},
 		defaultFilter:   "active != inactive",
 		defaultCritical: stateCondition + " && preset != 'disabled'",
@@ -111,6 +113,11 @@ Check memory usage of specific service:
 func (l *CheckService) Check(ctx context.Context, snc *Agent, check *CheckData, _ []Argument) (*CheckResult, error) {
 	l.snc = snc
 
+	// make excludes case insensitive
+	for i := range l.excludes {
+		l.excludes[i] = strings.ToLower(l.excludes[i])
+	}
+
 	if len(l.services) == 0 || slices.Contains(l.services, "*") {
 		// fetch status of all services at once instead of calling systemctl over and over
 		output, stderr, _, err := snc.execCommand(ctx, fmt.Sprintf("%s --type=service --all", systemctlStatusCmd), DefaultCmdTimeout)
@@ -131,7 +138,7 @@ func (l *CheckService) Check(ctx context.Context, snc *Agent, check *CheckData,
 		}
 		found := false
 		for _, e := range check.listData {
-			if e["name"] == service {
+			if strings.EqualFold(e["name"], service) {
 				found = true
 
 				break
@@ -156,6 +163,20 @@ func (l *CheckService) Check(ctx context.Context, snc *Agent, check *CheckData,
 }
 
 func (l *CheckService) addServiceByName(ctx context.Context, check *CheckData, service string, services, excludes []string) error {
+	err := l.addServiceByExactName(ctx, check, service, services, excludes)
+	if err == nil {
+		return nil
+	}
+
+	realService := l.findServiceByName(ctx, service)
+	if realService == "" {
+		return err
+	}
+
+	return l.addServiceByExactName(ctx, check, realService, services, excludes)
+}
+
+func (l *CheckService) addServiceByExactName(ctx context.Context, check *CheckData, service string, services, excludes []string) error {
 	output, stderr, _, err := l.snc.execCommand(ctx, fmt.Sprintf("%s %s.service ", systemctlStatusCmd, service), DefaultCmdTimeout)
 	if err != nil {
 		return fmt.Errorf("systemctl failed: %s\n%s", err.Error(), stderr)
@@ -307,7 +328,7 @@ func (l *CheckService) parseAllServices(ctx context.Context, check *CheckData, o
 		}
 		service := serviceMatches[1]
 
-		if slices.Contains(l.excludes, service) {
+		if slices.Contains(l.excludes, strings.ToLower(service)) {
 			log.Tracef("service %s excluded by 'exclude' argument", service)
 
 			continue
@@ -322,3 +343,25 @@ func (l *CheckService) parseAllServices(ctx context.Context, check *CheckData, o
 
 	return nil
 }
+
+func (l *CheckService) findServiceByName(ctx context.Context, service string) (name string) {
+	output, _, _, err := l.snc.execCommand(ctx, systemctlNames, DefaultCmdTimeout)
+	if err != nil {
+		log.Tracef("systemctl failed: %s", err.Error())
+
+		return ""
+	}
+
+	services := strings.Split(output, "\n")
+	for _, svc := range services {
+		match := reSvcNameLine.FindStringSubmatch(svc)
+		if len(match) > 1 {
+			realService := strings.TrimSpace(match[1])
+			if strings.EqualFold(realService, service) {
+				return realService
+			}
+		}
+	}
+
+	return ("")
+}

pkg/snclient/check_service_windows.go

@@ -58,11 +58,11 @@ There is a specific [check_service for linux](../check_service_linux) as well.`,
 			"service": {
 				value:           &l.services,
 				isFilter:        true,
-				description:     "Name of the service to check (set to * to check all services). Default: *",
+				description:     "Name of the service to check (set to * to check all services). (case insensitive) Default: *",
 				defaultWarning:  "state != 'running'",
 				defaultCritical: "state != 'running'",
 			},
-			"exclude": {value: &l.excludes, description: "List of services to exclude from the check (mainly used when service is set to *)"},
+			"exclude": {value: &l.excludes, description: "List of services to exclude from the check (mainly used when service is set to *) (case insensitive)"},
 		},
 		defaultFilter:   "none",
 		defaultCritical: "state != 'running' && start_type = 'auto'",
@@ -137,7 +137,7 @@ func (l *CheckService) Check(ctx context.Context, _ *Agent, check *CheckData, _
 		}
 
 		for _, service := range serviceList {
-			if slices.Contains(l.excludes, strings.TrimSpace(service)) {
+			if slices.Contains(l.excludes, strings.ToLower(strings.TrimSpace(service))) {
 				log.Tracef("service %s excluded by 'exclude' argument", service)
 
 				continue
@@ -157,7 +157,7 @@ func (l *CheckService) Check(ctx context.Context, _ *Agent, check *CheckData, _
 		}
 		found := false
 		for _, e := range check.listData {
-			if e["name"] == service || e["desc"] == service {
+			if strings.EqualFold(e["name"], service) || strings.EqualFold(e["desc"], service) {
 				found = true
 
 				break
@@ -361,7 +361,10 @@ func (l *CheckService) GetNameByDisplayName(name string) (string, error) {
 	}
 
 	for _, s := range l.AllServices {
-		if s.DisplayName == name {
+		if strings.EqualFold(s.DisplayName, name) {
+			return s.Name, nil
+		}
+		if strings.EqualFold(s.Name, name) {
 			return s.Name, nil
 		}
 	}

pkg/snclient/check_service_windows_test.go

@@ -24,4 +24,9 @@ func TestCheckService(t *testing.T) {
 	res = snc.RunCheck("check_service", []string{"service=Server"})
 	assert.Equalf(t, CheckExitOK, res.State, "state OK")
 	assert.Containsf(t, string(res.BuildPluginOutput()), "OK - All 1 service", "output matches")
+
+	// search service by non case name
+	res = snc.RunCheck("check_service", []string{"service=server"})
+	assert.Equalf(t, CheckExitOK, res.State, "state OK")
+	assert.Containsf(t, string(res.BuildPluginOutput()), "OK - All 1 service", "output matches")
 }