Skip to content

save read/write bytes rate per second in its raw value, save humanized versions separately. #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sni merged 2 commits into from
Feb 13, 2026
Merged

save read/write bytes rate per second in its raw value, save humanized versions separately. #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cba114
save read/write bytes rate per second in its raw value, save humanize…
Feb 13, 2026
844c9c9
add "/s" to the rates
Feb 13, 2026
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
52 changes: 27 additions & 25 deletions docs/checks/commands/check_drive_io.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Naemon Config
| empty-syntax | %(status) - No drives found |
| top-syntax | %(status) - %(list) |
| ok-syntax | %(status) - %(list) |
| detail-syntax | %(drive){{ IF label ne '' }} (%(label)){{ END }} >%(write_bytes_rate) <%(read_bytes_rate) %(utilization)% |
| detail-syntax | %(drive){{ IF label ne '' }} (%(label)){{ END }} >%(write_bytes_rate_humanized) <%(read_bytes_rate_humanized) %(utilization)% |

## Check Specific Arguments

Expand All @@ -69,27 +69,29 @@ Naemon Config

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

| Attribute | Description |
| ---------------- | -------------------------------------------------------------------------------------------------- |
| drive | Name(s) of the drives to check the io stats for. If left empty, it will check all drives. For Windows this is the drive letter. For UNIX it is the logical name of the drive. |
| lookback | Lookback period for which the value change rate and utilization is calculated. |
| read_count | Total number of read operations completed successfully |
| read_count_rate | Number of read operations per second during the lookback period |
| read_bytes | Total number of bytes read from the disk |
| read_bytes_rate | Average bytes read per second during the lookback period |
| read_time | Total time spent on read operations (milliseconds). |
| write_count | Total number of write operations completed successfully |
| write_count_rate | Number of write operations per second during the lookback period |
| write_bytes | Total number of bytes written to the disk |
| write_bytes_rate | Average bytes written per second during the lookback period |
| write_time | Total time spent on write operations (milliseconds). |
| label | Label of the drive. Windows does not report this. |
| io_time | Total time during which the disk had at least one active I/O (milliseconds). Windows does not report this. |
| io_time_rate | Change in I/O time per second. Windows does not report this. |
| weighted_io | Measure of both I/O completion time and the number of backlogged requests. Windows does not report this. |
| utilization | Percentage of time the disk was busy (0-100%). Windows does not report this. |
| iops_in_progress | Number of I/O operations currently in flight. Windows does not report this. |
| idle_time | Count of the 100 ns periods the disk was idle. Windows only |
| query_time | The time the performance query was sent. Count of 100 ns periods since the Win32 epoch of 01.01.1601. Windows only |
| queue_depth | The depth of the IO queue. Windows only. |
| split_count | The cumulative count of IOs that are associated IOs. Windows only. |
| Attribute | Description |
| -------------------------- | ---------------------------------------------------------------------------------------- |
| drive | Name(s) of the drives to check the io stats for. If left empty, it will check all drives. For Windows this is the drive letter. For UNIX it is the logical name of the drive. |
| lookback | Lookback period for which the value change rate and utilization is calculated. |
| read_count | Total number of read operations completed successfully |
| read_count_rate | Number of read operations per second during the lookback period |
| read_bytes | Total number of bytes read from the disk |
| read_bytes_rate | Average bytes read per second during the lookback period |
| read_bytes_rate_humanized | Average bytes read per second during the lookback period, written in humanized format |
| read_time | Total time spent on read operations (milliseconds). |
| write_count | Total number of write operations completed successfully |
| write_count_rate | Number of write operations per second during the lookback period |
| write_bytes | Total number of bytes written to the disk |
| write_bytes_rate | Average bytes written per second during the lookback period |
| write_bytes_rate_humanized | Average bytes read per second during the lookback period, written in humanized format |
| write_time | Total time spent on write operations (milliseconds). |
| label | Label of the drive. Windows does not report this. |
| io_time | Total time during which the disk had at least one active I/O (milliseconds). Windows does not report this. |
| io_time_rate | Change in I/O time per second. Windows does not report this. |
| weighted_io | Measure of both I/O completion time and the number of backlogged requests. Windows does not report this. |
| utilization | Percentage of time the disk was busy (0-100%). Windows does not report this. |
| iops_in_progress | Number of I/O operations currently in flight. Windows does not report this. |
| idle_time | Count of the 100 ns periods the disk was idle. Windows only |
| query_time | The time the performance query was sent. Count of 100 ns periods since the Win32 epoch of 01.01.1601. Windows only |
| queue_depth | The depth of the IO queue. Windows only. |
| split_count | The cumulative count of IOs that are associated IOs. Windows only. |
9 changes: 4 additions & 5 deletions pkg/snclient/check_drive_io.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import (
"time"

"github.com/consol-monitoring/snclient/pkg/convert"
"github.com/consol-monitoring/snclient/pkg/humanize"
"github.com/shirou/gopsutil/v4/disk"
)

