Add 'title' option for meminfo action

Add an optional 'title' field for a meminfo action that is included in
the meminfo performance mark. This is useful for determining at what
point in a loading test a meminfo dump is from. If no title is supplied,
the current info stack is used.

Change-Id: I1dbf37a6d9e733b64c2e308e50b94333254daf4c
Reviewed-on: https://chromium-review.googlesource.com/c/crossbench/+/6666731
Commit-Queue: Kameron Lutes <[email protected]>
Reviewed-by: Charles Dick <[email protected]>

Author: kalutes

crossbench/action_runner/action/meminfo.py

@@ -42,15 +42,18 @@ def config_parser(cls: Type[ActionT]) -> ConfigParser[ActionT]:
         "target", type=MeminfoTarget, default=MeminfoTarget.BROWSER)
     parser.add_argument(
         "package", type=ObjectParser.non_empty_str, default=None)
+    parser.add_argument("title", type=ObjectParser.non_empty_str, default=None)
     return parser
 
   def __init__(self,
                target: MeminfoTarget = MeminfoTarget.BROWSER,
                package: Optional[str] = None,
+               title: Optional[str] = None,
                timeout: dt.timedelta = ACTION_TIMEOUT,
                index: int = 0) -> None:
     self._target = target
     self._package = package
+    self._title = title
     super().__init__(timeout, index)
 
   @override
@@ -68,12 +71,18 @@ def target(self) -> MeminfoTarget:
   def package(self) -> Optional[str]:
     return self._package
 
+  @property
+  def title(self) -> Optional[str]:
+    return self._title
+
   @override
   def to_json(self) -> JsonDict:
     details = super().to_json()
     details["target"] = self.target
     if self.package:
       details["package"] = self.package
+    if self.title:
+      details["title"] = self.title
     return details
 
   @override

crossbench/action_runner/default_action_runner.py

@@ -374,7 +374,8 @@ def dump_meminfo_impl(self, run: Run, action: i_action.MeminfoAction) -> None:
       logging.warning("No meminfo probe for dump on %s", repr(self.info_stack))
       return
     assert isinstance(ctx, MeminfoProbeContext)
-    ctx.dump_meminfo(action.target, action.timeout, action.package)
+    ctx.dump_meminfo(action.target, action.timeout, action.package,
+                     action.title or "_".join(self.info_stack))
 
   def wait_for_download(self, run: Run,
                         action: i_action.WaitForDownloadAction) -> None:

crossbench/probes/meminfo.py

@@ -7,7 +7,7 @@
 import csv
 import dataclasses
 import datetime as dt
-from typing import TYPE_CHECKING, Optional, Self, Type
+from typing import TYPE_CHECKING, Any, Optional, Self, Type
 
 from typing_extensions import override
 
@@ -61,7 +61,7 @@ def stop(self) -> None:
     pass
 
   def dump_meminfo(self, target: MeminfoTarget, timeout: dt.timedelta,
-                   package: Optional[str]) -> None:
+                   package: Optional[str], title: str) -> None:
     timestamp = self.browser_platform.sh_stdout("date",
                                                 "+%Y-%m-%d %H:%M:%S").rstrip()
 
