Merge branch 'main' into main

.vscode/settings.json

@@ -41,6 +41,7 @@
     "tracestate",
     "Tracestate",
     "triager",
+    "typeparam",
     "umesan",
     "unencrypted",
     "unvalidated",

docs/metrics/customizing-the-sdk/Program.cs

@@ -18,6 +18,7 @@
 using System.Diagnostics.Metrics;
 using OpenTelemetry;
 using OpenTelemetry.Metrics;
+using OpenTelemetry.Resources;
 
 namespace CustomizingTheSdk;
 
@@ -29,6 +30,7 @@ public class Program
     public static void Main()
     {
         using var meterProvider = Sdk.CreateMeterProviderBuilder()
+            .ConfigureResource(res => res.AddService("example-service"))
             .AddMeter(Meter1.Name)
             .AddMeter(Meter2.Name)
 

docs/metrics/customizing-the-sdk/README.md

@@ -427,4 +427,37 @@ Refer to the individual exporter docs to learn how to use them:
 
 ### Resource
 
-// TODO
+[Resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md)
+is the immutable representation of the entity producing the telemetry. If no
+`Resource` is explicitly configured, the
+[default](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#semantic-attributes-with-sdk-provided-default-value)
+is to use a resource indicating this
+[Service](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service).
+The `ConfigureResource` method on `MeterProviderBuilder` can be used to set a
+configure the resource on the provider. When the provider is built, it
+automatically builds the final `Resource` from the configured `ResourceBuilder`.
+There can only be a single `Resource` associated with a
+provider. It is not possible to change the resource builder *after* the provider
+is built, by calling the `Build()` method on the `MeterProviderBuilder`.
+`ResourceBuilder` offers various methods to construct resource comprising of
+multiple attributes from various sources.
+
+The snippet below shows configuring the `Resource` associated with the provider.
+
+```csharp
+using OpenTelemetry;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Resources;
+
+using var meterProvider = Sdk.CreateMeterProviderBuilder()
+    .ConfigureResource(r => r.AddService("MyServiceName"))
+    .Build();
+```
+
+It is also possible to configure the `Resource` by using following
+environmental variables:
+
+| Environment variable       | Description                                        |
+| -------------------------- | -------------------------------------------------- |
+| `OTEL_RESOURCE_ATTRIBUTES` | Key-value pairs to be used as resource attributes. See the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. |
+| `OTEL_SERVICE_NAME`        | Sets the value of the `service.name` resource attribute. If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES`, then `OTEL_SERVICE_NAME` takes precedence. |

docs/trace/customizing-the-sdk/README.md

@@ -108,19 +108,154 @@ name starts with "Abc.".
 
 ### Instrumentation
 
-// TODO
+While the OpenTelemetry API can be used to instrument any library manually,
+[Instrumentation
+Libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#instrumentation-libraries)
+are available for a lot of commonly used libraries. Such instrumentations can be
+added to the `TracerProvider`. It is not required to attach the instrumentation
+to the provider, unless the life cycle of the instrumentation must be managed by
+the provider. If the instrumentation must be activated/shutdown/disposed along
+with the provider, then the instrumentation must be added to the provider.
+
+Typically, the instrumentation libraries provide extension methods on
+`TracerProviderBuilder` to allow adding them to the `TracerProvider`. Please
+refer to corresponding documentation of the instrumentation library to know the
+exact method name.
+
+Follow [this](../extending-the-sdk/README.md#instrumentation-library) document
+to learn about the instrumentation libraries shipped from this repo.
 
 ### Processor
 
-// TODO
+[Processors](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#span-processor)
+allows hooks for start and end of `Activity`. If no processors are configured,
+then traces are simply dropped by the SDK. `AddProcessor` method on
+`TracerProviderBuilder` should be used to add a processor. There can be any
+number of processors added to the provider, and they are invoked in the same
+order as they are added. Unlike `Sampler` or `Resource`, processors can be added
+to the provider even *after* it is built.
+
+The snippet below shows how to add processors to the provider before and after
+it is built.
+
+```csharp
+using OpenTelemetry;
+using OpenTelemetry.Trace;
+
+using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+    .AddProcessor(new MyProcessor1())
+    .AddProcessor(new MyProcessor2()))
+    .Build();
+
+// Processors can be added to provider even after it is built.
+// Only those traces which are emitted after this line, will be sent to it.
+tracerProvider.AddProcessor(new MyProcessor3());
+```
+
+A `TracerProvider` assumes ownership of any processors added to it. This means
+that, provider will call `Shutdown` method on the processor, when it is
+shutdown, and disposes the processor when it is disposed. If multiple providers
+are being setup in an application, then separate instances of processors must be
+configured on them. Otherwise, shutting down one provider can cause the
+processor in other provider to be shut down as well, leading to undesired
+results.
+
+Processors can be used for enriching the telemetry and exporting the telemetry
+to an exporter. For enriching purposes, one must write a custom processor, and
+override the `OnStart` or `OnEnd` method with logic to enrich the telemetry. For
+exporting purposes, the SDK provides the following built-in processors:
+
+* [BatchExportProcessor<T>](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#batching-processor)
+  : This is an exporting processor which batches the telemetry before sending to
+  the configured exporter.
+
+  The following environment variables can be used to override the default
+  values of the `BatchExportActivityProcessorOptions`.
+
+  | Environment variable             | `BatchExportActivityProcessorOptions` property |
+  | -------------------------------- | ---------------------------------------------- |
+  | `OTEL_BSP_SCHEDULE_DELAY`        | `ScheduledDelayMilliseconds`                   |
+  | `OTEL_BSP_EXPORT_TIMEOUT`        | `ExporterTimeoutMilliseconds`                  |
+  | `OTEL_BSP_MAX_QUEUE_SIZE`        | `MaxQueueSize`                                 |
+  | `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` | `MaxExportBatchSizeEnvVarKey`                  |
+
+  `FormatException` is thrown in case of an invalid value for any of the
+  supported environment variables.
+
+* [CompositeProcessor<T>](../../../src/OpenTelemetry/CompositeProcessor.cs)
+  : This is a processor which can be composed from multiple processors. This is
+  typically used to construct multiple processing pipelines, each ending with
+  its own exporter.
+
+* [SimpleExportProcessor<T>](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#simple-processor)
+  : This is an exporting processor which passes telemetry to the configured
+  exporter without any batching.
+
+Follow [this](../extending-the-sdk/README.md#processor) document
+to learn about how to write own processors.
+
+*The processors shipped from this SDK are generics, and supports tracing and
+logging, by supporting `Activity` and `LogRecord` respectively.*
 
 ### Resource
 
-// TODO
+[Resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md)
+is the immutable representation of the entity producing the telemetry. If no
+`Resource` is explicitly configured, the
+[default](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#semantic-attributes-with-sdk-provided-default-value)
+resource is used to indicate the
+[Service](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service).
+The `ConfigureResource` method on `TracerProviderBuilder` can be used to
+configure the resource on the provider. When the provider is built, it
+automatically builds the final `Resource` from the configured `ResourceBuilder`.
+There can only be a single `Resource` associated with a
+provider. It is not possible to change the resource builder *after* the provider
+is built, by calling the `Build()` method on the `TracerProviderBuilder`.
+`ResourceBuilder` offers various methods to construct resource comprising of
+multiple attributes from various sources.
+
+The snippet below shows configuring the `Resource` associated with the provider.
+
+```csharp
+using OpenTelemetry;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
+
+using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+    .ConfigureResource(r => r.AddService("MyServiceName"))
+    .Build();
+```
+
+It is also possible to configure the `Resource` by using following
+environmental variables:
+
+| Environment variable       | Description                                        |
+| -------------------------- | -------------------------------------------------- |
+| `OTEL_RESOURCE_ATTRIBUTES` | Key-value pairs to be used as resource attributes. See the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. |
+| `OTEL_SERVICE_NAME`        | Sets the value of the `service.name` resource attribute. If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES`, then `OTEL_SERVICE_NAME` takes precedence. |
 
 ### Sampler
 
-// TODO
+[Samplers](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#sampler)
+are used to control the noise and overhead introduced by OpenTelemetry by
+reducing the number of samples of traces collected and sent to the processors.
+If no sampler is explicitly configured, the default is to use
+`ParentBased(root=AlwaysOn)`. `SetSampler` method on `TracerProviderBuilder` can
+be used to set sampler. Only one sampler can be associated with a provider. If
+multiple `SetSampler` is called, the last one wins. Also, it is not possible to
+change the sampler *after* the provider is built, by calling the `Build()`
+method on the `TracerProviderBuilder`.
+
+The snippet below shows configuring a custom sampler to the provider.
+
+```csharp
+using OpenTelemetry;
+using OpenTelemetry.Trace;
+
+using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+    .SetSampler(new TraceIdRatioBasedSampler(0.25))
+    .Build();
+```
 
 ## Context Propagation
 

src/OpenTelemetry.Api/Baggage.cs

@@ -377,7 +377,7 @@ private static BaggageHolder EnsureBaggageHolder()
             return baggageHolder;
         }
 
-        private class BaggageHolder
+        private sealed class BaggageHolder
         {
             public Baggage Baggage;
         }

src/OpenTelemetry.Api/Internal/OpenTelemetryApiEventSource.cs

@@ -24,7 +24,7 @@ namespace OpenTelemetry.Internal
     /// This is used for internal logging of this library.
     /// </summary>
     [EventSource(Name = "OpenTelemetry-Api")]
-    internal class OpenTelemetryApiEventSource : EventSource
+    internal sealed class OpenTelemetryApiEventSource : EventSource
     {
         public static OpenTelemetryApiEventSource Log = new();
 

src/OpenTelemetry.Exporter.Console/CHANGELOG.md

@@ -10,6 +10,8 @@ LogRecordExporter to print full exception details instead of just Message, when
 using `ILogger` to log exception.
 ([#3784](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3784))
 
+Added support to print Histogram Min, Max in MetricExporter.
+
 ## 1.4.0-beta.2
 
 Released 2022-Oct-17

src/OpenTelemetry.Exporter.Console/ConsoleMetricExporter.cs

@@ -97,7 +97,13 @@ public override ExportResult Export(in Batch<Metric> batch)
                         var bucketsBuilder = new StringBuilder();
                         var sum = metricPoint.GetHistogramSum();
                         var count = metricPoint.GetHistogramCount();
-                        bucketsBuilder.Append($"Sum: {sum} Count: {count} \n");
+                        bucketsBuilder.Append($"Sum: {sum} Count: {count} ");
+                        if (metricPoint.HasMinMax())
+                        {
+                            bucketsBuilder.Append($"Min: {metricPoint.GetHistogramMin()} Max: {metricPoint.GetHistogramMax()} ");
+                        }
+
+                        bucketsBuilder.AppendLine();
 
                         bool isFirstIteration = true;
                         double previousExplicitBound = default;

src/OpenTelemetry.Exporter.Jaeger/ApacheThrift/Protocol/TProtocolException.cs

@@ -1,4 +1,4 @@
-// <auto-generated/> (Turns off StyleCop analysis in this file.)
+// <auto-generated/> (Turns off StyleCop analysis in this file.)
 
 // Licensed to the Apache Software Foundation(ASF) under one
 // or more contributor license agreements.See the NOTICE file

src/OpenTelemetry.Exporter.Jaeger/ApacheThrift/TException.cs

@@ -1,4 +1,4 @@
-// <auto-generated/> (Turns off StyleCop analysis in this file.)
+// <auto-generated/> (Turns off StyleCop analysis in this file.)
 
 // Licensed to the Apache Software Foundation(ASF) under one
 // or more contributor license agreements.See the NOTICE file

src/OpenTelemetry.Exporter.Jaeger/Implementation/JaegerExporterEventSource.cs

@@ -24,7 +24,7 @@ namespace OpenTelemetry.Exporter.Jaeger.Implementation
     /// EventSource events emitted from the project.
     /// </summary>
     [EventSource(Name = "OpenTelemetry-Exporter-Jaeger")]
-    internal class JaegerExporterEventSource : EventSource
+    internal sealed class JaegerExporterEventSource : EventSource
     {
         public static JaegerExporterEventSource Log = new();
 

src/OpenTelemetry.Exporter.Jaeger/Implementation/Process.cs

@@ -23,14 +23,9 @@ namespace OpenTelemetry.Exporter.Jaeger.Implementation
 {
     internal sealed class Process
     {
-        public Process(string serviceName)
-        {
-            this.ServiceName = serviceName;
-        }
-
-        public string ServiceName { get; internal set; }
+        public string ServiceName { get; set; }
 
-        internal Dictionary<string, JaegerTag> Tags { get; set; }
+        public Dictionary<string, JaegerTag> Tags { get; set; }
 
         public override string ToString()
         {
@@ -48,7 +43,7 @@ public override string ToString()
             return sb.ToString();
         }
 
-        internal void Write(TProtocol oprot)
+        public void Write(TProtocol oprot)
         {
             oprot.IncrementRecursionDepth();
 

src/OpenTelemetry.Exporter.Jaeger/JaegerExporter.cs

@@ -78,14 +78,12 @@ internal JaegerExporter(JaegerExporterOptions options, TProtocolFactory protocol
             this.batchWriter = protocolFactory.GetProtocol(this.maxPayloadSizeInBytes * 2);
             this.spanWriter = protocolFactory.GetProtocol(this.maxPayloadSizeInBytes);
 
-            string serviceName = (string)this.ParentProvider.GetDefaultResource().Attributes.FirstOrDefault(
-                pair => pair.Key == ResourceSemanticConventions.AttributeServiceName).Value;
-            this.Process = new Process(serviceName);
+            this.Process = new();
 
             client.Connect();
         }
 
-        internal Process Process { get; set; }
+        internal Process Process { get; }
 
         internal EmitBatchArgs EmitBatchArgs { get; private set; }
 
@@ -156,19 +154,21 @@ internal void SetResourceAndInitializeBatch(Resource resource)
                 }
             }
 
-            if (serviceName != null)
+            if (!string.IsNullOrWhiteSpace(serviceName))
             {
                 serviceName = string.IsNullOrEmpty(serviceNamespace)
                     ? serviceName
                     : serviceNamespace + "." + serviceName;
             }
-
-            if (!string.IsNullOrEmpty(serviceName))
+            else
             {
-                process.ServiceName = serviceName;
+                serviceName = (string)this.ParentProvider.GetDefaultResource().Attributes.FirstOrDefault(
+                    pair => pair.Key == ResourceSemanticConventions.AttributeServiceName).Value;
             }
 
-            this.Batch = new Batch(this.Process, this.batchWriter);
+            process.ServiceName = serviceName;
+
+            this.Batch = new Batch(process, this.batchWriter);
             if (this.sendUsingEmitBatchArgs)
             {
                 this.EmitBatchArgs = new EmitBatchArgs(this.batchWriter);

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/LogRecordExtensions.cs

@@ -92,7 +92,7 @@ internal static OtlpLogs.LogRecord ToOtlpLog(this LogRecord logRecord, SdkLimitO
 
                 if (logRecord.EventId.Id != default)
                 {
-                    otlpLogRecord.AddIntAttribute(nameof(logRecord.EventId.Id), logRecord.EventId.Id, attributeValueLengthLimit, attributeCountLimit);
+                    otlpLogRecord.AddIntAttribute(nameof(logRecord.EventId.Id), logRecord.EventId.Id, attributeCountLimit);
                 }
 
                 if (!string.IsNullOrEmpty(logRecord.EventId.Name))
@@ -193,10 +193,10 @@ private static void AddStringAttribute(this OtlpLogs.LogRecord logRecord, string
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        private static void AddIntAttribute(this OtlpLogs.LogRecord logRecord, string key, int value, int? maxValueLength, int maxAttributeCount)
+        private static void AddIntAttribute(this OtlpLogs.LogRecord logRecord, string key, int value, int maxAttributeCount)
         {
             var attributeItem = new KeyValuePair<string, object>(key, value);
-            if (OtlpKeyValueTransformer.Instance.TryTransformTag(attributeItem, out var result, maxValueLength))
+            if (OtlpKeyValueTransformer.Instance.TryTransformTag(attributeItem, out var result))
             {
                 logRecord.AddAttribute(result, maxAttributeCount);
             }

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/OpenTelemetryProtocolExporterEventSource.cs

@@ -21,7 +21,7 @@
 namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation
 {
     [EventSource(Name = "OpenTelemetry-Exporter-OpenTelemetryProtocol")]
-    internal class OpenTelemetryProtocolExporterEventSource : EventSource
+    internal sealed class OpenTelemetryProtocolExporterEventSource : EventSource
     {
         public static readonly OpenTelemetryProtocolExporterEventSource Log = new();
 

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpLogExporter.cs

@@ -28,7 +28,7 @@ namespace OpenTelemetry.Exporter
     /// Exporter consuming <see cref="LogRecord"/> and exporting the data using
     /// the OpenTelemetry protocol (OTLP).
     /// </summary>
-    internal class OtlpLogExporter : BaseExporter<LogRecord>
+    internal sealed class OtlpLogExporter : BaseExporter<LogRecord>
     {
         private readonly SdkLimitOptions sdkLimitOptions;
         private readonly IExportClient<OtlpCollector.ExportLogsServiceRequest> exportClient;