Expand Down Expand Up @@ -53,7 +52,7 @@ func (l *CheckDriveIO) Build() *CheckData {
defaultWarning: "utilization > 95",
defaultCritical: "",
okSyntax: "%(status) - %(list)",
detailSyntax: "%(drive){{ IF label ne '' }} (%(label)){{ END }} >%(write_bytes_rate) <%(read_bytes_rate) %(utilization)%",
detailSyntax: "%(drive){{ IF label ne '' }} (%(label)){{ END }} >%(write_bytes_rate_humanized) <%(read_bytes_rate_humanized) %(utilization)%",
topSyntax: "%(status) - %(list)",
emptyState: CheckExitUnknown,
emptySyntax: "%(status) - No drives found",
Expand All @@ -65,11 +64,13 @@ func (l *CheckDriveIO) Build() *CheckData {
{name: "read_count_rate", description: "Number of read operations per second during the lookback period"},
{name: "read_bytes", description: "Total number of bytes read from the disk", unit: UByte},
{name: "read_bytes_rate", description: "Average bytes read per second during the lookback period", unit: UByte},
{name: "read_bytes_rate_humanized", description: "Average bytes read per second during the lookback period, written in humanized format"},
{name: "read_time", description: "Total time spent on read operations (milliseconds)."},
{name: "write_count", description: "Total number of write operations completed successfully"},
{name: "write_count_rate", description: "Number of write operations per second during the lookback period"},
{name: "write_bytes", description: "Total number of bytes written to the disk", unit: UByte},
{name: "write_bytes_rate", description: "Average bytes written per second during the lookback period", unit: UByte},
{name: "write_bytes_rate_humanized", description: "Average bytes read per second during the lookback period, written in humanized format"},
{name: "write_time", description: "Total time spent on write operations (milliseconds)."},

// Windows does not report these
Expand Down Expand Up @@ -207,9 +208,7 @@ func (l *CheckDriveIO) addRateToEntry(snc *Agent, entry map[string]string, entry
log.Debugf("Error when getting the counter rate, lookback: %d, counterCategory: %s, counterKey: %s, err: %s", l.lookback, counterCategory, counterKey, err.Error())
}

humanizedBytes := humanize.IBytesF(uint64(rate), 1)

entry[entryKey] = fmt.Sprintf("%v/s", humanizedBytes)
entry[entryKey] = fmt.Sprintf("%f", rate)
}

func cleanupDriveName(drive string) (deviceLogicalNameOrLetter string) {
Expand Down
7 changes: 7 additions & 0 deletions pkg/snclient/check_drive_io_other.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"fmt"

"github.com/consol-monitoring/snclient/pkg/convert"
"github.com/consol-monitoring/snclient/pkg/humanize"
"github.com/shirou/gopsutil/v4/disk"
)

Expand Down Expand Up @@ -50,12 +51,18 @@ func (l *CheckDriveIO) buildEntry(snc *Agent, diskIOCounters any, deviceLogicalN
l.addRateToEntry(snc, entry, "read_count_rate", counterCategory, "read_count")
entry["read_bytes"] = fmt.Sprintf("%d", counters.ReadBytes)
l.addRateToEntry(snc, entry, "read_bytes_rate", counterCategory, "read_bytes")
readBytesRateFloat64 := convert.Float64(entry["read_bytes_rate"])
humanizedReadBytesRate := humanize.IBytesF(uint64(readBytesRateFloat64), 1)
entry["read_bytes_rate_humanized"] = humanizedReadBytesRate + "/s"
entry["read_time"] = fmt.Sprintf("%d", counters.ReadTime)

entry["write_count"] = fmt.Sprintf("%d", counters.WriteCount)
l.addRateToEntry(snc, entry, "write_count_rate", counterCategory, "write_count")
entry["write_bytes"] = fmt.Sprintf("%d", counters.WriteBytes)
l.addRateToEntry(snc, entry, "write_bytes_rate", counterCategory, "write_bytes")
writeBytesRateFloat64 := convert.Float64(entry["write_bytes_rate"])
humanizedWriteBytesRate := humanize.IBytesF(uint64(writeBytesRateFloat64), 1)
entry["write_bytes_rate_humanized"] = humanizedWriteBytesRate + "/s"
entry["write_time"] = fmt.Sprintf("%d", counters.WriteTime)

entry["io_time"] = fmt.Sprintf("%d", counters.IoTime)
Expand Down