Skip to content

Commit 79d396c

Browse files
author
github automation
committed
1 parent ef29970 commit 79d396c

File tree

14 files changed

+313
-29
lines changed

14 files changed

+313
-29
lines changed

content/en/docs/snclient/_index.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,34 @@ tags:
1212
- osx
1313
---
1414

15-
<div class="pb-4">
16-
<img src="logo/snclient.svg" alt="SNClient" width="200px" style="background-color: white"/>
17-
</div>
18-
1915
[![CICD Pipeline](https://github.com/Consol-Monitoring/snclient/actions/workflows/builds.yml/badge.svg?branch=main)](https://github.com/Consol-Monitoring/snclient/actions/workflows/builds.yml)
2016
[![Go Report Card](https://goreportcard.com/badge/github.com/Consol-Monitoring/snclient)](https://goreportcard.com/report/github.com/Consol-Monitoring/snclient)
2117
[![Latest Release](https://img.shields.io/github/v/release/Consol-Monitoring/snclient?sort=semver)](https://github.com/Consol-Monitoring/snclient/releases)
2218
[![License](https://img.shields.io/github/license/Consol-Monitoring/snclient)](https://github.com/Consol-Monitoring/snclient/blob/main/LICENSE)
2319
[![IRC](https://img.shields.io/badge/IRC-libera.chat%2F%23snclient-blue)](https://web.libera.chat/?nick=Guest?#snclient)
20+
<a href="logo/"><img src="logo/snclient.svg" style="float:right; margin: 3px; height: auto; width: 200px; float: right;"></a>
2421

2522
**SNClient** is an open-source (drop-in for most use cases) general purpose monitoring agent as replacement for the well-known NSClient++.
2623

2724
It was written from scratch in [Golang](https://go.dev/) using todays state-of-the-art technologies. All the test and build procedures are located on [GitHub](https://github.com/ConSol-Monitoring/snclient).
2825

29-
It's available for Linux, Windows and MacOS for i386, x86_64 and arm64 ([detailed list of supported operating systems](https://omd.consol.de/docs/snclient/install/supported/)).
26+
It's available for Linux, Windows and MacOS for i386, x86_64 and arm64 ([detailed list of supported operating systems](./install/supported/)).
27+
28+
Have a look at the [installation](./install/) page for first steps.
29+
30+
## Nagios / Naemon and Prometheus
3031

31-
Have a look at the [installation](install) page for first steps.
32+
- SNClient supports the [Nagios / Naemon stack](./checks/) with nrpe or check_nsc_web.
33+
- Prometheus is also supported with the [builtin node_exporter and windows_exporter](./prometheus/)
3234

3335
## Releases
3436

3537
The latest release can always be found [here](https://github.com/ConSol-Monitoring/snclient/releases).
38+
39+
## Talks
40+
41+
### 2023 - OSMC Nuremberg
42+
43+
- english - 33 minutes
44+
- Talk: <https://www.youtube.com/watch?v=cXXZlnmn2NA>
45+
- [Slides](https://labs.consol.de/_slides/snclient-2023-11-09.pdf)

content/en/docs/snclient/checks/commands/check_files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ these can be used in filters and thresholds (along with the default attributes):
8181
| file | Alias for filename |
8282
| fullname | Full name of the file including path |
8383
| type | Type of item (file or dir) |
84-
| access | Last access time |
85-
| creation | Date when file was created |
84+
| access | Unix timestamp of last access time |
85+
| creation | Unix timestamp when file was created |
8686
| size | File size in bytes |
87-
| written | Date when file was last written to |
87+
| written | Unix timestamp when file was last written to |
8888
| write | Alias for written |
8989
| age | Seconds since file was last written |
9090
| version | Windows exe/dll file version (windows only) |

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ these can be used in filters and thresholds (along with the default attributes):
9494
| pid | Process id |
9595
| uid | User if of process owner (linux only) |
9696
| username | User name of process owner (linux only) |
97-
| cpu | CPU usage in percent |
97+
| cpu | CPU usage in percent (over total lifetime of process) |
98+
| cpu_seconds | CPU usage in seconds |
9899
| virtual | Virtual memory usage in bytes |
99100
| rss | Resident memory usage in bytes |
100101
| pagefile | Swap memory usage in bytes |

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@ these can be used in filters and thresholds (along with the default attributes):
7878
| -------------- | ---------------------------------------------------------------------------------------------------- |
7979
| name | The name of the service |
8080
| service | Alias for name |
81-
| desc | Description of the service |
81+
| display | Display name of the service |
82+
| desc | Alias for display (not a typo) |
83+
| description | Description of the service |
8284
| state | The state of the service, one of: stopped, starting, stopping, running, continuing, pausing, paused or unknown |
8385
| pid | The pid of the service |
8486
| created | Date when service was started |

content/en/docs/snclient/checks/commands/check_uptime.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Check computer uptime (time since last reboot).
2121
### Default Check
2222

2323
check_uptime
24-
OK - uptime: 3d 02:30h, boot: 2023-11-17 19:33:46 (UTC) |'uptime'=268241s;172800:;86400:
24+
OK - uptime: 3d 02:30h, boot: 2023-11-17 19:33:46 UTC |'uptime'=268241s;172800:;86400:
2525

2626
### Example using NRPE and Naemon
2727

@@ -41,15 +41,15 @@ Naemon Config
4141

4242
## Argument Defaults
4343

44-
| Argument | Default Value |
45-
| ------------- | ---------------------------------------- |
46-
| warning | uptime < 2d |
47-
| critical | uptime < 1d |
48-
| empty-state | 0 (OK) |
49-
| empty-syntax | |
50-
| top-syntax | %(status) - \${list} |
51-
| ok-syntax | |
52-
| detail-syntax | uptime: \${uptime}, boot: \${boot} (UTC) |
44+
| Argument | Default Value |
45+
| ------------- | ----------------------------------------- |
46+
| warning | uptime < 2d |
47+
| critical | uptime < 1d |
48+
| empty-state | 0 (OK) |
49+
| empty-syntax | |
50+
| top-syntax | %(status) - \${list} |
51+
| ok-syntax | |
52+
| detail-syntax | uptime: \${uptime}, boot: \${boot \| utc} |
5353

5454
## Check Specific Arguments
5555

@@ -65,4 +65,4 @@ these can be used in filters and thresholds (along with the default attributes):
6565
| ------------ | ----------------------------------- |
6666
| uptime | Human readable time since last boot |
6767
| uptime_value | Uptime in seconds |
68-
| boot | Human readable date of last boot |
68+
| boot | Unix timestamp of last boot |

content/en/docs/snclient/checks/perfconfig/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ check_plugin perf-config="selector(key:value;...)"
1414
For example:
1515

1616
```bash
17-
check_drivesize "perf-config=used(unit:G) used %(ignored:true)"
17+
check_drivesize "perf-config= used %(ignored:true) used(unit:G)"
1818
```
1919

2020
This will convert used disk space bytes into gigabytes. It als removes the percent

content/en/docs/snclient/configuration/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ Support operators are:
254254
| `:age` | 1700834034 -> 374 | subtract value from current unix timestamp to get the age in seconds |
255255
| `:date` | 1700834034 -> 2023-11-24 14:53:54 CET | convert unix timestamp into human readable date (local timezone) |
256256
| `:utc` | 1700834034 -> 2023-11-24 13:53:54 UTC | convert unix timestamp into human readable date (utc timezone) |
257-
| `:fmt=<fmt>` | 123.45 -> 123.4 | apply format, ex.: $(total \| fmt=%.1f) (using GOs fmt.Sprintf) |
257+
| `:fmt=<fmt>` | 123.45 -> 123.5 | apply format, ex.: $(total \| fmt=%.1f) (using GOs fmt.Sprintf) |
258258
| `:s/regexp/replace/` | C:\ % -> C | apply regexp replacement, ex.: $(name \| 's/\\W//' ) (using GOs regexp.Compile) |
259259
| `:ascii` | C:\ % -> C | remove any none-ascii characters |
260260
| `:trim` | " test " -> "test" | remove leading and trailing whitespace |

content/en/docs/snclient/logo/_index.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,18 @@ linkTitle: Logo
66
The logo can be used under the same license as SNClient itself to link back to
77
the SNClient homepage or source code.
88

9+
## Light Mode
10+
911
snclient.png:
1012

11-
[![SNClient Logo](snclient.png "SNClient Logo")](snclient.png)
13+
<img src="snclient.svg" style="height: auto; width: 200px; background: #EEE;">
1214

1315
- [snclient.png](snclient.png)
1416
- [snclient.svg](snclient.svg)
17+
18+
## Dark Mode
19+
20+
<img src="snclient_dark.png" style="height: auto; width: 200px; background: #222;">
21+
22+
- [snclient_dark.png](snclient_dark.png)
23+
- [snclient_dark.svg](snclient_dark.svg)
157 KB
Loading
Lines changed: 227 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)