Skip to content

Commit 206d089

Browse files
author
github automation
committed
update snclient docs
https://github.com/ConSol-Monitoring/snclient/actions/workflows/deploy-docs.yml
1 parent ae0f2e6 commit 206d089

File tree

10 files changed

+85
-117
lines changed

10 files changed

+85
-117
lines changed

‎content/en/docs/snclient/checks/commands/check_cpu.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ these can be used in filters and thresholds (along with the default attributes):
7676
| idle | Current idle load for a given core (currently not supported) |
7777
| kernel | Current kernel load for a given core (currently not supported) |
7878
| load | Current load for a given core |
79-
| time | Time frame to check |
79+
| time | Time frame checked |

‎content/en/docs/snclient/checks/commands/check_ping.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ Naemon Config
6767

6868
these can be used in filters and thresholds (along with the default attributes):
6969

70-
| Attribute | Description |
71-
| --------- | --------------------------- |
72-
| host_name | host name ping was sent to. |
73-
| ttl | time to live. |
74-
| sent | number of packets sent. |
75-
| received | number of packets received. |
76-
| rta | average round trip time. |
77-
| pl | packet loss in percent. |
70+
| Attribute | Description |
71+
| --------- | ---------------------------------------- |
72+
| host_name | host name ping was sent to. |
73+
| ttl | time to live. |
74+
| sent | number of packets sent. |
75+
| received | number of packets received. |
76+
| rta | average round trip time in milliseconds. |
77+
| pl | packet loss in percent. |

‎content/en/docs/snclient/checks/commands/check_process.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ Naemon Config
7272

7373
## Check Specific Arguments
7474

75-
| Argument | Description |
76-
| -------- | ---------------------------------------------------------- |
77-
| process | The process to check, set to \* to check all. Default: \* |
78-
| timezone | Sets the timezone for time metrics (default is local time) |
75+
| Argument | Description |
76+
| -------- | ---------------------------------------------------------------------------- |
77+
| process | The process to check, set to \* to check all. (Case insensitive) Default: \* |
78+
| timezone | Sets the timezone for time metrics (default is local time) |
7979

8080
## Attributes
8181

‎content/en/docs/snclient/checks/commands/check_service_linux.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,10 @@ Naemon Config
6767

6868
## Check Specific Arguments
6969

70-
| Argument | Description |
71-
| -------- | ---------------------------------------------------------------------------------- |
72-
| exclude | List of services to exclude from the check (mainly used when service is set to \*) |
73-
| service | Name of the service to check (set to \* to check all services). Default: \* |
70+
| Argument | Description |
71+
| -------- | ----------------------------------------------------------------------------------------------------- |
72+
| exclude | List of services to exclude from the check (mainly used when service is set to \*) (case insensitive) |
73+
| service | Name of the service to check (set to \* to check all services). (case insensitive) Default: \* |
7474

7575
## Attributes
7676

@@ -86,7 +86,7 @@ these can be used in filters and thresholds (along with the default attributes):
8686
| active | The active attribute of a service, one of: active, inactive or failed |
8787
| state | The state of the service, one of: stopped, starting, oneshot, running, static or unknown |
8888
| pid | The pid of the service |
89-
| created | Date when service was started (unix timestamp) |
89+
| created | Date when service was started |
9090
| age | Seconds since service was started |
9191
| rss | Memory rss in bytes (main process) |
9292
| vms | Memory vms in bytes (main process) |

‎content/en/docs/snclient/checks/commands/check_service_windows.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ Naemon Config
6363

6464
## Check Specific Arguments
6565

66-
| Argument | Description |
67-
| -------- | ---------------------------------------------------------------------------------- |
68-
| exclude | List of services to exclude from the check (mainly used when service is set to \*) |
69-
| service | Name of the service to check (set to \* to check all services). Default: \* |
66+
| Argument | Description |
67+
| -------- | ----------------------------------------------------------------------------------------------------- |
68+
| exclude | List of services to exclude from the check (mainly used when service is set to \*) (case insensitive) |
69+
| service | Name of the service to check (set to \* to check all services). (case insensitive) Default: \* |
7070

7171
## Attributes
7272

‎content/en/docs/snclient/checks/expressions/_index.md‎

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,40 @@ ex.:
2121

2222
To combine multiple expressions you can use logical operator and brackets.
2323

24-
| Operator | Alias | Description |
25-
| -------- | -------| ----------- |
26-
| `and` | `&&` | Logical **and** operator |
27-
| `or` | `\|\|` | Logical **or** operator |
24+
| Operator | Alias | Description | Example |
25+
| -------- | -------| ------------------------ | ------------------------ |
26+
| `and` | `&&` | Logical **and** operator | count = 0 and state != 1 |
27+
| `or` | `\|\|` | Logical **or** operator | used > 5 or free < 20 |
2828

2929
ex.:
3030

3131
filter="(status = 'started' or status = 'pending') and usage > 5%"
3232

3333
## Operator
3434

