Merge branch 'main' into oltpexporter-iconfiguration

OpenTelemetry.sln

@@ -234,6 +234,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Tests.Stress.
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TestApp.AspNetCore", "test\TestApp.AspNetCore\TestApp.AspNetCore.csproj", "{5FDAF679-DE5A-4C73-A49B-8ABCF2399229}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "redaction", "docs\logs\redaction\redaction.csproj", "{A2DF46DE-50D7-4887-8C9D-4BD79CA19FAA}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -476,6 +478,10 @@ Global
 		{5FDAF679-DE5A-4C73-A49B-8ABCF2399229}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{5FDAF679-DE5A-4C73-A49B-8ABCF2399229}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{5FDAF679-DE5A-4C73-A49B-8ABCF2399229}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A2DF46DE-50D7-4887-8C9D-4BD79CA19FAA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A2DF46DE-50D7-4887-8C9D-4BD79CA19FAA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A2DF46DE-50D7-4887-8C9D-4BD79CA19FAA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A2DF46DE-50D7-4887-8C9D-4BD79CA19FAA}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -512,6 +518,7 @@ Global
 		{6C7A1595-36D6-4229-BBB5-5A6B5791791D} = {3862190B-E2C5-418E-AFDC-DB281FB5C705}
 		{9A07D215-90AC-4BAF-BCDB-73D74FD3A5C5} = {3862190B-E2C5-418E-AFDC-DB281FB5C705}
 		{5FDAF679-DE5A-4C73-A49B-8ABCF2399229} = {77C7929A-2EED-4AA6-8705-B5C443C8AA0F}
+		{A2DF46DE-50D7-4887-8C9D-4BD79CA19FAA} = {3862190B-E2C5-418E-AFDC-DB281FB5C705}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {55639B5C-0770-4A22-AB56-859604650521}

docs/logs/extending-the-sdk/Program.cs

