ResourceBuilder API

examples/Console/TestConsoleExporter.cs

@@ -35,7 +35,7 @@ internal static object Run(ConsoleOptions options)
             // and use a custom MyProcessor, along with Console exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                 .AddSource("MyCompany.MyProduct.MyWebServer")
-                .SetResource(Resources.CreateServiceResource("MyServiceName"))
+                .SetResource(Resource.Create("MyServiceName"))
                 .AddProcessor(new MyProcessor()) // This must be added before ConsoleExporter
                 .AddConsoleExporter()
                 .Build();

examples/Console/TestHttpClient.cs

@@ -34,7 +34,7 @@ internal static object Run()
 
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
                 .AddHttpClientInstrumentation()
-                .SetResource(Resources.CreateServiceResource("http-service-example"))
+                .SetResource(Resource.Create("http-service-example"))
                 .AddSource("http-client-test")
                 .AddConsoleExporter()
                 .Build();

examples/Console/TestOTelShimWithConsoleExporter.cs

@@ -28,7 +28,7 @@ internal static object Run(OpenTelemetryShimOptions options)
             // and use a single pipeline with a custom MyProcessor, and Console exporter.
             using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                     .AddSource("MyCompany.MyProduct.MyWebServer")
-                    .SetResource(Resources.CreateServiceResource("MyServiceName"))
+                    .SetResource(Resource.Create("MyServiceName"))
                     .AddConsoleExporter()
                     .Build();
 

examples/Console/TestOpenTracingWithConsoleExporter.cs

@@ -31,7 +31,7 @@ internal static object Run(OpenTracingShimOptions options)
             // and use Console exporter.
             using var openTelemetry = Sdk.CreateTracerProviderBuilder()
                     .AddSource("MyCompany.MyProduct.MyWebServer")
-                    .SetResource(Resources.CreateServiceResource("MyServiceName"))
+                    .SetResource(Resource.Create("MyServiceName"))
                     .AddConsoleExporter()
                     .Build();
 

src/OpenTelemetry/.publicApi/net452/PublicAPI.Unshipped.txt

@@ -126,7 +126,6 @@ OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Attributes.get -> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>
 OpenTelemetry.Resources.Resource.Merge(OpenTelemetry.Resources.Resource other) -> OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Resource(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes) -> void
-OpenTelemetry.Resources.Resources
 OpenTelemetry.Sdk
 OpenTelemetry.SimpleExportProcessor<T>
 OpenTelemetry.SimpleExportProcessor<T>.SimpleExportProcessor(OpenTelemetry.BaseExporter<T> exporter) -> void
@@ -233,8 +232,8 @@ override abstract OpenTelemetry.BaseExportProcessor<T>.OnEnd(T data) -> void
 override sealed OpenTelemetry.BaseExportProcessor<T>.OnStart(T data) -> void
 readonly OpenTelemetry.BaseExportProcessor<T>.exporter -> OpenTelemetry.BaseExporter<T>
 static OpenTelemetry.ProviderExtensions.GetResource(this OpenTelemetry.BaseProvider baseProvider) -> OpenTelemetry.Resources.Resource
