From 8e87e33e61a1927e5fc8917b3d63fef18bf30ae9 Mon Sep 17 00:00:00 2001 From: lorenzg Date: Mon, 26 Oct 2026 11:21:38 +0100 Subject: [PATCH 1/2] rename osx to macOS --- .github/workflows/builds.yml | 4 ++-- Changes | 10 +++++----- Makefile | 2 +- docs/checks/commands/check_connections.md | 2 +- docs/checks/commands/check_cpu.md | 2 +- docs/checks/commands/check_cpu_utilization.md | 2 +- docs/checks/commands/check_drive_io.md | 2 +- docs/checks/commands/check_drivesize.md | 2 +- docs/checks/commands/check_dummy.md | 2 +- docs/checks/commands/check_eventlog.md | 6 +++--- docs/checks/commands/check_files.md | 2 +- docs/checks/commands/check_index.md | 2 +- docs/checks/commands/check_kernel_stats.md | 6 +++--- docs/checks/commands/check_load.md | 2 +- docs/checks/commands/check_logfile.md | 2 +- docs/checks/commands/check_mailq.md | 2 +- docs/checks/commands/check_memory.md | 2 +- docs/checks/commands/check_mount.md | 2 +- docs/checks/commands/check_multi.md | 2 +- docs/checks/commands/check_network.md | 2 +- docs/checks/commands/check_ntp_offset.md | 4 ++-- docs/checks/commands/check_omd.md | 6 +++--- docs/checks/commands/check_os_updates.md | 4 ++-- docs/checks/commands/check_os_version.md | 2 +- docs/checks/commands/check_pagefile.md | 6 +++--- docs/checks/commands/check_pdh.md | 6 +++--- docs/checks/commands/check_ping.md | 2 +- docs/checks/commands/check_process.md | 2 +- docs/checks/commands/check_service_linux.md | 6 +++--- docs/checks/commands/check_service_windows.md | 6 +++--- docs/checks/commands/check_snclient_version.md | 2 +- docs/checks/commands/check_swap_io.md | 2 +- docs/checks/commands/check_tasksched.md | 6 +++--- docs/checks/commands/check_temperature.md | 2 +- docs/checks/commands/check_uptime.md | 2 +- docs/checks/commands/check_wmi.md | 6 +++--- docs/checks/plugins/check_dns.md | 2 +- docs/checks/plugins/check_http.md | 2 +- docs/checks/plugins/check_snclient.md | 2 +- docs/checks/plugins/check_ssh.md | 2 +- docs/checks/plugins/check_tcp.md | 2 +- pkg/snclient/check_memory.go | 2 +- pkg/snclient/check_ntp_offset.go | 12 ++++++------ pkg/snclient/check_ntp_offset_linux_test.go | 2 +- pkg/snclient/check_os_updates.go | 4 ++-- pkg/snclient/check_os_updates_darwin.go | 6 +++--- pkg/snclient/check_os_updates_darwin_test.go | 2 +- pkg/snclient/check_ping.go | 4 ++-- pkg/snclient/check_ping_test.go | 4 ++-- pkg/snclient/checkdata.go | 2 +- 50 files changed, 85 insertions(+), 85 deletions(-) diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml index 21bfcf8a0..a2144c77a 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/builds.yml @@ -274,7 +274,7 @@ jobs: - run: sudo apt-get update - run: sudo apt-get install help2man tofrodos - run: | - echo "Creating dist folder for linux/osx" + echo "Creating dist folder for Linux/macOS" make dist rm dist/snclient - uses: actions/upload-artifact@main @@ -692,7 +692,7 @@ jobs: - uses: actions/download-artifact@main with: name: "${{ env.BIN }}.pkg" - - name: "OSX Integration Tests" + - name: "macOS Integration Tests" run: | mv ${{ env.BIN }}.pkg t/snclient.pkg cd t diff --git a/Changes b/Changes index cc70d7c47..bcec956c3 100644 --- a/Changes +++ b/Changes @@ -160,7 +160,7 @@ next: - update windows exporter to 0.31.3 - chore: update dependencies - change minimum golang requirement to 1.24.6 - - osx: + - macOS: - fix corrupted json output (invalid character '\x00' looking for beginning of object key string) 0.36 Tue Jul 29 14:24:04 CEST 2025 @@ -296,7 +296,7 @@ next: 0.21 Thu Mar 28 17:18:25 CET 2024 - add http config ini includes - - add osx pkg uninstaller + - add macOS pkg uninstaller - add check_eventlog support for unique-index (mlueckert) - add check_os_version add os name - add os and version to inventory @@ -392,12 +392,12 @@ next: - add /api/v1/admin/reload rest endpoint to initialize config changes - add /api/v1/admin/certs/replace rest endpoint to replace certificates - support different allowed hosts settings for each web handler - - fix cpu check on osx not returning metrics + - fix cpu check on macOS not returning metrics 0.13 Thu Nov 23 22:20:21 CET 2023 - drop privileges when running node exporter - update node exporter to 1.7.0 - - add node exporter to osx packages + - add node exporter to macOS packages - add check_load plugin - improve docs and help pages - add folder size support to check_files (#38) @@ -459,7 +459,7 @@ next: - add conf.d directory support for includes - added check_tasksched - added nrpe mode to test cmd - - fix osx installer (#27) + - fix macOS installer (#27) - fix linux check_drivesize (#14) - fix missing byte in nrpe response (#21) diff --git a/Makefile b/Makefile index 5d428ef3b..e8dfc9d78 100644 --- a/Makefile +++ b/Makefile @@ -93,7 +93,7 @@ SED=sed -i GO=go CGO_ENABLED=0 -# OSX must be build with CGO enabled, otherwise we don't get cpu metrics +# macOS must be build with CGO enabled, otherwise we don't get cpu metrics DARWIN=0 ifeq ($(shell uname),Darwin) DARWIN=1 diff --git a/docs/checks/commands/check_connections.md b/docs/checks/commands/check_connections.md index e4e1befbc..9f17e544a 100644 --- a/docs/checks/commands/check_connections.md +++ b/docs/checks/commands/check_connections.md @@ -11,7 +11,7 @@ Checks the number of TCP connections. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:-------:|:------------------:| | :white_check_mark: | :white_check_mark: | | :white_check_mark: | diff --git a/docs/checks/commands/check_cpu.md b/docs/checks/commands/check_cpu.md index bf9b774e9..8d512e7ce 100644 --- a/docs/checks/commands/check_cpu.md +++ b/docs/checks/commands/check_cpu.md @@ -11,7 +11,7 @@ Checks the CPU usage metrics. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_cpu_utilization.md b/docs/checks/commands/check_cpu_utilization.md index 10122c5aa..c40016165 100644 --- a/docs/checks/commands/check_cpu_utilization.md +++ b/docs/checks/commands/check_cpu_utilization.md @@ -11,7 +11,7 @@ Checks the CPU utilization metrics. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_drive_io.md b/docs/checks/commands/check_drive_io.md index 390ae6f7b..6c029503a 100644 --- a/docs/checks/commands/check_drive_io.md +++ b/docs/checks/commands/check_drive_io.md @@ -11,7 +11,7 @@ Checks the disk I/O on the host. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_drivesize.md b/docs/checks/commands/check_drivesize.md index dd5eb2bdc..09bcc2c60 100644 --- a/docs/checks/commands/check_drivesize.md +++ b/docs/checks/commands/check_drivesize.md @@ -11,7 +11,7 @@ Checks the disk drive/volumes usage on a host. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_dummy.md b/docs/checks/commands/check_dummy.md index 0bba20d17..8fb77298c 100644 --- a/docs/checks/commands/check_dummy.md +++ b/docs/checks/commands/check_dummy.md @@ -9,7 +9,7 @@ This check simply sets the state to the given value and outputs the remaining ar ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_eventlog.md b/docs/checks/commands/check_eventlog.md index 19a33ba46..1b6c5ab89 100755 --- a/docs/checks/commands/check_eventlog.md +++ b/docs/checks/commands/check_eventlog.md @@ -34,9 +34,9 @@ of the WMI query when possible, the filter is still applied to the returned even ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:------------------:|:-----:|:-------:|:------:| -| :white_check_mark: | | | | +| Windows | Linux | FreeBSD | macOS | +|:------------------:|:-----:|:-------:|:-----:| +| :white_check_mark: | | | | ## Argument Defaults diff --git a/docs/checks/commands/check_files.md b/docs/checks/commands/check_files.md index f55ad7f97..06c8c5cac 100644 --- a/docs/checks/commands/check_files.md +++ b/docs/checks/commands/check_files.md @@ -11,7 +11,7 @@ Checks files and directories. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_index.md b/docs/checks/commands/check_index.md index 18b90994d..c99833d29 100644 --- a/docs/checks/commands/check_index.md +++ b/docs/checks/commands/check_index.md @@ -11,7 +11,7 @@ Returns list of all known checks. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_kernel_stats.md b/docs/checks/commands/check_kernel_stats.md index dc290ca08..dae623ae9 100644 --- a/docs/checks/commands/check_kernel_stats.md +++ b/docs/checks/commands/check_kernel_stats.md @@ -11,9 +11,9 @@ Checks some metrics of the Linux kernel. Currently supports context switches, pr ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:-------:|:------------------:|:-------:|:------:| -| | :white_check_mark: | | | +| Windows | Linux | FreeBSD | macOS | +|:-------:|:------------------:|:-------:|:-----:| +| | :white_check_mark: | | | ## Argument Defaults diff --git a/docs/checks/commands/check_load.md b/docs/checks/commands/check_load.md index 7e37cd286..b70d72887 100644 --- a/docs/checks/commands/check_load.md +++ b/docs/checks/commands/check_load.md @@ -11,7 +11,7 @@ Checks the CPU load metrics. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_logfile.md b/docs/checks/commands/check_logfile.md index 454fba1d1..dbf0a8868 100644 --- a/docs/checks/commands/check_logfile.md +++ b/docs/checks/commands/check_logfile.md @@ -24,7 +24,7 @@ See [here](https://github.com/bmatcuk/doublestar#patterns) for details on the pa ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_mailq.md b/docs/checks/commands/check_mailq.md index 08bd69e08..19848018b 100644 --- a/docs/checks/commands/check_mailq.md +++ b/docs/checks/commands/check_mailq.md @@ -11,7 +11,7 @@ Checks the mailq. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:-------:|:------------------:|:------------------:|:------------------:| | | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_memory.md b/docs/checks/commands/check_memory.md index 4960f940e..9767d8de5 100644 --- a/docs/checks/commands/check_memory.md +++ b/docs/checks/commands/check_memory.md @@ -20,7 +20,7 @@ Read more on Windows virtual address space [here](https://learn.microsoft.com/en ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_mount.md b/docs/checks/commands/check_mount.md index ff88469a0..a313888f4 100644 --- a/docs/checks/commands/check_mount.md +++ b/docs/checks/commands/check_mount.md @@ -11,7 +11,7 @@ Checks the status for a mounted filesystem ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_multi.md b/docs/checks/commands/check_multi.md index b8dca4493..22f1336c9 100644 --- a/docs/checks/commands/check_multi.md +++ b/docs/checks/commands/check_multi.md @@ -34,7 +34,7 @@ This can be executed with check_multi "config=myscript". ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_network.md b/docs/checks/commands/check_network.md index 4dfacdf70..0c30b57c5 100644 --- a/docs/checks/commands/check_network.md +++ b/docs/checks/commands/check_network.md @@ -11,7 +11,7 @@ Checks the state and metrics of network interfaces. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_ntp_offset.md b/docs/checks/commands/check_ntp_offset.md index 4a1933bf4..7398978d6 100644 --- a/docs/checks/commands/check_ntp_offset.md +++ b/docs/checks/commands/check_ntp_offset.md @@ -11,7 +11,7 @@ Checks the NTP offset. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | @@ -33,7 +33,7 @@ Checks the NTP offset. | Argument | Description | | -------- | ---------------------------------------------------------------------------------------------------------- | | server | Fetch offset from these NTP servers. First valid response is used. | -| source | Set source of time data instead of automatic detection. Valid values are: auto, timedatectl, ntpq, chronyc, osx, w32tm. | +| source | Set source of time data instead of automatic detection. Valid values are: auto, timedatectl, ntpq, chronyc, macOS, w32tm. | ## Attributes diff --git a/docs/checks/commands/check_omd.md b/docs/checks/commands/check_omd.md index 950ba3b43..ca998478c 100644 --- a/docs/checks/commands/check_omd.md +++ b/docs/checks/commands/check_omd.md @@ -11,9 +11,9 @@ Check OMD site status. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:-------:|:------------------:|:-------:|:------:| -| | :white_check_mark: | | | +| Windows | Linux | FreeBSD | macOS | +|:-------:|:------------------:|:-------:|:-----:| +| | :white_check_mark: | | | ## Argument Defaults diff --git a/docs/checks/commands/check_os_updates.md b/docs/checks/commands/check_os_updates.md index 82117dd10..88d39e97a 100644 --- a/docs/checks/commands/check_os_updates.md +++ b/docs/checks/commands/check_os_updates.md @@ -11,7 +11,7 @@ Checks for OS system updates. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:-------:|:------------------:| | :white_check_mark: | :white_check_mark: | | :white_check_mark: | @@ -32,7 +32,7 @@ Checks for OS system updates. | Argument | Description | | ---------------------- | -------------------------------------------------------------------------------------------- | | -m\|--max-metadata-age | Fail with UNKNOWN if the repository metadata (apt/yum/dnf) is older than this duration, e.g. 48h (default: 24h) | -| -s\|--system | Package system: auto, apt, yum, osx and windows (default: auto) | +| -s\|--system | Package system: auto, apt, yum, macOS and windows (default: auto) | | -u\|--update | Update package list (if supported, e.g. apt-get update) | ## Attributes diff --git a/docs/checks/commands/check_os_version.md b/docs/checks/commands/check_os_version.md index ad0d656f4..7261d13d5 100644 --- a/docs/checks/commands/check_os_version.md +++ b/docs/checks/commands/check_os_version.md @@ -11,7 +11,7 @@ Checks the os system version. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_pagefile.md b/docs/checks/commands/check_pagefile.md index 5f00a978f..7573abe01 100644 --- a/docs/checks/commands/check_pagefile.md +++ b/docs/checks/commands/check_pagefile.md @@ -11,9 +11,9 @@ Checks the pagefile usage. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:------------------:|:-----:|:-------:|:------:| -| :white_check_mark: | | | | +| Windows | Linux | FreeBSD | macOS | +|:------------------:|:-----:|:-------:|:-----:| +| :white_check_mark: | | | | ## Argument Defaults diff --git a/docs/checks/commands/check_pdh.md b/docs/checks/commands/check_pdh.md index c5ad88a54..e5e275b0a 100644 --- a/docs/checks/commands/check_pdh.md +++ b/docs/checks/commands/check_pdh.md @@ -10,9 +10,9 @@ Checks PDH paths and handles wildcard expansion. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:------------------:|:-----:|:-------:|:------:| -| :white_check_mark: | | | | +| Windows | Linux | FreeBSD | macOS | +|:------------------:|:-----:|:-------:|:-----:| +| :white_check_mark: | | | | ## Check Specific Arguments diff --git a/docs/checks/commands/check_ping.md b/docs/checks/commands/check_ping.md index 4b7ca7d74..4db8a372d 100644 --- a/docs/checks/commands/check_ping.md +++ b/docs/checks/commands/check_ping.md @@ -11,7 +11,7 @@ Checks the ICMP ping connection. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_process.md b/docs/checks/commands/check_process.md index 644b597af..33743fe41 100644 --- a/docs/checks/commands/check_process.md +++ b/docs/checks/commands/check_process.md @@ -11,7 +11,7 @@ Checks the state and metrics of one or multiple processes. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_service_linux.md b/docs/checks/commands/check_service_linux.md index ce37ab4d0..8da51b07a 100644 --- a/docs/checks/commands/check_service_linux.md +++ b/docs/checks/commands/check_service_linux.md @@ -13,9 +13,9 @@ There is a specific [check_service for Windows](../check_service_windows) as wel ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:-------:|:------------------:|:-------:|:------:| -| | :white_check_mark: | | | +| Windows | Linux | FreeBSD | macOS | +|:-------:|:------------------:|:-------:|:-----:| +| | :white_check_mark: | | | ## Argument Defaults diff --git a/docs/checks/commands/check_service_windows.md b/docs/checks/commands/check_service_windows.md index 31f1732ea..43c7cc9ce 100755 --- a/docs/checks/commands/check_service_windows.md +++ b/docs/checks/commands/check_service_windows.md @@ -13,9 +13,9 @@ There is a specific [check_service for Linux](../check_service_linux) as well. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:------------------:|:-----:|:-------:|:------:| -| :white_check_mark: | | | | +| Windows | Linux | FreeBSD | macOS | +|:------------------:|:-----:|:-------:|:-----:| +| :white_check_mark: | | | | ## Argument Defaults diff --git a/docs/checks/commands/check_snclient_version.md b/docs/checks/commands/check_snclient_version.md index 410dc207d..ecb48640d 100644 --- a/docs/checks/commands/check_snclient_version.md +++ b/docs/checks/commands/check_snclient_version.md @@ -11,7 +11,7 @@ Check and return SNClient version. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_swap_io.md b/docs/checks/commands/check_swap_io.md index a36dc81a0..3ed0addfe 100644 --- a/docs/checks/commands/check_swap_io.md +++ b/docs/checks/commands/check_swap_io.md @@ -11,7 +11,7 @@ Checks the swap I/O rate on the host. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:-------:|:------------------:|:------------------:|:------------------:| | | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_tasksched.md b/docs/checks/commands/check_tasksched.md index ee0d8e4fe..617f478a2 100644 --- a/docs/checks/commands/check_tasksched.md +++ b/docs/checks/commands/check_tasksched.md @@ -11,9 +11,9 @@ Check status of scheduled jobs ## Implementation -| Windows | Linux | FreeBSD | MacOSX | -|:------------------:|:-----:|:-------:|:------:| -| :white_check_mark: | | | | +| Windows | Linux | FreeBSD | macOS | +|:------------------:|:-----:|:-------:|:-----:| +| :white_check_mark: | | | | ## Argument Defaults diff --git a/docs/checks/commands/check_temperature.md b/docs/checks/commands/check_temperature.md index f68f2d5b8..0698efa54 100644 --- a/docs/checks/commands/check_temperature.md +++ b/docs/checks/commands/check_temperature.md @@ -11,7 +11,7 @@ Check temperature sensors. ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:-------:|:------------------:| | :white_check_mark: | :white_check_mark: | | :white_check_mark: | diff --git a/docs/checks/commands/check_uptime.md b/docs/checks/commands/check_uptime.md index 597d94763..51f6ed161 100644 --- a/docs/checks/commands/check_uptime.md +++ b/docs/checks/commands/check_uptime.md @@ -11,7 +11,7 @@ Check computer uptime (time since last reboot). ## Implementation -| Windows | Linux | FreeBSD | MacOSX | +| Windows | Linux | FreeBSD | macOS | |:------------------:|:------------------:|:------------------:|:------------------:| | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/checks/commands/check_wmi.md b/docs/checks/commands/check_wmi.md index 633481c8c..e57dccb8a 100644 --- a/docs/checks/commands/check_wmi.md +++ b/docs/checks/commands/check_wmi.md @@ -12,9 +12,9 @@ In order to use this plugin, you need to enable CheckWMI in the 0 || check.hasArgsSupplied["type"] || (runtime.GOOS == "darwin" && check.output == OutputInventory) { l.addMemType(check, "swap", swap.Used, swap.Free, swap.Total) } diff --git a/pkg/snclient/check_ntp_offset.go b/pkg/snclient/check_ntp_offset.go index c91699da8..2bdf88383 100644 --- a/pkg/snclient/check_ntp_offset.go +++ b/pkg/snclient/check_ntp_offset.go @@ -43,7 +43,7 @@ func (l *CheckNTPOffset) Build() *CheckData { }, args: map[string]CheckArgument{ "server": {value: &l.ntpserver, description: "Fetch offset from these NTP servers. First valid response is used."}, - "source": {value: &l.source, isFilter: true, description: "Set source of time data instead of automatic detection. Valid values are: auto, timedatectl, ntpq, chronyc, osx, w32tm."}, + "source": {value: &l.source, isFilter: true, description: "Set source of time data instead of automatic detection. Valid values are: auto, timedatectl, ntpq, chronyc, macOS, w32tm."}, }, defaultFilter: "none", defaultWarning: "offset > 50 || offset < -50", @@ -175,10 +175,10 @@ func (l *CheckNTPOffset) addSources(ctx context.Context, check *CheckData) (err } } - if l.source == "auto" || l.source == "osx" { - err = l.addOSX(ctx, check, l.source == "osx") + if l.source == "auto" || l.source == "macOS" || l.source == "osx" { + err = l.addOSX(ctx, check, l.source != "auto") if err != nil { - log.Debugf("failed: osx: %s", err.Error()) + log.Debugf("failed: macOS: %s", err.Error()) if l.source != "auto" { return err } @@ -458,10 +458,10 @@ func (l *CheckNTPOffset) parseW32AnyLang(text string) (valid bool, source, offse return valid, source, offset, stratum, errorStr } -// get offset on Mac OSX +// get offset on macOS func (l *CheckNTPOffset) addOSX(ctx context.Context, check *CheckData, force bool) error { if !force && runtime.GOOS != "darwin" { - return fmt.Errorf("this is a mac osx command") + return fmt.Errorf("this is a macOS command") } entry := l.defaultEntry("osx") diff --git a/pkg/snclient/check_ntp_offset_linux_test.go b/pkg/snclient/check_ntp_offset_linux_test.go index 36d4af636..d4de495ea 100644 --- a/pkg/snclient/check_ntp_offset_linux_test.go +++ b/pkg/snclient/check_ntp_offset_linux_test.go @@ -414,7 +414,7 @@ Network Time Server: time.euro.apple.com`, }`, }) defer os.RemoveAll(tmpPath) - res := snc.RunCheck("check_ntp_offset", []string{"source=osx"}) + res := snc.RunCheck("check_ntp_offset", []string{"source=macOS"}) assert.Equalf(t, CheckExitOK, res.State, "state OK") assert.Equalf(t, "OK - offset -7.587ms from time.euro.apple.com (10.1.1.1) |'offset'=-7.587078ms;-50:50;-100:100 'stratum'=2;;;0", string(res.BuildPluginOutput()), "output matches") diff --git a/pkg/snclient/check_os_updates.go b/pkg/snclient/check_os_updates.go index 40a8bc2d7..7b33160a2 100644 --- a/pkg/snclient/check_os_updates.go +++ b/pkg/snclient/check_os_updates.go @@ -37,7 +37,7 @@ func (l *CheckOSUpdates) Build() *CheckData { hasInventory: NoCallInventory, result: &CheckResult{}, args: map[string]CheckArgument{ - "-s|--system": {value: &l.system, description: "Package system: auto, apt, yum, osx and windows (default: auto)"}, + "-s|--system": {value: &l.system, description: "Package system: auto, apt, yum, macOS and windows (default: auto)"}, "-u|--update": {value: &l.update, description: "Update package list (if supported, e.g. apt-get update)"}, "-m|--max-metadata-age": { value: &l.maxMetadataAge, @@ -90,7 +90,7 @@ func (l *CheckOSUpdates) Check(ctx context.Context, snc *Agent, check *CheckData addedOsBackendCount, osBackendAddErr := l.addOSBackends(ctx, check) if addedOsBackendCount == 0 { - return nil, fmt.Errorf("no suitable package system found, supported systems are apt, yum, osx and windows. found errors: %w", osBackendAddErr) + return nil, fmt.Errorf("no suitable package system found, supported systems are apt, yum, macOS and windows. found errors: %w", osBackendAddErr) } if osBackendAddErr != nil { return nil, osBackendAddErr diff --git a/pkg/snclient/check_os_updates_darwin.go b/pkg/snclient/check_os_updates_darwin.go index 277f61804..f3ec79cc0 100644 --- a/pkg/snclient/check_os_updates_darwin.go +++ b/pkg/snclient/check_os_updates_darwin.go @@ -24,13 +24,13 @@ func (l *CheckOSUpdates) addOSBackends(ctx context.Context, check *CheckData) (i addedCount++ } if osxErr != nil { - err = fmt.Errorf("error when adding osx: %w", err) + err = fmt.Errorf("error when adding macOS: %w", err) } return addedCount, err } -// get packages from osx softwareupdate +// get packages from macOS softwareupdate func (l *CheckOSUpdates) addOSX(ctx context.Context, check *CheckData) (bool, error) { switch l.system { case "auto": @@ -41,7 +41,7 @@ func (l *CheckOSUpdates) addOSX(ctx context.Context, check *CheckData) (bool, er if os.IsNotExist(err) { return false, nil } - case "osx": + case "macOS", "osx": default: return false, nil } diff --git a/pkg/snclient/check_os_updates_darwin_test.go b/pkg/snclient/check_os_updates_darwin_test.go index 5fe4887ad..f6bc41ad7 100644 --- a/pkg/snclient/check_os_updates_darwin_test.go +++ b/pkg/snclient/check_os_updates_darwin_test.go @@ -18,7 +18,7 @@ Software Update found the following new or updated software: Title: macOS Sonoma 14.3.1, Version: 14.3.1, Size: 1789479KiB, Recommended: NO, Action: restart,`, }) defer os.RemoveAll(tmpPath) - res := snc.RunCheck("check_os_updates", []string{"--system=osx"}) + res := snc.RunCheck("check_os_updates", []string{"--system=macOS"}) assert.Equalf(t, CheckExitWarning, res.State, "state WARNING") assert.Containsf(t, string(res.BuildPluginOutput()), "WARNING - 0 security updates / 1 updates available. |'security'=0;;0;0 'updates'=1;0;;0", "output matches") diff --git a/pkg/snclient/check_ping.go b/pkg/snclient/check_ping.go index 27ae9cab4..7194f041b 100644 --- a/pkg/snclient/check_ping.go +++ b/pkg/snclient/check_ping.go @@ -229,7 +229,7 @@ func (l *CheckPing) parsePingRTA(entry map[string]string, output string) { return } - // osx 14.7 + // macOS 14.7 // round-trip min/avg/max/stddev = 0.040/0.066/0.095/0.021 ms reRTA = regexp.MustCompile(`round-trip min/avg/max/stddev = ([\d.]+)/([\d.]+)/([\d.]+)/([\d.]+) ms`) rtaList = reRTA.FindStringSubmatch(output) @@ -288,7 +288,7 @@ func (l *CheckPing) parsePingPackets(entry map[string]string, output string) { return } - // osx 14.7 + // macOS 14.7 // 5 packets transmitted, 5 packets received, 0.0% packet loss rePackets = regexp.MustCompile(`(\d+) packets transmitted, (\d+) packets received, ([\d.]+)% packet loss`) packetsList = rePackets.FindStringSubmatch(output) diff --git a/pkg/snclient/check_ping_test.go b/pkg/snclient/check_ping_test.go index 48f8b9fa2..a2c47ed4e 100644 --- a/pkg/snclient/check_ping_test.go +++ b/pkg/snclient/check_ping_test.go @@ -259,7 +259,7 @@ func TestPingParserOSXOK(t *testing.T) { "pl": "0.0", "ttl": "64", } - // osx 14.7 + // macOS 14.7 out := ` PING localhost (127.0.0.1): 56 data bytes 64 bytes from 127.0.0.1: icmp_seq=0 ttl=64 time=0.040 ms @@ -287,7 +287,7 @@ func TestPingParserOSXBad(t *testing.T) { "pl": "100.0", "ttl": "", } - // osx 14.7 + // macOS 14.7 out := ` PING 10.99.99.99 (10.99.99.99): 56 data bytes Request timeout for icmp_seq 0 diff --git a/pkg/snclient/checkdata.go b/pkg/snclient/checkdata.go index a10d8df6d..8430c29fd 100644 --- a/pkg/snclient/checkdata.go +++ b/pkg/snclient/checkdata.go @@ -1792,7 +1792,7 @@ func (cd *CheckData) helpImplemented(format ShowHelp) string { {Name: "Windows", Field: "windows", Alignment: "centered"}, {Name: "Linux", Field: "linux", Alignment: "centered"}, {Name: "FreeBSD", Field: "freebsd", Alignment: "centered"}, - {Name: "MacOSX", Field: "osx", Alignment: "centered"}, + {Name: "macOS", Field: "osx", Alignment: "centered"}, } implemented := implTableData{} if cd.implemented&Windows > 0 { From 81e12214184cc83787b9a4da1b3e574e1d4adc88 Mon Sep 17 00:00:00 2001 From: lorenzg Date: Mon, 26 Oct 2026 11:37:36 +0100 Subject: [PATCH 2/2] add missing titles and descriptions --- docs/install/archlinux/_index.md | 2 ++ docs/install/build.md | 2 ++ docs/install/debian/_index.md | 4 +++- docs/install/osx/_index.md | 2 ++ docs/install/rhel/_index.md | 4 +++- docs/install/supported.md | 4 +++- docs/install/windows/_index.md | 2 ++ docs/prometheus/_index.md | 1 + docs/prometheus/exporter.md | 5 +++-- docs/prometheus/managed.md | 5 +++-- docs/prometheus/node.md | 5 +++-- docs/prometheus/windows.md | 5 +++-- 12 files changed, 30 insertions(+), 11 deletions(-) diff --git a/docs/install/archlinux/_index.md b/docs/install/archlinux/_index.md index 34dabd55b..984a3e772 100644 --- a/docs/install/archlinux/_index.md +++ b/docs/install/archlinux/_index.md @@ -1,5 +1,7 @@ --- +title: Arch Linux linkTitle: Arch Linux +description: Install SNClient from the Arch User Repository (AUR). weight: 350 --- diff --git a/docs/install/build.md b/docs/install/build.md index d213115d4..ccb4108f6 100644 --- a/docs/install/build.md +++ b/docs/install/build.md @@ -1,5 +1,7 @@ --- +title: Building SNClient From Source linkTitle: From Source +description: Build SNClient binaries and platform packages from source. --- # Building SNClient From Source diff --git a/docs/install/debian/_index.md b/docs/install/debian/_index.md index 10ec7ded9..b114dbc14 100644 --- a/docs/install/debian/_index.md +++ b/docs/install/debian/_index.md @@ -1,5 +1,7 @@ --- -linkTitle: Debian +title: Debian / Ubuntu +linkTitle: Debian / Ubuntu +description: Install SNClient on Debian and Ubuntu using DEB packages. weight: 300 --- diff --git a/docs/install/osx/_index.md b/docs/install/osx/_index.md index a3db24d8a..57ecca31d 100644 --- a/docs/install/osx/_index.md +++ b/docs/install/osx/_index.md @@ -1,5 +1,7 @@ --- +title: macOS linkTitle: macOS +description: Install SNClient on macOS using the package installer. weight: 400 --- diff --git a/docs/install/rhel/_index.md b/docs/install/rhel/_index.md index 8c4f7c1d1..0dff64da7 100644 --- a/docs/install/rhel/_index.md +++ b/docs/install/rhel/_index.md @@ -1,5 +1,7 @@ --- -linkTitle: RHEL +title: Red Hat / Rocky / AlmaLinux +linkTitle: RHEL / Rocky / AlmaLinux +description: Install SNClient on RHEL, Rocky Linux, and AlmaLinux from packages. weight: 200 --- diff --git a/docs/install/supported.md b/docs/install/supported.md index 3e1b8c64d..6d3117727 100644 --- a/docs/install/supported.md +++ b/docs/install/supported.md @@ -1,5 +1,7 @@ --- -linkTitle: Supported OS +title: Supported Systems +linkTitle: Supported Systems +description: Review supported operating systems and CPU architectures for SNClient. --- # Supported Systems diff --git a/docs/install/windows/_index.md b/docs/install/windows/_index.md index 8f9465b1d..75a5da732 100644 --- a/docs/install/windows/_index.md +++ b/docs/install/windows/_index.md @@ -1,5 +1,7 @@ --- +title: Windows linkTitle: Windows +description: Install SNClient on Windows using the MSI package and configure its firewall and installation options. weight: 100 --- diff --git a/docs/prometheus/_index.md b/docs/prometheus/_index.md index e03023cbd..75d88090a 100644 --- a/docs/prometheus/_index.md +++ b/docs/prometheus/_index.md @@ -1,6 +1,7 @@ --- title: Prometheus linkTitle: Prometheus +description: Explore SNClient's built-in Prometheus metrics and exporter integrations. weight: 300 tags: - prometheus diff --git a/docs/prometheus/exporter.md b/docs/prometheus/exporter.md index a56270439..663ce5532 100644 --- a/docs/prometheus/exporter.md +++ b/docs/prometheus/exporter.md @@ -1,6 +1,7 @@ --- -title: ExporterExporter -linkTitle: ExpExp +title: Exporter Exporter +linkTitle: Exporter Exporter +description: Proxy requests to Prometheus exporters that are not managed by SNClient. weight: 360 tags: - prometheus diff --git a/docs/prometheus/managed.md b/docs/prometheus/managed.md index 92e8c374e..ab75b538c 100644 --- a/docs/prometheus/managed.md +++ b/docs/prometheus/managed.md @@ -1,6 +1,7 @@ --- -title: ManagedExporter -linkTitle: Managed +title: Managed Exporters +linkTitle: Managed Exporters +description: Configure SNClient to start, monitor, and expose managed Prometheus exporters. weight: 350 tags: - prometheus diff --git a/docs/prometheus/node.md b/docs/prometheus/node.md index 3739690fe..63b2e3079 100644 --- a/docs/prometheus/node.md +++ b/docs/prometheus/node.md @@ -1,6 +1,7 @@ --- -title: Linux/macOS -linkTitle: Linux/macOS +title: Node Exporter (Linux/macOS) +linkTitle: Node Exporter (Linux/macOS) +description: Enable SNClient's built-in node exporter to expose Linux and macOS metrics. weight: 340 tags: - prometheus diff --git a/docs/prometheus/windows.md b/docs/prometheus/windows.md index 32447b221..73b1023bc 100644 --- a/docs/prometheus/windows.md +++ b/docs/prometheus/windows.md @@ -1,6 +1,7 @@ --- -title: Windows -linkTitle: Windows +title: Windows Exporter +linkTitle: Windows Exporter +description: Enable SNClient's built-in Windows exporter to expose Windows metrics. weight: 330 tags: - prometheus