Merge branch 'main' into alanwest/tag-transformer

open-telemetry · May 19, 2022 · fc5bf81 · fc5bf81
2 parents 9cbb855 + a3e619f
commit fc5bf81
Show file tree

Hide file tree

Showing 18 changed files with 233 additions and 3 deletions.
diff --git a/OpenTelemetry.sln b/OpenTelemetry.sln
@@ -159,6 +159,9 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "metrics", "metrics", "{3277B1C0-BDFE-4460-9B0D-D9A661FB48DB}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "logs", "logs", "{3862190B-E2C5-418E-AFDC-DB281FB5C705}"
+	ProjectSection(SolutionItems) = preProject
+		docs\logs\getting-started\README.md = docs\logs\getting-started\README.md
+	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "MicroserviceExample", "MicroserviceExample", "{4D492D62-5150-45F9-817F-C99562E364E2}"
 	ProjectSection(SolutionItems) = preProject
@@ -230,6 +233,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Extensions.Pr
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Extensions.Propagators.Tests", "test\OpenTelemetry.Extensions.Propagators.Tests\OpenTelemetry.Extensions.Propagators.Tests.csproj", "{476D804B-BFEC-4D34-814C-DFFD97109989}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "correlation", "docs\logs\correlation\correlation.csproj", "{9A07D215-90AC-4BAF-BCDB-73D74FD3A5C5}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -484,6 +489,10 @@ Global
 		{476D804B-BFEC-4D34-814C-DFFD97109989}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{476D804B-BFEC-4D34-814C-DFFD97109989}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{476D804B-BFEC-4D34-814C-DFFD97109989}.Release|Any CPU.Build.0 = Release|Any CPU
+		{9A07D215-90AC-4BAF-BCDB-73D74FD3A5C5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9A07D215-90AC-4BAF-BCDB-73D74FD3A5C5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9A07D215-90AC-4BAF-BCDB-73D74FD3A5C5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9A07D215-90AC-4BAF-BCDB-73D74FD3A5C5}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -521,6 +530,7 @@ Global
 		{1F6CC903-04C9-4E7C-B388-C215C467BFB9} = {3862190B-E2C5-418E-AFDC-DB281FB5C705}
 		{41B784AA-3301-4126-AF9F-1D59BD04B0BF} = {3277B1C0-BDFE-4460-9B0D-D9A661FB48DB}
 		{6C7A1595-36D6-4229-BBB5-5A6B5791791D} = {3862190B-E2C5-418E-AFDC-DB281FB5C705}
+		{9A07D215-90AC-4BAF-BCDB-73D74FD3A5C5} = {3862190B-E2C5-418E-AFDC-DB281FB5C705}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {55639B5C-0770-4A22-AB56-859604650521}

