Add and show LTTNG provider column for generic event table (#100)

* Parse out and expose the Provider name for TraceLogging-generated generic events in LTTng, enabling a much simpler view that better matches the view for generic events in ETW and Perfetto.

* Enable per-trace string interning to save some memory

* Bump versions of LTTngCds and LTTngDataExtensions

* For LTTNG's generic event table, default to not showing the Provider column

Co-authored-by: James Dooley <[email protected]>

Author: jamesdooleymsft

LTTngCds/CookerData/LTTngContext.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using CtfPlayback.Inputs;
 using CtfPlayback.Metadata.Interfaces;
 using LTTngCds.CtfExtensions;
@@ -18,6 +19,7 @@ public class LTTngContext
         private readonly LTTngMetadataCustomization metadata;
         private readonly ICtfInputStream eventStream;
         private readonly TraceContext traceContext;
+        private ISet<string> stringDictionary = new HashSet<string>();
 
         internal LTTngContext(LTTngMetadataCustomization metadata, ICtfInputStream eventStream, TraceContext traceContext)
         {
@@ -31,6 +33,19 @@ internal LTTngContext(LTTngMetadataCustomization metadata, ICtfInputStream event
         /// </summary>
         public IReadOnlyDictionary<string, ICtfClockDescriptor> Clocks => this.metadata.Metadata.ClocksByName;
 
+        /// <summary>
+        /// Intern (de-duplicate) string to save memory.
+        /// </summary>
+        public string Intern(string input)
+        {
+            if (stringDictionary.Contains(input))
+            {
+                return stringDictionary.First(item => item.Equals(input));
+            }
+            stringDictionary.Add(input);
+            return input;
+        }
+        
         /// <inheritdoc />
         public long Timestamp { get; internal set; }
 

LTTngCds/LTTngCds.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	<Version>1.2.2</Version>
+	<Version>1.3.0</Version>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft Corp.</Company>

LTTngDataExtensions/DataOutputTypes/LTTngGenericEvent.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Text.RegularExpressions;
 using CtfPlayback;
 using CtfPlayback.FieldValues;
 using LTTngCds.CookerData;
@@ -45,13 +46,24 @@ public override int GetHashCode()
 
         public string Domain { get; }
         public uint Id { get; }
+        public string ProviderName { get; }
         public string EventName { get; }
         public readonly List<string> FieldNames;
-        public EventKind(string domain, uint id, string name, IReadOnlyList<CtfFieldValue> fields)
+        public EventKind(LTTngContext context, uint id, string name, IReadOnlyList<CtfFieldValue> fields)
         {
-            this.Domain = domain;
+            this.Domain = context.Domain;
             this.Id = id;
-            this.EventName = name;
+            Match traceLoggingMatch = TraceLoggingEventRegex.Match(name);
+            if (traceLoggingMatch.Success)
+            {
+                this.ProviderName = context.Intern(traceLoggingMatch.Groups["ProviderName"].Value);
+                this.EventName = context.Intern(traceLoggingMatch.Groups["EventName"].Value);
+            }
+            else
+            {
+                this.ProviderName = "Unknown";
+                this.EventName = context.Intern(name);
+            }
             this.FieldNames = new List<string>(fields.Count);
             foreach (var field in fields)
             {
@@ -60,16 +72,17 @@ public EventKind(string domain, uint id, string name, IReadOnlyList<CtfFieldValu
         }
 
         private static readonly Dictionary<Key, EventKind> RegisteredKinds = new Dictionary<Key, EventKind>();
+        private static readonly Regex TraceLoggingEventRegex = new Regex("^(?<ProviderName>[a-zA-Z_.0-9]+):(?<EventName>[a-zA-Z_.0-9]+);(?<Unknown>.+);$");
 
         public static bool TryGetRegisteredKind(string domain, uint id, out EventKind kind)
         {
             return RegisteredKinds.TryGetValue(new Key(domain, id), out kind);
         }
 
-        public static EventKind RegisterKind(string domain, uint id, string name, IReadOnlyList<CtfFieldValue> fields)
+        public static EventKind RegisterKind(LTTngContext context, uint id, string name, IReadOnlyList<CtfFieldValue> fields)
         {
-            EventKind kind = new EventKind(domain, id, name, fields);
-            RegisteredKinds.Add(new Key(domain, id), kind);
+            EventKind kind = new EventKind(context, id, name, fields);
+            RegisteredKinds.Add(new Key(context.Domain, id), kind);
             return kind;
         }
     }
@@ -92,7 +105,7 @@ public LTTngGenericEvent(LTTngEvent data, LTTngContext context)
 
             if (!EventKind.TryGetRegisteredKind(context.Domain, data.Id, out this.kind))
             {
-                this.kind = EventKind.RegisterKind(context.Domain, data.Id, data.Name, payload.Fields);
+                this.kind = EventKind.RegisterKind(context, data.Id, data.Name, payload.Fields);
             }
 
             // As this is being written, all columns are of type 'T', so all rows are the same. For generic events,
@@ -129,6 +142,8 @@ public LTTngGenericEvent(LTTngEvent data, LTTngContext context)
             }
         }
 
+        public string ProviderName => this.kind.ProviderName;
+
         public string EventName => this.kind.EventName;
 
         public Timestamp Timestamp { get; }

LTTngDataExtensions/LTTngDataExtensions.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	<Version>1.2.5</Version>
+	<Version>1.3.0</Version>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft Corp.</Company>

LTTngDataExtensions/Resources/GenericEventTablePrebuiltConfigurations.json

@@ -21,6 +21,21 @@
                         }
                     ],
                   "Columns": [
+                    {
+                      "DisplayHints": {
+                        "AggregationMode": 0,
+                        "IsVisible": false,
+                        "SortOrder": 0,
+                        "SortPriority": 0,
+                        "TextAlignment": 0,
+                        "Width": 200
+                      },
+                      "Metadata": {
+                        "Description": "Provider",
+                        "Guid": "0ABDBEDE-8B10-4660-ACCA-3F41FCE90D25",
+                        "Name": "Provider"
+                      }
+                    },
                     {
                       "DisplayHints": {
                         "AggregationMode": 0,

LTTngDataExtensions/Tables/GenericEventTable.cs

@@ -24,6 +24,14 @@ public class GenericEventTable
             "All events in the LTTng trace",
             "Linux LTTng");
 
+        private static readonly ColumnConfiguration providerNameColumnConfig = new ColumnConfiguration(
+            new ColumnMetadata(new Guid("{0ABDBEDE-8B10-4660-ACCA-3F41FCE90D25}"), "Provider"),
+            new UIHints
+            {
+                IsVisible = true,
+                Width = 200,
+            });
+
         private static readonly ColumnConfiguration eventNameColumnConfig = new ColumnConfiguration(
             new ColumnMetadata(new Guid("{8132DED0-8FE7-4533-B139-4C81133A7BCD}"), "Name"),
             new UIHints
@@ -91,6 +99,11 @@ public static void BuildTable(ITableBuilder tableBuilder, IDataExtensionRetrieva
 
             var genericEventProjection = new EventProjection<LTTngGenericEvent>(events);
 
+            var providerNameColumn = new DataColumn<string>(
+                providerNameColumnConfig,
+                genericEventProjection.Compose((genericEvent) => genericEvent.ProviderName));
+            tableGenerator.AddColumn(providerNameColumn);
+
             var eventNameColumn = new DataColumn<string>(
                 eventNameColumnConfig,
                 genericEventProjection.Compose((genericEvent) => genericEvent.EventName));