diff --git a/docs/checks/commands/check_logfile.md b/docs/checks/commands/check_logfile.md index 7e7f70e5..454fba1d 100644 --- a/docs/checks/commands/check_logfile.md +++ b/docs/checks/commands/check_logfile.md @@ -5,9 +5,9 @@ comment: auto-generated by make docs, do not edit Checks logfiles or any other text format file for errors or other general patterns -In order to use this plugin, you need to enable 'CheckLogFile' in the '[/modules]' section of the snclient_local.ini. +In order to use this plugin, you need to enable CheckLogFile in the [/modules] section of the snclient_local.ini. -Also, to avoid security issues, you need to set 'allowed pattern' in the '[/settings/check/logfile]' +Also, to avoid security issues, you need to set allowed pattern in the [/settings/check/logfile] section of the snclient_local.ini to a comma separated list of allowed glob patterns. Example: diff --git a/docs/checks/commands/check_multi.md b/docs/checks/commands/check_multi.md index d5eae22b..b8dca449 100644 --- a/docs/checks/commands/check_multi.md +++ b/docs/checks/commands/check_multi.md @@ -5,11 +5,11 @@ comment: auto-generated by make docs, do not edit Runs multiple checks and aggregates their status, output and performance data. -By default 'CheckMulti' is enabled, but you can disable it in the '[/modules]' section of the snclient_local.ini. -You can also set 'max checks' in the '[/settings/check/multi]' section of the snclient_local.ini, which limits +By default CheckMulti is enabled, but you can disable it in the [/modules] section of the snclient_local.ini. +You can also set max checks in the [/settings/check/multi] section of the snclient_local.ini, which limits the number of checks that can be configured. -When using the inline mode, you can only use available commands (run 'check_index' to get a full list). +When using the inline mode, you can only use available commands (run check_index to get a full list). You can also define custom check sections in the config file, for example: @@ -17,7 +17,7 @@ You can also define custom check sections in the config file, for example: command[alias1] = check_process process=123 command[alias2] = check_process process=345 -This can be executed with 'check_multi "config=mycheck"'. +This can be executed with check_multi "config=mycheck". It's also possible to use custom scripts in the config section, for example: @@ -26,7 +26,7 @@ It's also possible to use custom scripts in the config section, for example: command[alias2] = /path/to/plugin2 command[alias3] = /path/to/plugin3 -This can be executed with 'check_multi "config=myscript"'. +This can be executed with check_multi "config=myscript". - [Argument Defaults](#argument-defaults) - [Attributes](#attributes) diff --git a/docs/checks/commands/check_wmi.md b/docs/checks/commands/check_wmi.md index 10d9c5a7..205693b3 100644 --- a/docs/checks/commands/check_wmi.md +++ b/docs/checks/commands/check_wmi.md @@ -5,7 +5,7 @@ comment: auto-generated by make docs, do not edit Check status and metrics by running WMI queries. -In order to use this plugin, you need to enable 'CheckWMI' in the '[/modules]' section of the snclient_local.ini. +In order to use this plugin, you need to enable CheckWMI in the [/modules] section of the snclient_local.ini. - [Argument Defaults](#argument-defaults) - [Examples](#examples) diff --git a/pkg/snclient/check_logfile.go b/pkg/snclient/check_logfile.go index 40a3683d..bea318d0 100644 --- a/pkg/snclient/check_logfile.go +++ b/pkg/snclient/check_logfile.go @@ -64,9 +64,9 @@ func (c *CheckLogFile) Build() *CheckData { name: "check_logfile", description: `Checks logfiles or any other text format file for errors or other general patterns -In order to use this plugin, you need to enable 'CheckLogFile' in the '[/modules]' section of the snclient_local.ini. +In order to use this plugin, you need to enable CheckLogFile in the [/modules] section of the snclient_local.ini. -Also, to avoid security issues, you need to set 'allowed pattern' in the '[/settings/check/logfile]' +Also, to avoid security issues, you need to set allowed pattern in the [/settings/check/logfile] section of the snclient_local.ini to a comma separated list of allowed glob patterns. Example: diff --git a/pkg/snclient/check_multi.go b/pkg/snclient/check_multi.go index bd9f1dc5..e1e9887e 100644 --- a/pkg/snclient/check_multi.go +++ b/pkg/snclient/check_multi.go @@ -68,11 +68,11 @@ func (l *CheckMulti) Build() *CheckData { name: "check_multi", description: `Runs multiple checks and aggregates their status, output and performance data. -By default 'CheckMulti' is enabled, but you can disable it in the '[/modules]' section of the snclient_local.ini. -You can also set 'max checks' in the '[/settings/check/multi]' section of the snclient_local.ini, which limits +By default CheckMulti is enabled, but you can disable it in the [/modules] section of the snclient_local.ini. +You can also set max checks in the [/settings/check/multi] section of the snclient_local.ini, which limits the number of checks that can be configured. -When using the inline mode, you can only use available commands (run 'check_index' to get a full list). +When using the inline mode, you can only use available commands (run check_index to get a full list). You can also define custom check sections in the config file, for example: @@ -80,7 +80,7 @@ You can also define custom check sections in the config file, for example: command[alias1] = check_process process=123 command[alias2] = check_process process=345 -This can be executed with 'check_multi "config=mycheck"'. +This can be executed with check_multi "config=mycheck". It's also possible to use custom scripts in the config section, for example: @@ -89,7 +89,7 @@ It's also possible to use custom scripts in the config section, for example: command[alias2] = /path/to/plugin2 command[alias3] = /path/to/plugin3 -This can be executed with 'check_multi "config=myscript"'.`, +This can be executed with check_multi "config=myscript".`, implemented: ALL, result: &CheckResult{ State: CheckExitOK, diff --git a/pkg/snclient/check_wmi.go b/pkg/snclient/check_wmi.go index ce346f89..c82eb2aa 100644 --- a/pkg/snclient/check_wmi.go +++ b/pkg/snclient/check_wmi.go @@ -32,7 +32,7 @@ func (l *CheckWMI) Build() *CheckData { name: "check_wmi", description: `Check status and metrics by running WMI queries. -In order to use this plugin, you need to enable 'CheckWMI' in the '[/modules]' section of the snclient_local.ini.`, +In order to use this plugin, you need to enable CheckWMI in the [/modules] section of the snclient_local.ini.`, implemented: Windows, args: map[string]CheckArgument{ "query": {value: &l.query, description: "The WMI query to execute"},