@@ -74,12 +74,12 @@ def dump_meminfo(self, target: MeminfoTarget, timeout: dt.timedelta,
     else:
       raise ValueError("Cannot dump meminfo without package name.")
 
-    meminfo_json = []
+    meminfo_json: dict[str, Any] = {"title": title, "meminfos": []}
     for proc_name, proc_meminfo in meminfo.items():
       proc_data = dataclasses.asdict(proc_meminfo)
       proc_data["timestamp"] = timestamp
       proc_data["name"] = proc_name
-      meminfo_json.append(proc_data)
+      meminfo_json["meminfos"].append(proc_data)
 
     self.browser.performance_mark("meminfo", detail=meminfo_json)
 
@@ -107,7 +107,7 @@ def dump_meminfo(self, target: MeminfoTarget, timeout: dt.timedelta,
       )
       if write_header:
         writer.writeheader()
-      writer.writerows(meminfo_json)
+      writer.writerows(meminfo_json["meminfos"])
 
   @override
   def teardown(self) -> ProbeResult:

tests/crossbench/benchmarks/loading/test_action.py

@@ -975,6 +975,7 @@ def test_parse_meminfo_default(self):
     self.assertEqual(action.TYPE, ActionType.MEMINFO)
     self.assertEqual(action.target, MeminfoTarget.BROWSER)
     self.assertIsNone(action.package)
+    self.assertIsNone(action.title)
 
     action_2 = MeminfoAction.parse_dict(action.to_json())
     self.assertEqual(action, action_2)
@@ -992,6 +993,17 @@ def test_parse_meminfo_browser(self):
     self.assertEqual(action, action_2)
     action_2.validate()
 
+  def test_parse_meminfo_title(self):
+    config_dict = {"action": "meminfo", "title": "a_title"}
+    action = MeminfoAction.parse_dict(config_dict)
+    action.validate()
+    self.assertEqual(action.TYPE, ActionType.MEMINFO)
+    self.assertEqual(action.title, "a_title")
+
+    action_2 = MeminfoAction.parse_dict(action.to_json())
+    self.assertEqual(action, action_2)
+    action_2.validate()
+
   def test_parse_meminfo_invalid_target(self):
     config_dict = {"action": "meminfo", "target": "notatarget"}
 

tests/crossbench/probes/test_meminfo.py

@@ -63,48 +63,58 @@ def test_meminfo_dumped(self):
     meminfo_detail = self.browsers[0].performance_marks_details[
         self.browsers[0].performance_marks.index("crossbench-meminfo")]
 
-    self.assertEqual(meminfo_detail, [
-        {
-            "timestamp": "2025-05-20 12:45:59",
-            "pid": 1,
-            "name": "process_1",
-            "pss_total": 2,
-            "rss_total": 3,
-            "swap_total": 4
-        },
-        {
-            "timestamp": "2025-05-20 12:45:59",
-            "pid": 2,
-            "name": "process_2",
-            "pss_total": 3,
-            "rss_total": 4,
-            "swap_total": 5
-        },
-    ])
+    self.assertEqual(
+        meminfo_detail, {
+            "title":
+                "block_0_action_2",
+            "meminfos": [
+                {
+                    "timestamp": "2025-05-20 12:45:59",
+                    "pid": 1,
+                    "name": "process_1",
+                    "pss_total": 2,
+                    "rss_total": 3,
+                    "swap_total": 4
+                },
+                {
+                    "timestamp": "2025-05-20 12:45:59",
+                    "pid": 2,
+                    "name": "process_2",
+                    "pss_total": 3,
+                    "rss_total": 4,
+                    "swap_total": 5
+                },
+            ]
+        })
 
     self.assertTrue("crossbench-meminfo" in self.browsers[1].performance_marks)
 
     meminfo_detail = self.browsers[1].performance_marks_details[
         self.browsers[1].performance_marks.index("crossbench-meminfo")]
 
-    self.assertEqual(meminfo_detail, [
-        {
-            "timestamp": "2025-05-20 12:45:59",
-            "pid": 1,
-            "name": "process_1",
-            "pss_total": 2,
-            "rss_total": 3,
-            "swap_total": 4
-        },
-        {
-            "timestamp": "2025-05-20 12:45:59",
-            "pid": 2,
-            "name": "process_2",
-            "pss_total": 3,
-            "rss_total": 4,
-            "swap_total": 5
-        },
-    ])
+    self.assertEqual(
+        meminfo_detail, {
+            "title":
+                "block_0_action_2",
+            "meminfos": [
+                {
+                    "timestamp": "2025-05-20 12:45:59",
+                    "pid": 1,
+                    "name": "process_1",
+                    "pss_total": 2,
+                    "rss_total": 3,
+                    "swap_total": 4
+                },
+                {
+                    "timestamp": "2025-05-20 12:45:59",
+                    "pid": 2,
+                    "name": "process_2",
+                    "pss_total": 3,
+                    "rss_total": 4,
+                    "swap_total": 5
+                },
+            ]
+        })
 
 
 if __name__ == "__main__":