diff --git a/docs/logs/correlation/Program.cs b/docs/logs/correlation/Program.cs
@@ -0,0 +1,59 @@
+// <copyright file="Program.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System.Diagnostics;
+using Microsoft.Extensions.Logging;
+using OpenTelemetry;
+using OpenTelemetry.Logs;
+using OpenTelemetry.Trace;
+
+namespace Correlation;
+
+public class Program
+{
+    private static readonly ActivitySource MyActivitySource = new(
+        "MyCompany.MyProduct.MyLibrary");
+
+    public static void Main()
+    {
+        // Setup Logging
+        using var loggerFactory = LoggerFactory.Create(builder =>
+        {
+            builder.AddOpenTelemetry(options =>
+            {
+                options.AddConsoleExporter();
+            });
+        });
+
+        var logger = loggerFactory.CreateLogger<Program>();
+
+        // Setup Traces
+        using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+            .AddSource("MyCompany.MyProduct.MyLibrary")
+            .AddConsoleExporter()
+            .Build();
+
+        // Emit activity
+        using (var activity = MyActivitySource.StartActivity("SayHello"))
+        {
+            activity?.SetTag("foo", 1);
+
+            // emit logs within the context
+            // of activity
+            logger.LogInformation("Hello from {name} {price}.", "tomato", 2.99);
+        }
+    }
+}
diff --git a/docs/logs/correlation/README.md b/docs/logs/correlation/README.md
@@ -0,0 +1,64 @@
+# Logs correlation
+
+The getting started docs for [logs](../getting-started/README.md) and
+[traces](../../trace/getting-started/README.md) showed how to emit logs and
+traces independently, and export them to console exporter.
+
+This doc explains how logs can be correlated to traces.
+
+## Logging Data Model support for correlation
+
+[Logging Data
+Model](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#trace-context-fields)
+defines fields which allow a log to be correlated with span (`Activity` in
+.NET). The fields `TraceId` and `SpanId` allow a log to be correlated to
+corresponding `Activity`.
+
+## Correlation in OpenTelemetry .NET
+
+The good news is that, in OpenTelemetry .NET SDK, there is no user action
+required to enable correlation. i.e the SDK automatically enables logs to
+`Activity` correlation, by populating the fields `TraceId`, `SpanId`,
+`TraceFlags`, `TraceState` from the active activity (i.e `Activity.Current`), if
+any.
+
+The example [Program.cs](./Program.cs) shows how to emit logs within the context
+of an active `Activity`. Running the application will show the following output
+on the console:
+
+```text
+LogRecord.Timestamp:               2022-05-18T18:51:16.4348626Z
+LogRecord.TraceId:                 d7aca5b2422ed8d15f56b6a93be4537d
+LogRecord.SpanId:                  c90ac2ad41ab4d46
+LogRecord.TraceFlags:              Recorded
+LogRecord.CategoryName:            Correlation.Program
+LogRecord.LogLevel:                Information
+LogRecord.State:                   Hello from tomato 2.99.
+
+Resource associated with LogRecord:
+service.name: unknown_service:correlation
+
+Activity.TraceId:          d7aca5b2422ed8d15f56b6a93be4537d
+Activity.SpanId:           c90ac2ad41ab4d46
+Activity.TraceFlags:           Recorded
+Activity.ActivitySourceName: MyCompany.MyProduct.MyLibrary
+Activity.DisplayName: SayHello
+Activity.Kind:        Internal
+Activity.StartTime:   2022-05-18T18:51:16.3427411Z
+Activity.Duration:    00:00:00.2248932
+Activity.Tags:
+    foo: 1
+Resource associated with Activity:
+    service.name: unknown_service:correlation
+```
+
+As you can see, the `LogRecord` automatically had the `TraceId`, `SpanId` fields
+matching the ones from the `Activity`. In [the logs getting
+started](../getting-started/README.md) doc, the logging was done outside of an
+`Activity` context, hence these fields in `LogRecord` were not populated.
+
+## Learn more
+
+Check [ASP.NET Core](../../../examples/AspNetCore/README.md) example application
+which shows how all the logs done within the context of request are
+automatically correlated to the `Activity` representing the incoming request.
diff --git a/docs/logs/correlation/correlation.csproj b/docs/logs/correlation/correlation.csproj
@@ -0,0 +1,6 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="$(MicrosoftExtensionsLoggingPkgVer)" />
+    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Exporter.Console\OpenTelemetry.Exporter.Console.csproj" />
+  </ItemGroup>
+</Project>
diff --git a/src/OpenTelemetry.Api/CHANGELOG.md b/src/OpenTelemetry.Api/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 ## 1.3.0-beta.1
 
 Released 2022-Apr-15

diff --git a/src/OpenTelemetry.Exporter.Console/CHANGELOG.md b/src/OpenTelemetry.Exporter.Console/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 ## 1.3.0-beta.1
 
 Released 2022-Apr-15

diff --git a/src/OpenTelemetry.Exporter.InMemory/CHANGELOG.md b/src/OpenTelemetry.Exporter.InMemory/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 ## 1.3.0-beta.1
 
 Released 2022-Apr-15

diff --git a/src/OpenTelemetry.Exporter.Jaeger/CHANGELOG.md b/src/OpenTelemetry.Exporter.Jaeger/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 * Removes net5.0 target and replaced with net6.0
   as .NET 5.0 is going out of support.
   The package keeps netstandard2.1 target, so it

diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/CHANGELOG.md b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 * LogExporter to support Logging Scopes.
   ([#3218](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3218))
 

diff --git a/src/OpenTelemetry.Exporter.Prometheus/CHANGELOG.md b/src/OpenTelemetry.Exporter.Prometheus/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 ## 1.3.0-beta.1
 
 Released 2022-Apr-15

diff --git a/src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md b/src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 * Removes net5.0 target and replaced with net6.0
   as .NET 5.0 is going out of support.
   The package keeps netstandard2.0 target, so it

diff --git a/src/OpenTelemetry.Extensions.Propagators/CHANGELOG.md b/src/OpenTelemetry.Extensions.Propagators/CHANGELOG.md
@@ -0,0 +1,6 @@
+# Changelog
+
+## Unreleased
+
+* Initial release. This has been ported as is from
+[OpenTelemetry.Api](../OpenTelemetry.Api/README.md) package.
diff --git a/src/OpenTelemetry.Extensions.Propagators/README.md b/src/OpenTelemetry.Extensions.Propagators/README.md
@@ -0,0 +1,49 @@
+# Propagator formats for OpenTelemetry .NET
+
+[![NuGet](https://img.shields.io/nuget/v/OpenTelemetry.Extensions.Propagators.svg)](https://www.nuget.org/packages/OpenTelemetry.Extensions.Propagators)
+[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.Extensions.Propagators.svg)](https://www.nuget.org/packages/OpenTelemetry.Extensions.Propagators)
+
+The package provides context
+propagators by following the [OpenTelemetry specification](https://opentelemetry.io/docs/reference/specification/context/api-propagators/)
+(currently supporting [B3](https://github.com/openzipkin/b3-propagation) format)
+for tracing.
+
+## Installation
+
+Add a reference to the
+[`OpenTelemetry.Extensions.Propagators`](https://www.nuget.org/packages/OpenTelemetry.Extensions.Propagators)
+package in your project.
+
+```shell
+dotnet add package --prerelease OpenTelemetry.Extensions.Propagators
+```
+
+## Configuration
+
+Use `B3 OpenZipkin` context only:
+
+```csharp
+using OpenTelemetry;
+using OpenTelemetry.Extensions.Propagators;
+
+Sdk.SetDefaultTextMapPropagator(new B3Propagator())
+```
+
+Use `B3 OpenZipkin` and `W3C Baggage` propagators at the same time:
+
+```csharp
+using OpenTelemetry;
+using OpenTelemetry.Context.Propagation;
+using OpenTelemetry.Extensions.Propagators;
+
+Sdk.SetDefaultTextMapPropagator(new CompositeTextMapPropagator(new TextMapPropagator[]
+    {
+        new OpenTelemetry.Extensions.Propagators.B3Propagator(),
+        new BaggagePropagator(),
+    }));
+```
+
+## References
+
+* [B3 (Zipkin) Context specification](https://github.com/openzipkin/b3-propagation)
+* [OpenTelemetry Project](https://opentelemetry.io/)
diff --git a/src/OpenTelemetry/CHANGELOG.md b/src/OpenTelemetry/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+* Fix null reference exception when a metric view does not match an instrument.
+  ([#3285](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3285))
+
+## 1.3.0-beta.2
+
+Released 2022-May-16
+
 * Exposed public setters for `LogRecord.State`, `LogRecord.StateValues`,
   and `LogRecord.FormattedMessage`.
  ([#3217](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3217))

diff --git a/src/OpenTelemetry/Metrics/MeterProviderSdk.cs b/src/OpenTelemetry/Metrics/MeterProviderSdk.cs
@@ -167,7 +167,7 @@ internal MeterProviderSdk(
                                 // The SDK provides some static MetricStreamConfigurations.
                                 // For example, the Drop configuration. The static ViewId
                                 // should not be changed for these configurations.
-                                if (!metricStreamConfig.ViewId.HasValue)
+                                if (metricStreamConfig != null && !metricStreamConfig.ViewId.HasValue)
                                 {
                                     metricStreamConfig.ViewId = i;
                                 }

diff --git a/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.server.cs b/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.server.cs
@@ -126,7 +126,7 @@ public void GrpcAspNetCoreInstrumentationAddsCorrectAttributesWhenItCreatesNewAc
             try
             {
                 // B3Propagator along with the headers passed to the client.SayHello ensure that the instrumentation creates a sibling activity
-                Sdk.SetDefaultTextMapPropagator(new B3Propagator());
+                Sdk.SetDefaultTextMapPropagator(new Extensions.Propagators.B3Propagator());
                 var exportedItems = new List<Activity>();
                 var tracerProviderBuilder = Sdk.CreateTracerProviderBuilder();
 

diff --git a/.../OpenTelemetry.Instrumentation.Grpc.Tests/OpenTelemetry.Instrumentation.Grpc.Tests.csproj b/.../OpenTelemetry.Instrumentation.Grpc.Tests/OpenTelemetry.Instrumentation.Grpc.Tests.csproj
@@ -32,6 +32,7 @@
 
   <ItemGroup>
     <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Exporter.InMemory\OpenTelemetry.Exporter.InMemory.csproj" />
+    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Extensions.Propagators\OpenTelemetry.Extensions.Propagators.csproj" />
     <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.AspNetCore\OpenTelemetry.Instrumentation.AspNetCore.csproj" />
     <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.GrpcNetClient\OpenTelemetry.Instrumentation.GrpcNetClient.csproj" />
     <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.Http\OpenTelemetry.Instrumentation.Http.csproj" />

diff --git a/...entation.W3cTraceContext.Tests/OpenTelemetry.Instrumentation.W3cTraceContext.Tests.csproj b/...entation.W3cTraceContext.Tests/OpenTelemetry.Instrumentation.W3cTraceContext.Tests.csproj
@@ -26,7 +26,7 @@
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\StatusHelper.cs" Link="Includes\StatusHelper.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\IActivityEnumerator.cs" Link="Includes\IActivityEnumerator.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\EnumerationHelper.cs" Link="Includes\EnumerationHelper.cs" />
-  <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\SpanAttributeConstants.cs" Link="Includes\SpanAttributeConstants.cs" />
+    <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\SpanAttributeConstants.cs" Link="Includes\SpanAttributeConstants.cs" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">