tp: improve grouping of tables

While not perfect, the new groups make the table diagrams much more legible. Future patches will continue improving the groups. Change-Id: Ib5a6f7c3ac663f1f129339895e077d9615e21333
google · Sep 18, 2023 · 6f28da6 · 6f28da6
1 parent be58c94
commit 6f28da6
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 30 deletions.
diff --git a/src/trace_processor/tables/android_tables.py b/src/trace_processor/tables/android_tables.py
@@ -45,7 +45,7 @@
           NOTE: this table is not sorted by timestamp. This is why we omit the
           sorted flag on the ts column.
         ''',
-        group='Events',
+        group='Android',
         columns={
             'ts': 'Timestamp of log entry.',
             'utid': 'Thread writing the log entry.',
@@ -78,10 +78,10 @@
     tabledoc=TableDoc(
         doc='''
           A table presenting all game modes and interventions
-of games installed on the system.
-This is generated by the game_mode_intervention data-source.
+          of games installed on the system.
+          This is generated by the game_mode_intervention data-source.
         ''',
-        group='Misc',
+        group='Android',
         columns={
             'package_name':
                 '''name of the pakcage, e.g. com.google.android.gm.''',
@@ -140,7 +140,7 @@
         doc='''
           Dumpsys entries from Android dumpstate.
         ''',
-        group='Events',
+        group='Android',
         columns={
             'section':
                 '''name of the dumpstate section.''',

diff --git a/src/trace_processor/tables/metadata_tables.py b/src/trace_processor/tables/metadata_tables.py
@@ -47,7 +47,7 @@
     wrapping_sql_view=WrappingSqlView(view_name='process',),
     tabledoc=TableDoc(
         doc='Contains information of processes seen during the trace',
-        group='Misc',
+        group='Metadata',
         skip_id_and_type=True,
         columns={
             'upid':
@@ -116,7 +116,7 @@
     wrapping_sql_view=WrappingSqlView(view_name='thread',),
     tabledoc=TableDoc(
         doc='Contains information of threads seen during the trace',
-        group='Misc',
+        group='Metadata',
         skip_id_and_type=True,
         columns={
             'utid':
@@ -254,7 +254,7 @@
     ],
     tabledoc=TableDoc(
         doc='''''',
-        group='Misc',
+        group='Metadata',
         columns={
             'name': '''''',
             'key_type': '''''',
@@ -277,7 +277,7 @@
         doc='''
           Contains information of filedescriptors collected during the trace
         ''',
-        group='Misc',
+        group='Metadata',
         columns={
             'ufd':
                 '''Unique fd. This is != the OS fd.
@@ -311,7 +311,7 @@
         doc='''
           Experimental table, subject to arbitrary breaking changes.
         ''',
