Support Telemetry Schema Url in tracing and metrics

src/libraries/System.Diagnostics.DiagnosticSource/ref/System.Diagnostics.DiagnosticSourceActivity.cs

@@ -26,12 +26,12 @@ public string? Id
         }
 
         public bool HasRemoteParent { get { throw null; } }
-        public bool IsAllDataRequested { get { throw null; } set { throw null; } }
+        public bool IsAllDataRequested { get { throw null; } set { } }
         public bool IsStopped { get { 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 string DisplayName { get { throw null; } set { } }
         public System.Diagnostics.ActivitySource Source { get { throw null; } }
         public System.Diagnostics.Activity? Parent { get { throw null; } }
         public string? ParentId { get { throw null; } }
@@ -59,7 +59,7 @@ public string? Id
         public string? GetBaggageItem(string key) { throw null; }
         public object? GetTagItem(string key) { throw null; }
         public System.Diagnostics.Activity SetEndTime(System.DateTime endTimeUtc) { throw null; }
-        public static Func<System.Diagnostics.ActivityTraceId>? TraceIdGenerator { get { throw null; } set { throw null; } }
+        public static Func<System.Diagnostics.ActivityTraceId>? TraceIdGenerator { get { throw null; } set { } }
         public System.Diagnostics.Activity SetIdFormat(System.Diagnostics.ActivityIdFormat format) { throw null; }
         public System.Diagnostics.Activity SetParentId(System.Diagnostics.ActivityTraceId traceId, System.Diagnostics.ActivitySpanId spanId, System.Diagnostics.ActivityTraceFlags activityTraceFlags = System.Diagnostics.ActivityTraceFlags.None) { throw null; }
         public System.Diagnostics.Activity SetParentId(string parentId) { throw null; }
@@ -155,8 +155,10 @@ public sealed class ActivitySource : IDisposable
         [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
         public ActivitySource(string name, string? version = "") { throw null; }
         public ActivitySource(string name, string? version = "", System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object?>>? tags = default) { throw null; }
+        public ActivitySource(ActivitySourceOptions options) { throw null; }
         public string Name { get { throw null; } }
         public string? Version { get { throw null; } }
+        public string? TelemetrySchemaUrl { get; }
         public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object?>>? Tags { get { throw null; } }
         public bool HasListeners() { throw null; }
         public System.Diagnostics.Activity? CreateActivity(string name, System.Diagnostics.ActivityKind kind) { throw null; }
@@ -169,6 +171,14 @@ public sealed class ActivitySource : IDisposable
         public static void AddActivityListener(System.Diagnostics.ActivityListener listener) { throw null; }
         public void Dispose() { throw null; }
     }
+    public class ActivitySourceOptions
+    {
+        public ActivitySourceOptions(string name) { throw null; }
+        public string Name { get { throw null; } set { } }
+        public string? Version { get { throw null; } set { } }
+        public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object?>>? Tags { get { throw null; } set { } }
+        public string? TelemetrySchemaUrl { get { throw null; } set { } }
+    }
     [System.FlagsAttribute]
     public enum ActivityTraceFlags
     {
@@ -281,12 +291,12 @@ public readonly struct ActivityCreationOptions<T>
     public sealed class ActivityListener : IDisposable
     {
         public ActivityListener() { throw null; }
-        public System.Action<System.Diagnostics.Activity>? ActivityStarted { get { throw null; } set { throw null; } }
-        public System.Action<System.Diagnostics.Activity>? ActivityStopped { get { throw null; } set { throw null; } }
-        public System.Diagnostics.ExceptionRecorder? ExceptionRecorder { get { throw null; } set { throw null; } }
-        public System.Func<System.Diagnostics.ActivitySource, bool>? ShouldListenTo { get { throw null; } set { throw null; } }
-        public System.Diagnostics.SampleActivity<string>? SampleUsingParentId { get { throw null; } set { throw null; } }
-        public System.Diagnostics.SampleActivity<ActivityContext>? Sample { get { throw null; } set { 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.Diagnostics.ExceptionRecorder? ExceptionRecorder { get { throw null; } set { } }
+        public System.Func<System.Diagnostics.ActivitySource, bool>? ShouldListenTo { get { throw null; } set { } }
+        public System.Diagnostics.SampleActivity<string>? SampleUsingParentId { get { throw null; } set { } }
+        public System.Diagnostics.SampleActivity<ActivityContext>? Sample { get { throw null; } set { } }
         public void Dispose() { throw null; }
     }
     public abstract class DistributedContextPropagator
@@ -565,6 +575,7 @@ public ObservableGauge<T> CreateObservableGauge<T>(
         public string? Version { get { throw null; } }
         public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object?>>? Tags { get { throw null; }  }
         public object? Scope { get { throw null; }  }
+        public string? TelemetrySchemaUrl { get { throw null; }  }
     }
     public static class MeterFactoryExtensions
     {
@@ -575,19 +586,20 @@ public sealed class MeterListener : IDisposable
         public object? DisableMeasurementEvents(Instrument instrument) { throw null; }
         public void Dispose() { throw null; }
         public void EnableMeasurementEvents(Instrument instrument, object? state = null) { throw null; }
-        public Action<Instrument, MeterListener>? InstrumentPublished { get { throw null; } set { throw null; } }
-        public Action<Instrument, object?>? MeasurementsCompleted { get { throw null; } set { throw null; } }
+        public Action<Instrument, MeterListener>? InstrumentPublished { get { throw null; } set { } }
+        public Action<Instrument, object?>? MeasurementsCompleted { get { throw null; } set { } }
         public MeterListener() { throw null; }
         public void RecordObservableInstruments() { throw null; }
         public void SetMeasurementEventCallback<T>(MeasurementCallback<T>? measurementCallback) where T : struct { throw null; }
         public void Start() { throw null; }
     }
     public class MeterOptions
     {
-        public string Name { get { throw null;} set { throw null;} }
-        public string? Version { get { throw null;} set { throw null;} }
-        public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? Tags { get { throw null;} set { throw null;} }
-        public object? Scope { get { throw null;} set { throw null;} }
+        public string Name { get { throw null;} set { } }
+        public string? Version { get { throw null;} set { } }
+        public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? Tags { get { throw null;} set { } }
+        public object? Scope { get { throw null;} set { } }
+        public string? TelemetrySchemaUrl { get { throw null;} set { } }
         public MeterOptions(string name) { throw null;}
     }
     public sealed class ObservableCounter<T> : ObservableInstrument<T> where T : struct

src/libraries/System.Diagnostics.DiagnosticSource/src/System.Diagnostics.DiagnosticSource.csproj

@@ -40,6 +40,7 @@ System.Diagnostics.DiagnosticSource</PackageDescription>
     <Compile Include="System\Diagnostics\ActivityLink.cs" />
     <Compile Include="System\Diagnostics\ActivityListener.cs" />
     <Compile Include="System\Diagnostics\ActivitySource.cs" />
+    <Compile Include="System\Diagnostics\ActivitySourceOptions.cs" />
     <Compile Include="System\Diagnostics\DiagnosticSource.cs" />
     <Compile Include="System\Diagnostics\DiagnosticSourceActivity.cs" />
     <Compile Include="System\Diagnostics\DiagnosticListener.cs" />

src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/ActivitySource.cs

@@ -18,26 +18,35 @@ public sealed class ActivitySource : IDisposable
         /// Construct an ActivitySource object with the input name
         /// </summary>
         /// <param name="name">The name of the ActivitySource object</param>
-        public ActivitySource(string name) : this(name, version: "", tags: null) {}
+        public ActivitySource(string name) : this(name, version: "", tags: null, telemetrySchemaUrl: null) {}
 
         /// <summary>
         /// Construct an ActivitySource object with the input name
         /// </summary>
         /// <param name="name">The name of the ActivitySource object</param>
         /// <param name="version">The version of the component publishing the tracing info.</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
-        public ActivitySource(string name, string? version = "") : this(name, version, tags: null) {}
+        public ActivitySource(string name, string? version = "") : this(name, version, tags: null, telemetrySchemaUrl: null) {}
 
         /// <summary>
         /// Construct an ActivitySource object with the input name
         /// </summary>
         /// <param name="name">The name of the ActivitySource object</param>
         /// <param name="version">The version of the component publishing the tracing info.</param>
         /// <param name="tags">The optional ActivitySource tags.</param>
-        public ActivitySource(string name, string? version = "", IEnumerable<KeyValuePair<string, object?>>? tags = default)
+        public ActivitySource(string name, string? version = "", IEnumerable<KeyValuePair<string, object?>>? tags = default) : this(name, version, tags, telemetrySchemaUrl: null) {}
+
+        /// <summary>
+        /// Initialize a new instance of the ActivitySource object using the <see cref="ActivitySourceOptions" />.
+        /// </summary>
+        /// <param name="options">The <see cref="ActivitySourceOptions" /> object to use for initializing the ActivitySource object.</param>
+        public ActivitySource(ActivitySourceOptions options) : this((options ?? throw new ArgumentNullException(nameof(options))).Name, options.Version, options.Tags, options.TelemetrySchemaUrl) {}
+
+        private ActivitySource(string name, string? version, IEnumerable<KeyValuePair<string, object?>>? tags, string? telemetrySchemaUrl)
         {
             Name = name ?? throw new ArgumentNullException(nameof(name));
             Version = version;
+            TelemetrySchemaUrl = telemetrySchemaUrl;
 
             // Sorting the tags to make sure the tags are always in the same order.
             // Sorting can help in comparing the tags used for any scenario.
@@ -84,6 +93,11 @@ public ActivitySource(string name, string? version = "", IEnumerable<KeyValuePai
         /// </summary>
         public IEnumerable<KeyValuePair<string, object?>>? Tags { get; }
 
+        /// <summary>
+        /// Returns the telemetry schema URL associated with the ActivitySource.
+        /// </summary>
+        public string? TelemetrySchemaUrl { get; }
+
         /// <summary>
         /// Check if there is any listeners for this ActivitySource.
         /// This property can be helpful to tell if there is no listener, then no need to create Activity object

src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/ActivitySourceOptions.cs

@@ -0,0 +1,49 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Generic;
+
+namespace System.Diagnostics
+{
+    /// <summary>
+    /// Options for creating a <see cref="ActivitySource"/>.
+    /// </summary>
+    public class ActivitySourceOptions
+    {
+        private string _name;
+
+        /// <summary>
+        /// Constructs a new instance of <see cref="ActivitySourceOptions"/>.
+        /// </summary>
+        /// <param name="name">The name of the <see cref="ActivitySourceOptions"/> object</param>
+        public ActivitySourceOptions(string name)
+        {
+            _name = name ?? throw new ArgumentNullException(nameof(name));
+        }
+
+        /// <summary>
+        /// Get or set the <see cref="ActivitySourceOptions"/> object name. Cannot be null.
+        /// </summary>
+        public string Name
+        {
+            get => _name;
+            set => _name = value ?? throw new ArgumentNullException(nameof(value));
+        }
+
+        /// <summary>
+        /// The optional <see cref="ActivitySourceOptions"/> version. Defaulted to empty string.
+        /// </summary>
+        public string? Version { get; set; } = string.Empty;
+
+        /// <summary>
+        /// The optional list of key-value pair tags associated with the <see cref="ActivitySourceOptions"/>.
+        /// </summary>
+        public IEnumerable<KeyValuePair<string, object?>>? Tags { get; set; }
+
+        /// <summary>
+        /// The optional schema URL specifies a location of a <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/file_format_v1.1.0.md">Schema File</see> that
+        /// can be retrieved using HTTP or HTTPS protocol.
+        /// </summary>
+        public string? TelemetrySchemaUrl { get; set; }
+    }
+}

src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Meter.cs

@@ -39,7 +39,7 @@ public Meter(MeterOptions options)
 
             Debug.Assert(options.Name is not null);
 
-            Initialize(options.Name, options.Version, options.Tags, options.Scope);
+            Initialize(options.Name, options.Version, options.Tags, options.Scope, options.TelemetrySchemaUrl);
 
             Debug.Assert(Name is not null);
         }
@@ -71,11 +71,11 @@ public Meter(string name, string? version) : this(name, version, null, null) { }
         /// </remarks>
         public Meter(string name, string? version, IEnumerable<KeyValuePair<string, object?>>? tags, object? scope = null)
         {
-            Initialize(name, version, tags, scope);
+            Initialize(name, version, tags, scope, telemetrySchemaUrl: null);
             Debug.Assert(Name is not null);
         }
 
-        private void Initialize(string name, string? version, IEnumerable<KeyValuePair<string, object?>>? tags, object? scope = null)
+        private void Initialize(string name, string? version, IEnumerable<KeyValuePair<string, object?>>? tags, object? scope = null, string? telemetrySchemaUrl = null)
         {
             Name = name ?? throw new ArgumentNullException(nameof(name));
             Version = version;
@@ -86,6 +86,7 @@ private void Initialize(string name, string? version, IEnumerable<KeyValuePair<s
                 Tags = tagList.AsReadOnly();
             }
             Scope = scope;
+            TelemetrySchemaUrl = telemetrySchemaUrl;
 
             if (!IsSupported)
             {
@@ -121,6 +122,12 @@ private void Initialize(string name, string? version, IEnumerable<KeyValuePair<s
         /// </summary>
         public object? Scope { get; private set; }
 
+        /// <summary>
+        /// The optional schema URL specifies a location of a <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/file_format_v1.1.0.md">Schema File</see> that
+        /// can be retrieved using HTTP or HTTPS protocol.
+        /// </summary>
+        public string? TelemetrySchemaUrl { get; private set; }
+
         /// <summary>
         /// Create a metrics Counter object.
         /// </summary>

src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/MeterOptions.cs

@@ -18,15 +18,7 @@ public class MeterOptions
         public string Name
         {
             get => _name;
-            set
-            {
-                if (value is null)
-                {
-                    throw new ArgumentNullException(nameof(value));
-                }
-
-                _name = value;
-            }
+            set => _name = value ?? throw new ArgumentNullException(nameof(value));
         }
 
         /// <summary>
@@ -44,6 +36,12 @@ public string Name
         /// </summary>
         public object? Scope { get; set; }
 
+        /// <summary>
+        /// The optional schema URL specifies a location of a <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/schemas/file_format_v1.1.0.md">Schema File</see> that
+        /// can be retrieved using HTTP or HTTPS protocol.
+        /// </summary>
+        public string? TelemetrySchemaUrl { get; set; }
+
         /// <summary>
         /// Constructs a new instance of <see cref="MeterOptions"/>.
         /// </summary>