35-
| Operator | Alias / Safe expression | Types | Description |
36-
| ----------- | --------------------------- | --------| ----------- |
37-
| `=` | `==`, `is`, `eq` | Strings, Numbers | Matches on **exact equality**, ex.: `status = 'started'` |
38-
| `!=` | `is not`, `ne` | Strings, Numbers | Matches if value is **not exactly equal**. ex.: `5 != 3` |
39-
| `like` | | Strings | Matches if value contains the condition (**substring match**), ex.: `status like "pend"` |
40-
| `unlike` | `not like` | Strings | Matches if value does **not contain** the **substring**, ex.: `status unlike "stopped"` |
41-
| `ilike` | | Strings | Matches a **case insensitive substring**, ex.: `name ilike "WMI"` |
42-
| `not ilike` | | Strings | Matches if a **case insensitive substring** cannot be found, ex.: `name not ilike "WMI"` |
43-
| `~` | `regex`, `regexp` | Strings | Performs a **regular expression** match, ex.: `status ~ '^pend'` |
44-
| `!~` | `not regex`, `not regexp` | Strings | Performs a **inverse regular expression** match, ex.: `status !~ 'stop'` |
45-
| `~~` | `regexi`, `regexpi` | Strings | Performs a **case insensitive regular expression** match, ex.: `status ~~ '^pend'`. An alternative way is to use `//i` as in `status ~ /^pend/i` |
46-
| `!~~` | `not regexi`, `not regexpi` | Strings | Performs a **inverse case insensitive regular expression** match, ex.: `status !~~ 'stop'` |
47-
| `<` | `lt` | Numbers | Matches **lower than** numbers, ex.: `usage < 5%` |
48-
| `<=` | `le`, `lte` | Numbers | Matches **lower or equal** numbers, ex.: `usage <= 5%` |
49-
| `>` | `gt` | Numbers | Matches **greater than** numbers, ex.: `usage > 5%` |
50-
| `>=` | `ge`, `gte` | Numbers | Matches **greater or equal** numbers, ex.: `usage >= 5%` |
51-
| `in` | | Strings | Matches if element **is in list** ex.: `status in ('start', 'pending')` |
52-
| `not in` | | Strings | Matches if element **is not in list** ex.: `status not in ('stopped', 'starting')` |
35+
| Operator | Alias / Safe expression | Types | Case Sens. | Description |
36+
| ----------- | --------------------------- | -----------------| ---------- | ----------- |
37+
| `=` | `==`, `is`, `eq` | Strings, Numbers | Yes | Matches on **exact equality**, ex.: `status = 'started'` |
38+
| `!=` | `is not`, `ne` | Strings, Numbers | Yes | Matches if value is **not exactly equal**. ex.: `5 != 3` |
39+
| `like` | `ilike` | Strings | No | Matches if value contains the condition (**case insensitive substring match**), ex.: `status like "pend"` |
40+
| `unlike` | `not like`, `not ilike` | Strings | No | Matches if value does **not contain** the **case insensitive substring**, ex.: `status unlike "stopped"` |
41+
| `slike` | `strictlike` | Strings | Yes | Matches a **case sensitive substring**, ex.: `name slike "WMI"` |
42+
| `not slike` | `not strictlike` | Strings | Yes | Matches if a **case sensitive substring** cannot be found, ex.: `name not slike "WMI"` |
43+
| `~` | `regex`, `regexp` | Strings | Yes | Performs a **regular expression** match, ex.: `status ~ '^pend'` |
44+
| `!~` | `not regex`, `not regexp` | Strings | Yes | Performs a **inverse regular expression** match, ex.: `status !~ 'stop'` |
45+
| `~~` | `regexi`, `regexpi` | Strings | No | Performs a **case insensitive regular expression** match, ex.: `status ~~ '^pend'`. An alternative way is to use `//i` as in `status ~ /^pend/i` |
46+
| `!~~` | `not regexi`, `not regexpi` | Strings | No | Performs a **inverse case insensitive regular expression** match, ex.: `status !~~ 'stop'` |
47+
| `<` | `lt` | Numbers | - | Matches **lower than** numbers, ex.: `usage < 5%` |
48+
| `<=` | `le`, `lte` | Numbers | - | Matches **lower or equal** numbers, ex.: `usage <= 5%` |
49+
| `>` | `gt` | Numbers | - | Matches **greater than** numbers, ex.: `usage > 5%` |
50+
| `>=` | `ge`, `gte` | Numbers | - | Matches **greater or equal** numbers, ex.: `usage >= 5%` |
51+
| `in` | | Strings | Yes | Matches if element **is in list** ex.: `status in ('start', 'pending')` |
52+
| `not in` | | Strings | Yes | Matches if element **is not in list** ex.: `status not in ('stopped', 'starting')` |
53+
54+
## Other Operators
55+
56+
For backwards compatibility there more operators available:
57+
58+
| Operator | Alias | Description | Example |
59+
| -------- | --------| ----------------| --------------------------- |
60+
| `''` | `str()` | String constant | exe like str(winlogon.exe) |

‎content/en/docs/snclient/checks/external_commands/_index.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ You can manage script arguments in two ways: embedding them directly into the co
5151
allow arguments = true
5252
```
5353

54+
Arguments are available in macros:
55+
56+
- `$ARGS$` contains all macros space separated **without** quotes.
57+
- `$ARGS"$` contains all macros space separated **with quotes**.
58+
- `$ARGSn$` contains the value of the argument at position `n`.
59+
5460
### Configuration Reference
5561