-        group='Misc',
+        group='Chrome',
         columns={
             'upid': '''''',
             'reliable_from': ''''''

diff --git a/src/trace_processor/tables/slice_tables.py b/src/trace_processor/tables/slice_tables.py
@@ -140,7 +140,7 @@
     parent=SLICE_TABLE,
     tabledoc=TableDoc(
         doc='''''',
-        group='Events',
+        group='Slice',
         columns={
             'context_id': '''''',
             'render_target': '''''',
@@ -169,7 +169,7 @@
     parent=SLICE_TABLE,
     tabledoc=TableDoc(
         doc='''''',
-        group='Events',
+        group='Slice',
         columns={
             'frame_number': '''''',
             'layer_name': '''''',
@@ -191,7 +191,7 @@
     parent=SLICE_TABLE,
     tabledoc=TableDoc(
         doc='''''',
-        group='Events',
+        group='Slice',
         columns={
             'display_frame_token': '''''',
             'surface_frame_token': '''''',
@@ -218,7 +218,7 @@
     parent=SLICE_TABLE,
     tabledoc=TableDoc(
         doc='''''',
-        group='Events',
+        group='Slice',
         columns={
             'display_frame_token': '''''',
             'surface_frame_token': '''''',
@@ -252,7 +252,7 @@
           An experimental table which "flattens" stacks of slices to contain
           only the "deepest" slice at any point in time on each track.
         ''',
-        group='Events',
+        group='Slice',
         columns={
             'ts':
                 '''The timestamp at the start of the slice (in nanoseconds).''',

diff --git a/src/trace_processor/tables/trace_proto_tables.py b/src/trace_processor/tables/trace_proto_tables.py
@@ -37,7 +37,7 @@
         doc='''
           Experimental table, subject to arbitrary breaking changes.
         ''',
-        group='Misc',
+        group='Proto',
         columns={
             'parent_id': '''''',
             'field_type': '''''',
@@ -58,7 +58,7 @@
     ],
     tabledoc=TableDoc(
         doc='''''',
-        group='Misc',
+        group='Proto',
         columns={
             'path': '''''',
             'path_id': '''''',

diff --git a/src/trace_processor/tables/track_tables.py b/src/trace_processor/tables/track_tables.py
@@ -171,7 +171,7 @@
     parent=COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='Tracks containing counter-like events associated to a thread.',
-        group='Tracks',
+        group='Counter Tracks',
         columns={
             'utid':
                 ColumnDoc(
@@ -192,7 +192,7 @@
         doc='''
           Tracks containing counter-like events associated to a process.
         ''',
-        group='Tracks',
+        group='Counter Tracks',
         columns={
             'upid':
                 ColumnDoc(
@@ -210,7 +210,7 @@
     parent=COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='Tracks containing counter-like events associated to a CPU.',
-        group='Tracks',
+        group='Counter Tracks',
         columns={'cpu': 'The CPU this track is associated with'}))
 
 IRQ_COUNTER_TRACK_TABLE = Table(
@@ -223,7 +223,7 @@
     parent=COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='Tracks containing counter-like events associated to an hardirq',
-        group='Tracks',
+        group='Counter Tracks',
         columns={'irq': 'The identifier for the hardirq.'}))
 
 SOFTIRQ_COUNTER_TRACK_TABLE = Table(
@@ -236,7 +236,7 @@
     parent=COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='Tracks containing counter-like events associated to a softirq',
-        group='Tracks',
+        group='Counter Tracks',
         columns={'softirq': 'The identifier for the softirq.'}))
 
 GPU_COUNTER_TRACK_TABLE = Table(
@@ -249,7 +249,7 @@
     parent=COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='Tracks containing counter-like events associated to a GPU',
-        group='Tracks',
+        group='Counter Tracks',
         columns={'gpu_id': 'The identifier for the GPU.'}))
 
 PERF_COUNTER_TRACK_TABLE = Table(
@@ -264,7 +264,7 @@
     parent=COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='Sampled counters\' values for samples in the perf_sample table.',
-        group='Tracks',
+        group='Counter Tracks',
         columns={
             'perf_session_id':
                 'id of a distict profiling stream',
@@ -292,7 +292,7 @@
           Energy consumers' values for energy descriptors in
           energy_estimation_breakdown packet
         ''',
-        group='Tracks',
+        group='Counter Tracks',
         columns={
             'consumer_id': 'id of a distinct energy consumer',
             'consumer_type': 'type of energy consumer',
@@ -309,7 +309,7 @@
     parent=COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='The uid associated with this track',
-        group='Tracks',
+        group='Counter Tracks',
         columns={'uid': 'uid of process for which breakdowns are emitted'}))
 
 ENERGY_PER_UID_COUNTER_TRACK_TABLE = Table(
@@ -322,7 +322,7 @@
     parent=UID_COUNTER_TRACK_TABLE,
     tabledoc=TableDoc(
         doc='Energy consumer values for per uid in uid_counter_track',
-        group='Tracks',
+        group='Counter Tracks',
         columns={'consumer_id': 'id of the consumer process'}))
 
 # Keep this list sorted.

diff --git a/src/trace_processor/tables/winscope_tables.py b/src/trace_processor/tables/winscope_tables.py
@@ -29,7 +29,7 @@
     ],
     tabledoc=TableDoc(
         doc='SurfaceFlinger layers snapshot',
-        group='SurfaceFlinger layers snapshot',
+        group='Winscope',
         columns={
             'ts': 'Timestamp of the snapshot',
             'arg_set_id': 'Extra args parsed from the proto message',
@@ -45,7 +45,7 @@
     ],
     tabledoc=TableDoc(
         doc='SurfaceFlinger layer',
-        group='SurfaceFlinger layer',
+        group='Winscope',
         columns={
             'snapshot_id': 'The snapshot that generated this layer',
             'arg_set_id': 'Extra args parsed from the proto message',
@@ -61,7 +61,7 @@
     ],
     tabledoc=TableDoc(
         doc='SurfaceFlinger transactions. Each row contains a set of transactions that SurfaceFlinger committed together.',
-        group='SurfaceFlinger transactions trace entry',
+        group='Winscope',
         columns={
             'ts': 'Timestamp of the transactions commit',
             'arg_set_id': 'Extra args parsed from the proto message',