[dns] color key for track event for discussion

Author: LalitMaganti

include/perfetto/public/protos/trace/interned_data/interned_data.pzc.h

@@ -213,5 +213,10 @@ PERFETTO_PB_FIELD(perfetto_protos_InternedData,
                   perfetto_protos_AppWakelockInfo,
                   app_wakelock_info,
                   42);
+PERFETTO_PB_FIELD(perfetto_protos_InternedData,
+                  MSG,
+                  perfetto_protos_InternedString,
+                  correlation_id_str,
+                  43);
 
 #endif  // INCLUDE_PERFETTO_PUBLIC_PROTOS_TRACE_INTERNED_DATA_INTERNED_DATA_PZC_H_

include/perfetto/public/protos/trace/track_event/track_event.pzc.h

@@ -170,6 +170,21 @@ PERFETTO_PB_FIELD(perfetto_protos_TrackEvent,
                   uint64_t,
                   terminating_flow_ids,
                   48);
+PERFETTO_PB_FIELD(perfetto_protos_TrackEvent,
+                  VARINT,
+                  uint64_t,
+                  correlation_id,
+                  52);
+PERFETTO_PB_FIELD(perfetto_protos_TrackEvent,
+                  STRING,
+                  const char*,
+                  correlation_id_str,
+                  53);
+PERFETTO_PB_FIELD(perfetto_protos_TrackEvent,
+                  VARINT,
+                  uint64_t,
+                  correlation_id_str_iid,
+                  54);
 PERFETTO_PB_FIELD(perfetto_protos_TrackEvent,
                   MSG,
                   perfetto_protos_DebugAnnotation,

protos/perfetto/trace/interned_data/interned_data.proto

@@ -56,7 +56,7 @@ package perfetto.protos;
 // emitted proactively in advance of referring to them in later packets.
 //
 // Next reserved id: 8 (up to 15).
-// Next id: 43.
+// Next id: 44.
 message InternedData {
   // TODO(eseckler): Replace iid fields inside interned messages with
   // map<iid, message> type fields in InternedData.
@@ -145,6 +145,9 @@ message InternedData {
   // Interned context for android.app_wakelocks.
   repeated AppWakelockInfo app_wakelock_info = 42;
 
+  // Interned correlation ids in track_event.
+  repeated InternedString correlation_id_str = 43;
+
   // removed ProfiledFrameSymbols profiled_frame_symbols
   reserved 21;
 }

protos/perfetto/trace/perfetto_trace.proto

@@ -13717,7 +13717,7 @@ message TaskExecution {
 // their default track association) can be emitted as part of a
 // TrackEventDefaults message.
 //
-// Next reserved id: 13 (up to 15). Next id: 52.
+// Next reserved id: 13 (up to 15). Next id: 55.
 message TrackEvent {
   // Names of categories of the event. In the client library, categories are a
   // way to turn groups of individual events on or off.
@@ -13846,6 +13846,46 @@ message TrackEvent {
   // "terminating_flow_ids" to reduce memory consumption.
   repeated fixed64 terminating_flow_ids = 48;
 
+  // An opaque identifier to correlate this slice with other slices that are
+  // considered part of the same logical operation, even if they are not
+  // causally connected. Examples uses of a correlation id might be the number
+  // of frame going through various stages of rendering in a GPU, the id for an
+  // RPC request going through a distributed system, or the id of a network
+  // request going through various stages of processing by the kernel.
+  //
+  // NOTE: if the events *are* causually connected, you probably want to use
+  // flows instead of OR in addition to correlation ids.
+  //
+  // UIs can use this identifier to visually link these slices, for instance,
+  // by assigning them a consistent color or highlighting the entire correlated
+  // set when one slice is hovered.
+  //
+  // Only one field within this 'oneof' should be set to define the correlation.
+  oneof correlation_id_field {
+    // A 64-bit unsigned integer used as the correlation ID.
+    //
+    // Best for performance and compact traces if the identifier is naturally
+    // numerical or can be easily mapped to one by the trace producer.
+    uint64 correlation_id = 52;
+
+    // A string value used as the correlation ID.
+    //
+    // Offers maximum flexibility for human-readable or complex identifiers
+    // (e.g., GUIDs). Note: Using many unique, long strings may increase trace
+    // size. For frequently repeated string identifiers, consider
+    // 'correlation_id_string_iid'.
+    string correlation_id_str = 53;
+
+    // An interned string identifier (an IID) for correlation.
+    //
+    // This 64-bit ID refers to a string defined in the 'correlation_id_str'
+    // field within the packet sequence's InternedData. This approach combines
+    // the descriptiveness and uniqueness of strings with the efficiency of
+    // integer IDs for storage and comparison, especially for identifiers that
+    // repeat across many events.
+    uint64 correlation_id_str_iid = 54;
+  }
+
   // ---------------------------------------------------------------------------
   // TrackEvent arguments:
   // ---------------------------------------------------------------------------
@@ -14086,7 +14126,7 @@ message EventName {
 // emitted proactively in advance of referring to them in later packets.
 //
 // Next reserved id: 8 (up to 15).
-// Next id: 43.
+// Next id: 44.
 message InternedData {
   // TODO(eseckler): Replace iid fields inside interned messages with
   // map<iid, message> type fields in InternedData.
@@ -14175,6 +14215,9 @@ message InternedData {
   // Interned context for android.app_wakelocks.
   repeated AppWakelockInfo app_wakelock_info = 42;
 
+  // Interned correlation ids in track_event.
+  repeated InternedString correlation_id_str = 43;
+
   // removed ProfiledFrameSymbols profiled_frame_symbols
   reserved 21;
 }

protos/perfetto/trace/track_event/track_descriptor.proto

@@ -110,12 +110,16 @@ message TrackDescriptor {
   // |extra_counter_values|).
   optional CounterDescriptor counter = 8;
 
+  // Deprecated: prefer use of `sbling_merge_behavior` instead: this option
+  // is equvaient to `SIBLING_MERGE_BEHAVIOR_NONE` or
+  // `SIBLING_MERGE_BEHAVIOR_BY_MERGE_KEY` with a unique key.
+  //
   // If true, forces Trace Processor to use separate tracks for track events
   // and system events for the same thread.
   // Track events timestamps in Chrome have microsecond resolution, while
   // system events use nanoseconds. It results in broken event nesting when
   // track events and system events share a track.
-  optional bool disallow_merging_with_system_tracks = 9;
+  optional bool disallow_merging_with_system_tracks = 9 [deprecated = true];
 
   // Specifies how the UI should display child tracks of this track (i.e. tracks
   // where `parent_uuid` is specified to this track `uuid`). Note that this

protos/perfetto/trace/track_event/track_event.proto

@@ -103,7 +103,7 @@ package perfetto.protos;
 // their default track association) can be emitted as part of a
 // TrackEventDefaults message.
 //
-// Next reserved id: 13 (up to 15). Next id: 52.
+// Next reserved id: 13 (up to 15). Next id: 55.
 message TrackEvent {
   // Names of categories of the event. In the client library, categories are a
   // way to turn groups of individual events on or off.
@@ -232,6 +232,46 @@ message TrackEvent {
   // "terminating_flow_ids" to reduce memory consumption.
   repeated fixed64 terminating_flow_ids = 48;
 
+  // An opaque identifier to correlate this slice with other slices that are
+  // considered part of the same logical operation, even if they are not
+  // causally connected. Examples uses of a correlation id might be the number
+  // of frame going through various stages of rendering in a GPU, the id for an
+  // RPC request going through a distributed system, or the id of a network
+  // request going through various stages of processing by the kernel.
+  //
+  // NOTE: if the events *are* causually connected, you probably want to use
+  // flows instead of OR in addition to correlation ids.
+  //
+  // UIs can use this identifier to visually link these slices, for instance,
+  // by assigning them a consistent color or highlighting the entire correlated
+  // set when one slice is hovered.
+  //
+  // Only one field within this 'oneof' should be set to define the correlation.
+  oneof correlation_id_field {
+    // A 64-bit unsigned integer used as the correlation ID.
+    //
+    // Best for performance and compact traces if the identifier is naturally
+    // numerical or can be easily mapped to one by the trace producer.
+    uint64 correlation_id = 52;
+
+    // A string value used as the correlation ID.
+    //
+    // Offers maximum flexibility for human-readable or complex identifiers
+    // (e.g., GUIDs). Note: Using many unique, long strings may increase trace
+    // size. For frequently repeated string identifiers, consider
+    // 'correlation_id_string_iid'.
+    string correlation_id_str = 53;
+
+    // An interned string identifier (an IID) for correlation.
+    //
+    // This 64-bit ID refers to a string defined in the 'correlation_id_str'
+    // field within the packet sequence's InternedData. This approach combines
+    // the descriptiveness and uniqueness of strings with the efficiency of
+    // integer IDs for storage and comparison, especially for identifiers that
+    // repeat across many events.
+    uint64 correlation_id_str_iid = 54;
+  }
+
   // ---------------------------------------------------------------------------
   // TrackEvent arguments:
   // ---------------------------------------------------------------------------