5662
Below, you'll find a reference section for configuring the External Script Integration feature of SNClient+
@@ -87,7 +93,7 @@ Define scripts available for execution via the External Script Integration featu
8793
command = custom_script.bat
8894
```
8995

90-
Scipts with an extension of .bat, .ps1 and .exe (Windows) or .sh and no extension at all (Unix) can be defined as follows.
96+
Scripts with an extension of .bat, .ps1 and .exe (Windows) or .sh and no extension at all (Unix) can be defined as follows.
9197

9298
```ini
9399
check_dummy = check_dummy.bat
@@ -96,7 +102,7 @@ check_dummy_critical = check_dummy.exe 2 "i am critical"
96102
check_dummy_arg = check_dummy.exe "$ARG1$" "$ARG2$"
97103
# for scripts with variable arguments
98104
check_dummy_args = check_dummy.bat $ARGS$
99-
check_dummy_args% = C:/Program Fles/snclient/scripts/check_dummy.exe %ARGS%
105+
check_dummy_args% = C:/Program Files/snclient/scripts/check_dummy.exe %ARGS%
100106
# put variable arguments in quotes
101107
check_dummy_argsq = ${scripts}/check_dummy.ps1 $ARGS"$
102108
restart_service = NET START "$ARG1$"

‎content/en/docs/snclient/compatibility/_index.md‎

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,12 @@ All bytes related performance data uses bytes in the performance data now.
5757

5858
SNClient uses IEC units if possible. This means for example:
5959

60-
GB = 1000000000 bytes (base 10) 1000^3
61-
GiB = 1073741824 bytes (base 2) 1024^3
62-
Gb = same as GiB
63-
G = same as GB
60+
| Unit | Description |
61+
| ---- | --------------------------------- |
62+
| GB | 1000000000 bytes (base 10) 1000^3 |
63+
| GiB | 1073741824 bytes (base 2) 1024^3 |
64+
| Gb | same as GiB |
65+
| G | same as GB |
6466

6567
### Perf-Config
6668

@@ -95,7 +97,9 @@ In addition to the existing characters, SNClient does not allow the `$` characte
9597

9698
The list of not allowed nasty characters is therefore:
9799

98-
$|`&><'\"\\[]{}
100+
```txt
101+
$|`&><'\"\\[]{}
102+
```
99103

100104
Change the list of nasty chars with the `nasty characters` configuration option.
101105

@@ -126,18 +130,22 @@ tls min version = "tls1.3"
126130
```
127131
128132
Allowing tls 1.2 or higher (default) disables known insecure ciphers. Allowing
129-
tls lower than 1.2 enables all ciphers.
133+
tls lower than 1.2 enables all ciphers (even the insecure ones).
134+
135+
The list of ciphers can be found on [go.dev](https://pkg.go.dev/crypto/tls#pkg-constants).
130136
131137
## Passwords
132138
133139
![Feature](../icons/feature.png "this is a new thing in SNClient+")
134140
135141
SNClient supports using hashed passwords in the configuration file.
136142
137-
%> snclient hash
138-
enter password to hash or hit ctrl+c to exit.
139-
<entering password>
140-
hash sum: SHA256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
143+
```bash
144+
%> snclient hash
145+
enter password to hash or hit ctrl+c to exit.
146+
<entering password>
147+
hash sum: SHA256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
148+
```
141149
142150
Then use this hash as password:
143151
@@ -156,8 +164,10 @@ Check specific changes and enhancements:
156164
157165
The `check_service` adds memory and cpu metrics if the service is running.
158166
159-
check_service service=snclient
160-
OK - All 1 service(s) are ok. |'snclient'=4;;;; 'snclient rss'=12943360B;;;; 'snclient vms'=6492160B;;;; 'snclient cpu'=0%;;;;
167+
```bash
168+
check_service service=snclient
169+
OK - All 1 service(s) are ok. |'snclient'=4;;;; 'snclient rss'=12943360B;;;; 'snclient vms'=6492160B;;;; 'snclient cpu'=0%;;;;
170+
```
161171
162172
### check_files
163173
@@ -167,7 +177,9 @@ The `check_service` adds memory and cpu metrics if the service is running.
167177
168178
Example:
169179
170-
check_files path=c:/windows warn=size>2MB max-depth=1 timezone=Europe/Berlin
180+
```bash
181+
check_files path=c:/windows warn=size>2MB max-depth=1 timezone=Europe/Berlin
182+
```
171183
172184
### check_tasksched
173185

‎content/en/docs/snclient/install/_index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ There is a OS specific installation documentation available for:
1111
- [Windows](windows)
1212
- [RHEL/Rocky/Alma](rhel)
1313
- [Debian/Ubuntu](debian)
14-
- [Alpine](alpine)
1514
- [Mac OSX](osx)
1615

1716
## Using Binary Packages

‎content/en/docs/snclient/install/alpine/_index.md‎

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)