Consistent use of _size suffix.

Author: samuel-williams-shopify

lib/process/metrics/host/memory.rb

@@ -8,12 +8,12 @@ module Metrics
 		# Per-host (system-wide) memory metrics. Use Host::Memory for total/used/free and swap; use Process::Metrics::Memory for per-process metrics.
 		module Host
 			# Struct for host memory snapshot. All sizes in bytes.
-			# @attribute total [Integer] Total memory (cgroup limit when in a container, else physical RAM).
-			# @attribute used [Integer] Memory in use (total - free).
-			# @attribute free [Integer] Available memory (MemAvailable-style: free + reclaimable).
-			# @attribute swap_total [Integer, nil] Total swap, or nil if not available.
-			# @attribute swap_used [Integer, nil] Swap in use, or nil if not available.
-			Memory = Struct.new(:total, :used, :free, :swap_total, :swap_used) do
+			# @attribute total_size [Integer] Total memory (cgroup limit when in a container, else physical RAM).
+			# @attribute used_size [Integer] Memory in use (total_size - free_size).
+			# @attribute free_size [Integer] Available memory (MemAvailable-style: free + reclaimable).
+			# @attribute swap_total_size [Integer, nil] Total swap, or nil if not available.
+			# @attribute swap_used_size [Integer, nil] Swap in use, or nil if not available.
+			Memory = Struct.new(:total_size, :used_size, :free_size, :swap_total_size, :swap_used_size) do
 				alias as_json to_h
 
 				def to_json(*arguments)

lib/process/metrics/memory.rb

@@ -37,7 +37,7 @@ def self.zero
 			# Total system/host memory in bytes. Delegates to Host::Memory.capture.
 			# @returns [Integer | Nil]
 			def self.total_size
-				Host::Memory.capture&.total
+				Host::Memory.capture&.total_size
 			end
 
 			# Whether the memory usage can be captured on this system.

releases.md

@@ -1,8 +1,12 @@
 # Releases
 
+## Unreleased
+
+  - Consistent use of `_size` suffix.
+
 ## v0.10.0
 
-  - **Host::Memory**: New per-host struct `Process::Metrics::Host::Memory` with `total`, `used`, `free`, `swap_total`, `swap_used` (all bytes). Use `Host::Memory.capture` to get a snapshot; `.supported?` indicates platform support.
+  - **Host::Memory**: New per-host struct `Process::Metrics::Host::Memory` with `total_size`, `used_size`, `free_size`, `swap_total_size`, `swap_used_size` (all bytes). Use `Host::Memory.capture` to get a snapshot; `.supported?` indicates platform support.
 
 ## v0.9.0
 

test/process/host/memory.rb

@@ -7,25 +7,25 @@
 
 describe Process::Metrics::Host::Memory do
 	with ".capture" do
-		it "returns a struct with total, used, free when supported" do
+		it "returns a struct with total_size, used_size, free_size when supported" do
 			host = Process::Metrics::Host::Memory.capture
 			skip "Host::Memory is not available on this platform" unless host
 			expect(host).to be_a(Process::Metrics::Host::Memory)
-			expect(host.total).to be_a(Integer)
-			expect(host.total).to be > 0
-			expect(host.used).to be_a(Integer)
-			expect(host.used).to be >= 0
-			expect(host.free).to be_a(Integer)
-			expect(host.free).to be >= 0
-			expect(host.used + host.free).to be == host.total
+			expect(host.total_size).to be_a(Integer)
+			expect(host.total_size).to be > 0
+			expect(host.used_size).to be_a(Integer)
+			expect(host.used_size).to be >= 0
+			expect(host.free_size).to be_a(Integer)
+			expect(host.free_size).to be >= 0
+			expect(host.used_size + host.free_size).to be == host.total_size
 		end
 
-		it "may include swap_total and swap_used" do
+		it "may include swap_total_size and swap_used_size" do
 			host = Process::Metrics::Host::Memory.capture
 			skip "Host::Memory is not available on this platform" unless host
-			if host.swap_total
-				expect(host.swap_total).to be_a(Integer)
-				expect(host.swap_used).to be_a(Integer) if host.swap_used
+			if host.swap_total_size
+				expect(host.swap_total_size).to be_a(Integer)
+				expect(host.swap_used_size).to be_a(Integer) if host.swap_used_size
 			end
 		end
 
@@ -34,7 +34,7 @@
 			skip "Host::Memory is not available on this platform" unless host
 			json = host.to_json
 			parsed = JSON.parse(json)
-			expect(parsed).to have_keys("total", "used", "free")
+			expect(parsed).to have_keys("total_size", "used_size", "free_size")
 		end
 	end