check_logfile: empty state is unknown, conditionally set to 0 if files exist without matched lines

checkdata.finalizeOutput() requires explicit filters or implicit argument filters to apply emptySyntax on output. apply empty syntax on empty state, by setting the "file" and files" argument is set as a filter.

Author: Ahmet Oeztuerk

docs/checks/commands/check_logfile.md

@@ -58,7 +58,7 @@ Naemon Config
 
 | Argument      | Default Value                                                          |
 | ------------- | ---------------------------------------------------------------------- |
-| empty-state   | 0 (OK)                                                                 |
+| empty-state   | 3 (UNKNOWN)                                                            |
 | empty-syntax  | %(status) - No files found                                             |
 | top-syntax    | %(status) - %(problem_count)/%(count) lines (%(count)) %(problem_list) |
 | ok-syntax     | %(status) - All %(count) / %(total) Lines OK                           |

pkg/snclient/check_logfile.go

@@ -67,10 +67,10 @@ func (c *CheckLogFile) Build() *CheckData {
 		okSyntax:     "%(status) - All %(count) / %(total) Lines OK",
 		topSyntax:    "%(status) - %(problem_count)/%(count) lines (%(count)) %(problem_list)",
 		emptySyntax:  "%(status) - No files found",
-		emptyState:   CheckExitOK,
+		emptyState:   CheckExitUnknown,
 		args: map[string]CheckArgument{
-			"file":         {value: &c.FilePathPatterns, description: "The file that should be checked"},
-			"files":        {value: &c.FilePathPatternsCS, description: "Comma separated list of files"},
+			"file":         {value: &c.FilePathPatterns, description: "The file that should be checked", isFilter: true},
+			"files":        {value: &c.FilePathPatternsCS, description: "Comma separated list of files", isFilter: true},
 			"offset":       {value: &c.Offset, description: "Starting position (in bytes) for scanning the file (0 for beginning). This overrides any saved offset"},
 			"line-split":   {value: &c.LineDelimiter, description: "Character string used to split a file into several lines (default \\n)"},
 			"column-split": {value: &c.ColumnDelimiter, description: "Tab split default: \\t"},
@@ -167,10 +167,11 @@ func (c *CheckLogFile) Check(_ context.Context, snc *Agent, check *CheckData, _
 	}
 
 	if len(checkedFilesWithMatchedEntries) == 0 {
-		check.okSyntax = "%(status) - No files found to search lines in"
+		check.emptySyntax = fmt.Sprintf("%%(status) - No files found to search lines in, search paths: '%s' ", strings.Join(c.FilePathPatterns, ","))
 	} else if len(check.listData) == 0 {
-		check.emptySyntax = fmt.Sprintf("%%(status) - No matching lines found in files (%s)", check.details["file_counts"])
+		check.emptyState = CheckExitOK
 		check.emptyStateSet = true
+		check.emptySyntax = fmt.Sprintf("%%(status) - No matching lines found in files (%s)", check.details["file_counts"])
 	}
 
 	return check.Finalize()

pkg/snclient/check_logfile_test.go

@@ -52,7 +52,7 @@ func TestCheckLogFilePathWildCards(t *testing.T) {
 
 	res = snc.RunCheck("check_logfile", []string{"files=./t/test*", "warn=line LIKE WARNING"})
 	assert.Equalf(t, CheckExitOK, res.State, "state OK")
-	assert.Contains(t, string(res.BuildPluginOutput()), "OK - All 0 / 0")
+	assert.Contains(t, string(res.BuildPluginOutput()), "OK - No matching lines found in files ")
 
 	StopTestAgent(t, snc)
 }
@@ -131,8 +131,8 @@ func TestCheckLogFileFileDoesNotExist(t *testing.T) {
 	snc := StartTestAgent(t, testLogfileConfig)
 
 	res := snc.RunCheck("check_logfile", []string{"files=./t/testfiledoesnotexist*"})
-	assert.Equalf(t, CheckExitOK, res.State, "state should be OK")
-	assert.Contains(t, string(res.BuildPluginOutput()), "OK - No files found to search lines in")
+	assert.Equalf(t, CheckExitUnknown, res.State, "state should be UNKNOWN")
+	assert.Contains(t, string(res.BuildPluginOutput()), "UNKNOWN - No files found to search lines in")
 
 	StopTestAgent(t, snc)
 }