From bbefd8ac97455e8d4dca069330c0c9611c9afd39 Mon Sep 17 00:00:00 2001 From: JDA88 <67072186+JDA88@users.noreply.github.com> Date: Thu, 30 Sep 2021 22:56:00 +0200 Subject: [PATCH] Document expected delays in the size metrics Signed-off-by: Ben Reedy --- collector/logical_disk.go | 4 ++-- docs/collector.logical_disk.md | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/collector/logical_disk.go b/collector/logical_disk.go index 2f9d8eea..cf463d3c 100644 --- a/collector/logical_disk.go +++ b/collector/logical_disk.go @@ -103,14 +103,14 @@ func NewLogicalDiskCollector() (Collector, error) { FreeSpace: prometheus.NewDesc( prometheus.BuildFQName(Namespace, subsystem, "free_bytes"), - "Free space in bytes (LogicalDisk.PercentFreeSpace)", + "Free space in bytes, updates every 10-15 min (LogicalDisk.PercentFreeSpace)", []string{"volume"}, nil, ), TotalSpace: prometheus.NewDesc( prometheus.BuildFQName(Namespace, subsystem, "size_bytes"), - "Total space in bytes (LogicalDisk.PercentFreeSpace_Base)", + "Total space in bytes, updates every 10-15 min (LogicalDisk.PercentFreeSpace_Base)", []string{"volume"}, nil, ), diff --git a/docs/collector.logical_disk.md b/docs/collector.logical_disk.md index 489af4b2..479ee2b2 100644 --- a/docs/collector.logical_disk.md +++ b/docs/collector.logical_disk.md @@ -30,11 +30,15 @@ Name | Description | Type | Labels `writes_total` | Rate of write operations on the disk | counter | `volume` `read_seconds_total` | Seconds the disk was busy servicing read requests | counter | `volume` `write_seconds_total` | Seconds the disk was busy servicing write requests | counter | `volume` -`free_bytes` | Unused space of the disk in bytes | gauge | `volume` -`size_bytes` | Total size of the disk in bytes | gauge | `volume` +`free_bytes` | Unused space of the disk in bytes (not real time, updates every 10-15 min) | gauge | `volume` +`size_bytes` | Total size of the disk in bytes (not real time, updates every 10-15 min) | gauge | `volume` `idle_seconds_total` | Seconds the disk was idle (not servicing read/write requests) | counter | `volume` `split_ios_total` | Number of I/Os to the disk split into multiple I/Os | counter | `volume` +### Warning about size metrics +The `free_bytes` and `size_bytes` metrics are not updated in real time and might have a delay of 10-15min. +This is the same behavior as the windows performance counters. + ### Example metric Query the rate of write operations to a disk ```