SNClient (Secure Naemon Client) is a general-purpose monitoring agent for multiple platforms. It is designed to replace NRPE and NSClient++. It supports Naemon/Nagios plugins and includes exporters for Prometheus.
- Language: Written in Go.
- Supported Platforms: Linux, Windows, FreeBSD, and macOS.
- Protocols Supported: Prometheus HTTP(S), NRPE (v2/v4), and the NSCP REST API via HTTP(S).
- Checks/Plugins: Includes system checks for CPU,
memory, disks, network, processes, and services. It can also run external scripts.
Located in
pkg/snclient/check_*.go. - Documentation: The official documentation is in
docs/. Usemake docsto generate the files indocs/checks/commands/anddocs/checks/plugins/.
- Write all new or updated documentation and text in STE80 style (80% of the way to ASD-STE100).
Use plain words, active voice, and one idea per sentence.
Aim for at most 20 words per instruction and 25 words per descriptive sentence.
Preserve technical facts, uncertainty, identifiers, commands, and configuration values.
Keep existing single-line
.inidescriptions on one line. - Use
make fmtinstead ofgo fmt. - Use
make testinstead ofgo test. - Use
make racetestinstead ofgo test -race. - Use
make golangciafter making code changes and fix the linter errors. - Use
make docsinstead of editingdocs/checks/commands/*.mdordocs/checks/plugins/. - Do not create additional Markdown files unless explicitly requested.
- Keep comments short. Do not comment the obvious. Only comment exceptional non-obvious things.
- Avoid duplicate code.
- Do not add unnecessary tests.
- Do not use "t.Parallel()". It makes test output less readable.
- Existing metrics / performancedata must not change.
- Follow clean code principles. Avoid bad practices such as
goto. - The final acceptance test is
make citest.