Update documentation for memory atoms.
Test: m -j
Change-Id: Iec6fbaa330be3abf12f839fdfcd74da0015934bc
diff --git a/cmds/statsd/src/atoms.proto b/cmds/statsd/src/atoms.proto
index f58caff..6518c61 100644
--- a/cmds/statsd/src/atoms.proto
+++ b/cmds/statsd/src/atoms.proto
@@ -2540,15 +2540,19 @@
/*
* Logs the memory stats for a process.
+ *
+ * Pulled from StatsCompanionService for all managed processes (from ActivityManagerService).
*/
message ProcessMemoryState {
// The uid if available. -1 means not available.
optional int32 uid = 1 [(is_uid) = true];
// The process name.
+ // Usually package name, "system" for system server.
+ // Provided by ActivityManagerService.
optional string process_name = 2;
- // oom adj score.
+ // Current OOM score adjustment. Value read from ProcessRecord.
optional int32 oom_adj_score = 3;
// # of page-faults
@@ -2558,12 +2562,18 @@
optional int64 page_major_fault = 5;
// RSS
+ // Value is read from /proc/PID/stat, field 24. Or from memory.stat, field
+ // total_rss if per-app memory cgroups are enabled.
optional int64 rss_in_bytes = 6;
// CACHE
+ // Value is read from memory.stat, field total_cache if per-app memory
+ // cgroups are enabled. Otherwise, 0.
optional int64 cache_in_bytes = 7;
// SWAP
+ // Value is read from memory.stat, field total_swap if per-app memory
+ // cgroups are enabled. Otherwise, 0.
optional int64 swap_in_bytes = 8;
// Deprecated: use ProcessMemoryHighWaterMark atom instead. Always 0.
@@ -2576,12 +2586,15 @@
/*
* Logs the memory stats for a native process (from procfs).
+ *
+ * Pulled from StatsCompanionService for selected native processes.
*/
message NativeProcessMemoryState {
// The uid if available. -1 means not available.
optional int32 uid = 1 [(is_uid) = true];
// The process name.
+ // Value read from /proc/PID/cmdline.
optional string process_name = 2;
// # of page-faults
@@ -2591,6 +2604,7 @@
optional int64 page_major_fault = 4;
// RSS
+ // Value read from /proc/PID/stat, field 24.
optional int64 rss_in_bytes = 5;
// Deprecated: use ProcessMemoryHighWaterMark atom instead. Always 0.
@@ -2603,13 +2617,17 @@
/*
* Logs the memory high-water mark for a process.
- * Recorded in ActivityManagerService.
+ *
+ * Pulled from StatsCompanionService for all managed processes (from ActivityManagerServie)
+ * and for selected native processes.
*/
message ProcessMemoryHighWaterMark {
// The uid if available. -1 means not available.
optional int32 uid = 1 [(is_uid) = true];
- // The process name. Provided by ActivityManagerService or read from /proc/PID/cmdline.
+ // The process name.
+ // Usually package name or process cmdline.
+ // Provided by ActivityManagerService or read from /proc/PID/cmdline.
optional string process_name = 2;
// RSS high-water mark. Peak RSS usage of the process. Read from the VmHWM field in
@@ -3586,4 +3604,4 @@
*/
message DocsUIInvalidScopedAccessRequestReported {
optional android.stats.docsui.InvalidScopedAccess type = 1;
-}
\ No newline at end of file
+}