@@ -28,8 +28,7 @@ public static void Main()
             builder.AddOpenTelemetry(options =>
             {
                 options.IncludeScopes = true;
-                options.AddProcessor(new MyRedactionProcessor())
-                       .AddProcessor(new MyProcessor("ProcessorA"))
+                options.AddProcessor(new MyProcessor("ProcessorA"))
                        .AddProcessor(new MyProcessor("ProcessorB"))
                        .AddProcessor(new SimpleLogRecordExportProcessor(new MyExporter("ExporterX")))
                        .AddMyExporter();

docs/logs/redaction/MyClassWithRedactionEnumerator.cs

@@ -0,0 +1,61 @@
+// <copyright file="MyClassWithRedactionEnumerator.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.Collections;
+using System.Collections.Generic;
+
+namespace Redaction
+{
+    internal class MyClassWithRedactionEnumerator : IReadOnlyList<KeyValuePair<string, object>>
+    {
+        private readonly IReadOnlyList<KeyValuePair<string, object>> state;
+
+        public MyClassWithRedactionEnumerator(IReadOnlyList<KeyValuePair<string, object>> state)
+        {
+            this.state = state;
+        }
+
+        public int Count => this.state.Count;
+
+        public KeyValuePair<string, object> this[int index]
+        {
+            get
+            {
+                var item = this.state[index];
+                var entryVal = item.Value;
+                if (entryVal != null && entryVal.ToString() != null && entryVal.ToString().Contains("<secret>"))
+                {
+                    return new KeyValuePair<string, object>(item.Key, "newRedactedValueHere");
+                }
+
+                return item;
+            }
+        }
+
+        public IEnumerator<KeyValuePair<string, object>> GetEnumerator()
+        {
+            for (var i = 0; i < this.Count; i++)
+            {
+                yield return this[i];
+            }
+        }
+
+        IEnumerator IEnumerable.GetEnumerator()
+        {
+            return this.GetEnumerator();
+        }
+    }
+}

docs/logs/extending-the-sdk/MyRedactionProcessor.cs → docs/logs/redaction/MyRedactionProcessor.cs

@@ -18,11 +18,19 @@
 using OpenTelemetry;
 using OpenTelemetry.Logs;
 
+namespace Redaction;
+
 internal class MyRedactionProcessor : BaseProcessor<LogRecord>
 {
     public override void OnEnd(LogRecord logRecord)
     {
-        if (logRecord.State is IReadOnlyList<KeyValuePair<string, object>> listOfKvp)
+        if (logRecord.State == null)
+        {
+            // When State is null, OTel SDK guarantees StateValues is populated
+            // TODO: Debug.Assert?
+            logRecord.StateValues = new MyClassWithRedactionEnumerator(logRecord.StateValues);
+        }
+        else if (logRecord.State is IReadOnlyList<KeyValuePair<string, object>> listOfKvp)
         {
             logRecord.State = new MyClassWithRedactionEnumerator(listOfKvp);
         }

docs/logs/redaction/Program.cs

@@ -0,0 +1,38 @@
+// <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 Microsoft.Extensions.Logging;
+using OpenTelemetry.Logs;
+
+namespace Redaction;
+
+public class Program
+{
+    public static void Main()
+    {
+        using var loggerFactory = LoggerFactory.Create(builder =>
+            builder.AddOpenTelemetry(options =>
+            {
+                options.AddProcessor(new MyRedactionProcessor());
+                options.AddConsoleExporter();
+            }));
+
+        var logger = loggerFactory.CreateLogger<Program>();
+
+        // message will be redacted by MyRedactionProcessor
+        logger.LogInformation("OpenTelemetry {sensitiveString}.", "<secret>");
+    }
+}

docs/logs/redaction/README.md

@@ -0,0 +1,6 @@
+# Redaction
+
+This example shows how to redact sensitive information from Logs.
+In this example, we attach a custom `Processor` called `MyRedactionProcessor`
+which is responsible for replacing any instance of the word "<secret>"
+with the value "newRedactedValueHere".

docs/logs/redaction/redaction.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>

src/OpenTelemetry.Api/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29

src/OpenTelemetry.Exporter.Console/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29

src/OpenTelemetry.Exporter.Console/ConsoleLogRecordExporter.cs

@@ -84,7 +84,28 @@ public override ExportResult Export(in Batch<LogRecord> batch)
 
                 if (logRecord.State != null)
                 {
-                    this.WriteLine($"{"LogRecord.State:",-RightPaddingLength}{logRecord.State}");
+                    if (logRecord.State is IReadOnlyList<KeyValuePair<string, object>> listKvp)
+                    {
+                        this.WriteLine("LogRecord.State (Key:Value):");
+                        for (int i = 0; i < listKvp.Count; i++)
+                        {
+                            // Special casing {OriginalFormat}
+                            // See https://github.com/open-telemetry/opentelemetry-dotnet/pull/3182
+                            // for explanation.
+                            var valueToTransform = listKvp[i].Key.Equals("{OriginalFormat}")
+                                ? new KeyValuePair<string, object>("OriginalFormat (a.k.a Body)", listKvp[i].Value)
+                                : listKvp[i];
+
+                            if (ConsoleTagTransformer.Instance.TryTransformTag(listKvp[i], out var result))
+                            {
+                                this.WriteLine($"{string.Empty,-4}{result}");
+                            }
+                        }
+                    }
+                    else
+                    {
+                        this.WriteLine($"{"LogRecord.State:",-RightPaddingLength}{logRecord.State}");
+                    }
                 }
                 else if (logRecord.StateValues != null)
                 {

src/OpenTelemetry.Exporter.InMemory/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29

src/OpenTelemetry.Exporter.Jaeger/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 * Added support for loading environment variables from `IConfiguration` when
   using the `AddJaegerExporter` extension
   ([#3720](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3720))

src/OpenTelemetry.Exporter.OpenTelemetryProtocol.Logs/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 * OTLP histogram data points will now include `Min` and `Max` values when
   they are present.
   ([#2735](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2735))

src/OpenTelemetry.Exporter.Prometheus.AspNetCore/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 * Changed configuration class name from `PrometheusExporterOptions`
   to `PrometheusAspNetCoreOptions`
   ([#3717](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3717))

src/OpenTelemetry.Exporter.Prometheus.HttpListener/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29

src/OpenTelemetry.Exporter.ZPages/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.0.0-rc9.8
+
+Released 2022-Oct-17
+
 ## 1.0.0-rc9.7
 
 Released 2022-Sep-29

src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 * Added support for loading environment variables from `IConfiguration` when
   using the `AddZipkinExporter` extension
   ([#3759](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3759))

src/OpenTelemetry.Extensions.Hosting/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.0.0-rc9.8
+
+Released 2022-Oct-17
+
 ## 1.0.0-rc9.7
 
 Released 2022-Sep-29

src/OpenTelemetry.Extensions.Propagators/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.4.0-beta.2
+
+Released 2022-Oct-17
+
 ## 1.4.0-beta.1
 
 Released 2022-Sep-29