Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/checks/commands/check_logfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>CheckLogFile</code> in the <code>[/modules]</code> 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 <code>allowed pattern</code> in the <code>[/settings/check/logfile]</code>
section of the snclient_local.ini to a comma separated list of allowed glob patterns.

Example:
Expand Down
10 changes: 5 additions & 5 deletions docs/checks/commands/check_multi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ 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 <code>CheckMulti</code> is enabled, but you can disable it in the <code>[/modules]</code> section of the snclient_local.ini.
You can also set <code>max checks</code> in the <code>[/settings/check/multi]</code> 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 <code>check_index</code> to get a full list).

You can also define custom check sections in the config file, for example:

[/settings/check/multi/mycheck]
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 <code>check_multi "config=mycheck"</code>.

It's also possible to use custom scripts in the config section, for example:

Expand All @@ -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 <code>check_multi "config=myscript"</code>.

- [Argument Defaults](#argument-defaults)
- [Attributes](#attributes)
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/commands/check_wmi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>CheckWMI</code> in the <code>[/modules]</code> section of the snclient_local.ini.

- [Argument Defaults](#argument-defaults)
- [Examples](#examples)
Expand Down
4 changes: 2 additions & 2 deletions pkg/snclient/check_logfile.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>CheckLogFile</code> in the <code>[/modules]</code> 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 <code>allowed pattern</code> in the <code>[/settings/check/logfile]</code>
section of the snclient_local.ini to a comma separated list of allowed glob patterns.

Example:
Expand Down
10 changes: 5 additions & 5 deletions pkg/snclient/check_multi.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,19 @@ 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 <code>CheckMulti</code> is enabled, but you can disable it in the <code>[/modules]</code> section of the snclient_local.ini.
You can also set <code>max checks</code> in the <code>[/settings/check/multi]</code> 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 <code>check_index</code> to get a full list).

You can also define custom check sections in the config file, for example:

[/settings/check/multi/mycheck]
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 <code>check_multi "config=mycheck"</code>.

It's also possible to use custom scripts in the config section, for example:

Expand All @@ -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 <code>check_multi "config=myscript"</code>.`,
implemented: ALL,
result: &CheckResult{
State: CheckExitOK,
Expand Down
2 changes: 1 addition & 1 deletion pkg/snclient/check_wmi.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>CheckWMI</code> in the <code>[/modules]</code> section of the snclient_local.ini.`,
implemented: Windows,
args: map[string]CheckArgument{
"query": {value: &l.query, description: "The WMI query to execute"},
Expand Down
Loading