+static OpenTelemetry.Resources.Resource.Create(string serviceName = null, string serviceNamespace = null, string serviceVersion = null, bool autoGenerateServiceInstanceId = true, string serviceInstanceId = null, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Resources.Resource.Empty.get -> OpenTelemetry.Resources.Resource
-static OpenTelemetry.Resources.Resources.CreateServiceResource(string serviceName, string serviceInstanceId = null, string serviceNamespace = null, string serviceVersion = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Sdk.CreateMeterProviderBuilder() -> OpenTelemetry.Metrics.MeterProviderBuilder
 static OpenTelemetry.Sdk.CreateTracerProviderBuilder() -> OpenTelemetry.Trace.TracerProviderBuilder
 static OpenTelemetry.Sdk.SetDefaultTextMapPropagator(OpenTelemetry.Context.Propagation.TextMapPropagator textMapPropagator) -> void

src/OpenTelemetry/.publicApi/net46/PublicAPI.Unshipped.txt

@@ -126,7 +126,6 @@ OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Attributes.get -> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>
 OpenTelemetry.Resources.Resource.Merge(OpenTelemetry.Resources.Resource other) -> OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Resource(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes) -> void
-OpenTelemetry.Resources.Resources
 OpenTelemetry.Sdk
 OpenTelemetry.SimpleExportProcessor<T>
 OpenTelemetry.SimpleExportProcessor<T>.SimpleExportProcessor(OpenTelemetry.BaseExporter<T> exporter) -> void
@@ -233,8 +232,8 @@ override abstract OpenTelemetry.BaseExportProcessor<T>.OnEnd(T data) -> void
 override sealed OpenTelemetry.BaseExportProcessor<T>.OnStart(T data) -> void
 readonly OpenTelemetry.BaseExportProcessor<T>.exporter -> OpenTelemetry.BaseExporter<T>
 static OpenTelemetry.ProviderExtensions.GetResource(this OpenTelemetry.BaseProvider baseProvider) -> OpenTelemetry.Resources.Resource
+static OpenTelemetry.Resources.Resource.Create(string serviceName = null, string serviceNamespace = null, string serviceVersion = null, bool autoGenerateServiceInstanceId = true, string serviceInstanceId = null, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Resources.Resource.Empty.get -> OpenTelemetry.Resources.Resource
-static OpenTelemetry.Resources.Resources.CreateServiceResource(string serviceName, string serviceInstanceId = null, string serviceNamespace = null, string serviceVersion = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Sdk.CreateMeterProviderBuilder() -> OpenTelemetry.Metrics.MeterProviderBuilder
 static OpenTelemetry.Sdk.CreateTracerProviderBuilder() -> OpenTelemetry.Trace.TracerProviderBuilder
 static OpenTelemetry.Sdk.SetDefaultTextMapPropagator(OpenTelemetry.Context.Propagation.TextMapPropagator textMapPropagator) -> void

src/OpenTelemetry/.publicApi/net461/PublicAPI.Unshipped.txt

@@ -145,7 +145,6 @@ OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Attributes.get -> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>
 OpenTelemetry.Resources.Resource.Merge(OpenTelemetry.Resources.Resource other) -> OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Resource(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes) -> void
-OpenTelemetry.Resources.Resources
 OpenTelemetry.Sdk
 OpenTelemetry.SimpleExportProcessor<T>
 OpenTelemetry.SimpleExportProcessor<T>.SimpleExportProcessor(OpenTelemetry.BaseExporter<T> exporter) -> void
@@ -253,8 +252,8 @@ override sealed OpenTelemetry.BaseExportProcessor<T>.OnStart(T data) -> void
 readonly OpenTelemetry.BaseExportProcessor<T>.exporter -> OpenTelemetry.BaseExporter<T>
 static Microsoft.Extensions.Logging.OpenTelemetryLoggingExtensions.AddOpenTelemetry(this Microsoft.Extensions.Logging.ILoggingBuilder builder, System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions> configure = null) -> Microsoft.Extensions.Logging.ILoggingBuilder
 static OpenTelemetry.ProviderExtensions.GetResource(this OpenTelemetry.BaseProvider baseProvider) -> OpenTelemetry.Resources.Resource
+static OpenTelemetry.Resources.Resource.Create(string serviceName = null, string serviceNamespace = null, string serviceVersion = null, bool autoGenerateServiceInstanceId = true, string serviceInstanceId = null, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Resources.Resource.Empty.get -> OpenTelemetry.Resources.Resource
-static OpenTelemetry.Resources.Resources.CreateServiceResource(string serviceName, string serviceInstanceId = null, string serviceNamespace = null, string serviceVersion = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Sdk.CreateMeterProviderBuilder() -> OpenTelemetry.Metrics.MeterProviderBuilder
 static OpenTelemetry.Sdk.CreateTracerProviderBuilder() -> OpenTelemetry.Trace.TracerProviderBuilder
 static OpenTelemetry.Sdk.SetDefaultTextMapPropagator(OpenTelemetry.Context.Propagation.TextMapPropagator textMapPropagator) -> void

src/OpenTelemetry/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt

@@ -145,7 +145,6 @@ OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Attributes.get -> System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>
 OpenTelemetry.Resources.Resource.Merge(OpenTelemetry.Resources.Resource other) -> OpenTelemetry.Resources.Resource
 OpenTelemetry.Resources.Resource.Resource(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes) -> void
-OpenTelemetry.Resources.Resources
 OpenTelemetry.Sdk
 OpenTelemetry.SimpleExportProcessor<T>
 OpenTelemetry.SimpleExportProcessor<T>.SimpleExportProcessor(OpenTelemetry.BaseExporter<T> exporter) -> void
@@ -253,8 +252,8 @@ override sealed OpenTelemetry.BaseExportProcessor<T>.OnStart(T data) -> void
 readonly OpenTelemetry.BaseExportProcessor<T>.exporter -> OpenTelemetry.BaseExporter<T>
 static Microsoft.Extensions.Logging.OpenTelemetryLoggingExtensions.AddOpenTelemetry(this Microsoft.Extensions.Logging.ILoggingBuilder builder, System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions> configure = null) -> Microsoft.Extensions.Logging.ILoggingBuilder
 static OpenTelemetry.ProviderExtensions.GetResource(this OpenTelemetry.BaseProvider baseProvider) -> OpenTelemetry.Resources.Resource
+static OpenTelemetry.Resources.Resource.Create(string serviceName = null, string serviceNamespace = null, string serviceVersion = null, bool autoGenerateServiceInstanceId = true, string serviceInstanceId = null, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> attributes = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Resources.Resource.Empty.get -> OpenTelemetry.Resources.Resource
-static OpenTelemetry.Resources.Resources.CreateServiceResource(string serviceName, string serviceInstanceId = null, string serviceNamespace = null, string serviceVersion = null) -> OpenTelemetry.Resources.Resource
 static OpenTelemetry.Sdk.CreateMeterProviderBuilder() -> OpenTelemetry.Metrics.MeterProviderBuilder
 static OpenTelemetry.Sdk.CreateTracerProviderBuilder() -> OpenTelemetry.Trace.TracerProviderBuilder
 static OpenTelemetry.Sdk.SetDefaultTextMapPropagator(OpenTelemetry.Context.Propagation.TextMapPropagator textMapPropagator) -> void

src/OpenTelemetry/Resources/Resource.cs

@@ -42,7 +42,7 @@ public class Resource
         /// <summary>
         /// Initializes a new instance of the <see cref="Resource"/> class.
         /// </summary>
-        /// <param name="attributes">An <see cref="IDictionary{String, Object}"/> of attributes that describe the resource.</param>
+        /// <param name="attributes">An <see cref="IEnumerable{T}"/> of attributes that describe the resource.</param>
         public Resource(IEnumerable<KeyValuePair<string, object>> attributes)
         {
             if (attributes == null)
@@ -73,6 +73,63 @@ public Resource(IEnumerable<KeyValuePair<string, object>> attributes)
                 new KeyValuePair<string, object>(TelemetrySdkVersionKey, Version.ToString()),
             });
 
+        /// <summary>
+        /// Creates a new <see cref="Resource"/> from service information following standard convention
+        /// https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-resource-semantic-conventions.md#service.
+        /// </summary>
+        /// <param name="serviceName">Optional name of the service.</param>
+        /// <param name="serviceNamespace">Optional namespace of the service.</param>
+        /// <param name="serviceVersion">Optional version of the service.</param>
+        /// <param name="autoGenerateServiceInstanceId">Specify <see langword="true"/> to automatically generate a <see cref="Guid"/> for <paramref name="serviceInstanceId"/> if not supplied.</param>
+        /// <param name="serviceInstanceId">Optional unique identifier of the service instance.</param>
+        /// <param name="attributes">Optional <see cref="IEnumerable{T}"/> of attributes that describe the service.</param>
+        /// <returns>Returns a new <see cref="Resource"/>.</returns>
+        public static Resource Create(
+            string serviceName = null,
+            string serviceNamespace = null,
+            string serviceVersion = null,
+            bool autoGenerateServiceInstanceId = true,
+            string serviceInstanceId = null,
+            IEnumerable<KeyValuePair<string, object>> attributes = null)
+        {
+            Dictionary<string, object> resourceAttributes = new Dictionary<string, object>();
+
+            if (attributes != null)
+            {
+                foreach (KeyValuePair<string, object> attribute in attributes.Select(SanitizeAttribute).ToList())
+                {
+                    resourceAttributes[attribute.Key] = attribute.Value;
+                }
+            }
+
+            if (!string.IsNullOrEmpty(serviceName))
+            {
+                resourceAttributes.Add(ServiceNameKey, serviceName);
+            }
+
+            if (!string.IsNullOrEmpty(serviceNamespace))
+            {
+                resourceAttributes.Add(ServiceNamespaceKey, serviceNamespace);
+            }
+
+            if (!string.IsNullOrEmpty(serviceVersion))
+            {
+                resourceAttributes.Add(ServiceVersionKey, serviceVersion);
+            }
+
+            if (serviceInstanceId == null && autoGenerateServiceInstanceId)
+            {
+                serviceInstanceId = Guid.NewGuid().ToString();
+            }
+
+            if (serviceInstanceId != null)
+            {
+                resourceAttributes.Add(ServiceInstanceIdKey, serviceInstanceId);
+            }
+
+            return new Resource(resourceAttributes).GetResourceWithDefaultAttributes();
+        }
+
         /// <summary>
         /// Returns a new, merged <see cref="Resource"/> by merging the current <see cref="Resource"/> with the.
         /// <code>other</code> <see cref="Resource"/>. In case of a collision the current <see cref="Resource"/> takes precedence.

test/Benchmarks/Instrumentation/InstrumentedHttpClientBenchmark.cs

@@ -30,7 +30,7 @@ namespace Benchmarks.Instrumentation
     public class InstrumentedHttpClientBenchmark
     {
         private const string ActivityName = "incoming request";
-        private const string ResourceName = "http-service-example";
+        private const string ServiceName = "http-service-example";
         private const string SourceName = "http-client-test";
 
         private HttpClient httpClient;
@@ -53,7 +53,7 @@ public void GlobalSetup()
 
             this.tracerProvider = Sdk.CreateTracerProviderBuilder()
                 .AddHttpClientInstrumentation()
-                .SetResource(Resources.CreateServiceResource(ResourceName))
+                .SetResource(Resource.Create(ServiceName))
                 .AddSource(SourceName)
                 .Build();
 

test/OpenTelemetry.Exporter.Jaeger.Tests/JaegerExporterTests.cs

@@ -57,11 +57,11 @@ public void JaegerTraceExporter_SetResource_UpdatesServiceName()
 
             Assert.Equal("TestService", process.ServiceName);
 
-            jaegerTraceExporter.SetResource(Resources.Resources.CreateServiceResource("MyService"));
+            jaegerTraceExporter.SetResource(Resource.Create("MyService"));
 
             Assert.Equal("MyService", process.ServiceName);
 
-            jaegerTraceExporter.SetResource(Resources.Resources.CreateServiceResource("MyService", serviceNamespace: "MyNamespace"));
+            jaegerTraceExporter.SetResource(Resource.Create("MyService", "MyNamespace"));
 
             Assert.Equal("MyNamespace.MyService", process.ServiceName);
         }