System.Diagnostics Tracing APIs (#35220)

* System.Diagnostics Tracing APIs * address the feedback
dotnet · Apr 23, 2020 · 8baf392 · 8baf392
1 parent d09c058
commit 8baf392
Show file tree

Hide file tree

Showing 16 changed files with 1,650 additions and 47 deletions.
diff --git a/...es/System.Diagnostics.DiagnosticSource/ref/System.Diagnostics.DiagnosticSourceActivity.cs b/...es/System.Diagnostics.DiagnosticSource/ref/System.Diagnostics.DiagnosticSourceActivity.cs
@@ -7,7 +7,7 @@
 
 namespace System.Diagnostics
 {
-    public partial class Activity
+    public partial class Activity : IDisposable
     {
         public Activity(string operationName) { }
         public System.Diagnostics.ActivityTraceFlags ActivityTraceFlags { get { throw null; } set { } }
@@ -33,8 +33,13 @@ public string? Id
 #endif
             get { throw null; }
         }
+
+        public bool IsAllDataRequested { get { throw null; } set { throw null; }}
         public System.Diagnostics.ActivityIdFormat IdFormat { get { throw null; } }
+        public System.Diagnostics.ActivityKind Kind  { get { throw null; } }
         public string OperationName { get { throw null; } }
+        public string DisplayName { get { throw null; } set { throw null; } }
+        public System.Diagnostics.ActivitySource Source { get { throw null; } }
         public System.Diagnostics.Activity? Parent { get { throw null; } }
         public string? ParentId { get { throw null; } }
         public System.Diagnostics.ActivitySpanId ParentSpanId { get { throw null; } }
@@ -43,9 +48,12 @@ public string? Id
         public System.Diagnostics.ActivitySpanId SpanId { get { throw null; } }
         public System.DateTime StartTimeUtc { get { throw null; } }
         public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string?>> Tags { get { throw null; } }
+        public System.Collections.Generic.IEnumerable<System.Diagnostics.ActivityEvent> Events { get { throw null; } }
+        public System.Collections.Generic.IEnumerable<System.Diagnostics.ActivityLink> Links { get { throw null; } }
         public System.Diagnostics.ActivityTraceId TraceId { get { throw null; } }
         public string? TraceStateString { get { throw null; } set { } }
         public System.Diagnostics.Activity AddBaggage(string key, string? value) { throw null; }
+        public System.Diagnostics.Activity AddEvent(System.Diagnostics.ActivityEvent e) { throw null; }
         public System.Diagnostics.Activity AddTag(string key, string? value) { throw null; }
         public string? GetBaggageItem(string key) { throw null; }
         public System.Diagnostics.Activity SetEndTime(System.DateTime endTimeUtc) { throw null; }
@@ -54,7 +62,12 @@ public string? Id
         public System.Diagnostics.Activity SetParentId(string parentId) { throw null; }
         public System.Diagnostics.Activity SetStartTime(System.DateTime startTimeUtc) { throw null; }
         public System.Diagnostics.Activity Start() { throw null; }
-        public void Stop() { }
+        public void Stop() { throw null; }
+        public void Dispose()  { throw null; }
+        protected virtual void Dispose(bool disposing) { throw null; }
+        public void SetCustomProperty(string propertyName, object? propertyValue) { throw null; }
+        public object? GetCustomProperty(string propertyName) { throw null; }
+        public ActivityContext Context { get { throw null; } }
     }
     public enum ActivityIdFormat
     {
@@ -82,6 +95,18 @@ public void CopyTo(System.Span<byte> destination) { }
         public string ToHexString() { throw null; }
         public override string ToString() { throw null; }
     }
+    public sealed class ActivitySource : IDisposable
+    {
+        public ActivitySource(string name, string? version = "") { throw null; }
+        public string Name { get { throw null; } }
+        public string? Version { get { throw null; } }
+        public bool HasListeners() { throw null; }
+        public System.Diagnostics.Activity? StartActivity(string name, System.Diagnostics.ActivityKind kind = ActivityKind.Internal)  { throw null; }
+        public System.Diagnostics.Activity? StartActivity(string name, System.Diagnostics.ActivityKind kind, System.Diagnostics.ActivityContext parentContext, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string?>>? tags = null, System.Collections.Generic.IEnumerable<System.Diagnostics.ActivityLink>? links = null, System.DateTimeOffset startTime = default) { throw null; }
+        public System.Diagnostics.Activity? StartActivity(string name, System.Diagnostics.ActivityKind kind, string parentId, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string?>>? tags = null, System.Collections.Generic.IEnumerable<System.Diagnostics.ActivityLink>? links = null, System.DateTimeOffset startTime = default) { throw null; }
+        public static void AddActivityListener(System.Diagnostics.ActivityListener listener) { throw null; }
+        public void Dispose() { throw null; }
+    }
     [System.FlagsAttribute]
     public enum ActivityTraceFlags
     {
@@ -121,4 +146,76 @@ public virtual void OnActivityImport(System.Diagnostics.Activity activity, objec
         public System.Diagnostics.Activity StartActivity(System.Diagnostics.Activity activity, object? args) { throw null; }
         public void StopActivity(System.Diagnostics.Activity activity, object? args) { }
     }
+    public enum ActivityDataRequest
+    {
+        None,
+        PropagationData,
+        AllData,
+        AllDataAndRecorded
+    }
+    public enum ActivityKind
+    {
+        Internal = 0,
+        Server = 1,
+        Client = 2,
+        Producer = 3,
+        Consumer = 4,
+    }
+    public readonly struct ActivityEvent
+    {
+        public ActivityEvent(string name) {throw null; }
+        public ActivityEvent(string name, System.DateTimeOffset timestamp) { throw null; }
+        public ActivityEvent(string name, System.DateTimeOffset timestamp, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>? attributes) { throw null; }
+        public ActivityEvent(string name, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>? attributes) { throw null; }
+        public string Name { get { throw null; } }
+        public System.DateTimeOffset Timestamp { get { throw null; } }
+        public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>? Attributes { get { throw null; } }
+    }
+    public readonly struct ActivityContext : System.IEquatable<System.Diagnostics.ActivityContext>
+    {
+        public ActivityContext(System.Diagnostics.ActivityTraceId traceId, System.Diagnostics.ActivitySpanId spanId, System.Diagnostics.ActivityTraceFlags traceOptions, string? traceState = null) { throw null; }
+        public System.Diagnostics.ActivityTraceId TraceId  { get { throw null; } }
+        public System.Diagnostics.ActivitySpanId SpanId  { get { throw null; } }
+        public System.Diagnostics.ActivityTraceFlags TraceFlags  { get { throw null; } }
+        public string? TraceState  { get { throw null; } }
+        public static bool operator ==(System.Diagnostics.ActivityContext left, System.Diagnostics.ActivityContext right) { throw null; }
+        public static bool operator !=(System.Diagnostics.ActivityContext left, System.Diagnostics.ActivityContext right) { throw null; }
+        public bool Equals(System.Diagnostics.ActivityContext value) { throw null; }
+        public override bool Equals(object? obj) { throw null; }
+        public override int GetHashCode() { throw null; }
+    }
+    public readonly struct ActivityLink : IEquatable<ActivityLink>
+    {
+        public ActivityLink(System.Diagnostics.ActivityContext context) { throw null; }
+        public ActivityLink(System.Diagnostics.ActivityContext context, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>? attributes) { throw null; }
+        public System.Diagnostics.ActivityContext Context  { get { throw null; } }
+        public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>? Attributes  { get { throw null; } }
+
+        public override bool Equals(object? obj) { throw null; }
+        public bool Equals(System.Diagnostics.ActivityLink value) { throw null; }
+        public static bool operator ==(System.Diagnostics.ActivityLink left, System.Diagnostics.ActivityLink right) { throw null; }
+        public static bool operator !=(System.Diagnostics.ActivityLink left, System.Diagnostics.ActivityLink right) { throw null; }
+        public override int GetHashCode()  { throw null; }
+    }
+    public readonly struct ActivityCreationOptions<T>
+    {
+        public System.Diagnostics.ActivitySource Source  { get { throw null; } }
+        public string Name  { get { throw null; } }
+        public System.Diagnostics.ActivityKind Kind  { get { throw null; } }
+        public T Parent  { get { throw null; } }
+        public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string?>> Tags  { get { throw null; } }
+        public System.Collections.Generic.IEnumerable<System.Diagnostics.ActivityLink> Links  { get { throw null; } }
+    }
+    public delegate System.Diagnostics.ActivityDataRequest GetRequestedData<T>(ref System.Diagnostics.ActivityCreationOptions<T> options);
+    public sealed class ActivityListener : IDisposable
+    {
+        public ActivityListener() { throw null; }
+        public System.Action<System.Diagnostics.Activity>? ActivityStarted { get { throw null; } set { } }
+        public System.Action<System.Diagnostics.Activity>? ActivityStopped { get { throw null; } set { } }
+        public System.Func<System.Diagnostics.ActivitySource, bool>? ShouldListenTo { get { throw null; } set { } }
+        public System.Diagnostics.GetRequestedData<string>? GetRequestedDataUsingParentId { get { throw null; } set { } }
+        public System.Diagnostics.GetRequestedData<ActivityContext>? GetRequestedDataUsingContext { get { throw null; } set { } }
+        public void Dispose() { throw null; }
+   }
 }
+
diff --git a/src/libraries/System.Diagnostics.DiagnosticSource/src/Resources/Strings.resx b/src/libraries/System.Diagnostics.DiagnosticSource/src/Resources/Strings.resx
@@ -1,17 +1,17 @@
 <?xml version="1.0" encoding="utf-8"?>
 <root>
-  <!-- 
-    Microsoft ResX Schema 
-    
+  <!--
+    Microsoft ResX Schema
+
     Version 2.0
-    
-    The primary goals of this format is to allow a simple XML format 
-    that is mostly human readable. The generation and parsing of the 
-    various data types are done through the TypeConverter classes 
+
+    The primary goals of this format is to allow a simple XML format
+    that is mostly human readable. The generation and parsing of the
+    various data types are done through the TypeConverter classes
     associated with the data types.
-    
+
     Example:
-    
+
     ... ado.net/XML headers & schema ...
     <resheader name="resmimetype">text/microsoft-resx</resheader>
     <resheader name="version">2.0</resheader>
@@ -26,36 +26,36 @@
         <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
         <comment>This is a comment</comment>
     </data>
-                
-    There are any number of "resheader" rows that contain simple 
+
+    There are any number of "resheader" rows that contain simple
     name/value pairs.
-    
-    Each data row contains a name, and value. The row also contains a 
-    type or mimetype. Type corresponds to a .NET class that support 
-    text/value conversion through the TypeConverter architecture. 
-    Classes that don't support this are serialized and stored with the 
+
+    Each data row contains a name, and value. The row also contains a
+    type or mimetype. Type corresponds to a .NET class that support
+    text/value conversion through the TypeConverter architecture.
+    Classes that don't support this are serialized and stored with the
     mimetype set.
-    
-    The mimetype is used for serialized objects, and tells the 
-    ResXResourceReader how to depersist the object. This is currently not 
+
+    The mimetype is used for serialized objects, and tells the
+    ResXResourceReader how to depersist the object. This is currently not
     extensible. For a given mimetype the value must be set accordingly:
-    
-    Note - application/x-microsoft.net.object.binary.base64 is the format 
-    that the ResXResourceWriter will generate, however the reader can 
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format
+    that the ResXResourceWriter will generate, however the reader can
     read any of the formats listed below.
-    
+
     mimetype: application/x-microsoft.net.object.binary.base64
-    value   : The object must be serialized with 
+    value   : The object must be serialized with
             : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
             : and then encoded with base64 encoding.
-    
+
     mimetype: application/x-microsoft.net.object.soap.base64
-    value   : The object must be serialized with 
+    value   : The object must be serialized with
             : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
             : and then encoded with base64 encoding.
 
     mimetype: application/x-microsoft.net.object.bytearray.base64
-    value   : The object must be serialized into a byte array 
+    value   : The object must be serialized into a byte array
             : using a System.ComponentModel.TypeConverter
             : and then encoded with base64 encoding.
     -->
@@ -144,9 +144,15 @@
   <data name="SetFormatOnStartedActivity" xml:space="preserve">
     <value>"Can not change format for an activity that was already started"</value>
   </data>
+  <data name="SetLinkInvalid" xml:space="preserve">
+    <value>"Can not add link to activity after it has been started"</value>
+  </data>
   <data name="SetParentIdOnActivityWithParent" xml:space="preserve">
     <value>"Can not set ParentId on activity which has parent"</value>
   </data>
+  <data name="SpanIdOrTraceIdInvalid" xml:space="preserve">
+    <value>"Invalid SpanId or TraceId"</value>
+  </data>
   <data name="StartTimeNotUtc" xml:space="preserve">
     <value>"StartTime is not UTC"</value>
   </data>

diff --git a/...raries/System.Diagnostics.DiagnosticSource/src/System.Diagnostics.DiagnosticSource.csproj b/...raries/System.Diagnostics.DiagnosticSource/src/System.Diagnostics.DiagnosticSource.csproj
@@ -32,6 +32,14 @@
       <Link>Common\System\HexConverter.cs</Link>
     </Compile>
     <Compile Include="System\Diagnostics\Activity.cs" />
+    <Compile Include="System\Diagnostics\ActivityContext.cs" />
+    <Compile Include="System\Diagnostics\ActivityCreationOptions.cs" />
+    <Compile Include="System\Diagnostics\ActivityDataRequest.cs" />
+    <Compile Include="System\Diagnostics\ActivityEvent.cs" />
+    <Compile Include="System\Diagnostics\ActivityKind.cs" />
+    <Compile Include="System\Diagnostics\ActivityLink.cs" />
+    <Compile Include="System\Diagnostics\ActivityListener.cs" />
+    <Compile Include="System\Diagnostics\ActivitySource.cs" />
     <Compile Include="System\Diagnostics\DiagnosticSourceActivity.cs" />
     <Reference Include="System.Memory" />
     <Reference Include="System.Runtime.CompilerServices.Unsafe" />