Add code comment

elastic · Nov 15, 2023 · d17fbb1 · d17fbb1
1 parent 35d8f27
commit d17fbb1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/Elastic.Apm/Metrics/Linux/GlobalMemoryStatus.cs b/src/Elastic.Apm/Metrics/Linux/GlobalMemoryStatus.cs
@@ -63,6 +63,10 @@ internal static (long totalMemory, long availableMemory) GetTotalAndAvailableSys
 
 				try
 				{
+					// We read from the file into our rented buffer so that we can parse data from the meminfo file.
+					// Specifically, we try to parse the values for `MemAvailable` and `MemTotal`. When these values 
+					// use the KB unit, we multiply them to return bytes.
+
 					var read = fs.Read(buffer);
 
 					if (read == 0)