Logs: Add log record pooling

src/OpenTelemetry.Exporter.InMemory/InMemoryExporterLoggingExtensions.cs

@@ -42,9 +42,7 @@ private static ExportResult ExportLogRecord(in Batch<LogRecord> batch, ICollecti
 
             foreach (var log in batch)
             {
-                log.BufferLogScopes();
-
-                exportedItems.Add(log);
+                exportedItems.Add(log.Copy());
             }
 
             return ExportResult.Success;

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

@@ -7,6 +7,8 @@ OpenTelemetry.Logs.LogRecord.Timestamp.set -> void
 OpenTelemetry.Logs.LogRecord.TraceFlags.set -> void
 OpenTelemetry.Logs.LogRecord.TraceId.set -> void
 OpenTelemetry.Logs.LogRecord.TraceState.set -> void
+OpenTelemetry.Logs.LogRecordPool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.ForceFlush(int timeoutMilliseconds = -1) -> bool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider() -> void
-OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+static OpenTelemetry.Logs.LogRecordPool.Resize(int capacity) -> void

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

@@ -7,6 +7,8 @@ OpenTelemetry.Logs.LogRecord.Timestamp.set -> void
 OpenTelemetry.Logs.LogRecord.TraceFlags.set -> void
 OpenTelemetry.Logs.LogRecord.TraceId.set -> void
 OpenTelemetry.Logs.LogRecord.TraceState.set -> void
+OpenTelemetry.Logs.LogRecordPool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.ForceFlush(int timeoutMilliseconds = -1) -> bool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider() -> void
-OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+static OpenTelemetry.Logs.LogRecordPool.Resize(int capacity) -> void

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

@@ -7,6 +7,8 @@ OpenTelemetry.Logs.LogRecord.Timestamp.set -> void
 OpenTelemetry.Logs.LogRecord.TraceFlags.set -> void
 OpenTelemetry.Logs.LogRecord.TraceId.set -> void
 OpenTelemetry.Logs.LogRecord.TraceState.set -> void
+OpenTelemetry.Logs.LogRecordPool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.ForceFlush(int timeoutMilliseconds = -1) -> bool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider() -> void
-OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+static OpenTelemetry.Logs.LogRecordPool.Resize(int capacity) -> void

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

@@ -7,6 +7,8 @@ OpenTelemetry.Logs.LogRecord.Timestamp.set -> void
 OpenTelemetry.Logs.LogRecord.TraceFlags.set -> void
 OpenTelemetry.Logs.LogRecord.TraceId.set -> void
 OpenTelemetry.Logs.LogRecord.TraceState.set -> void
+OpenTelemetry.Logs.LogRecordPool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.ForceFlush(int timeoutMilliseconds = -1) -> bool
 OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider() -> void
-OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+OpenTelemetry.Logs.OpenTelemetryLoggerProvider.OpenTelemetryLoggerProvider(System.Action<OpenTelemetry.Logs.OpenTelemetryLoggerOptions!>! configure) -> void
+static OpenTelemetry.Logs.LogRecordPool.Resize(int capacity) -> void

src/OpenTelemetry/Batch.cs

@@ -22,6 +22,7 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using OpenTelemetry.Internal;
+using OpenTelemetry.Logs;
 
 namespace OpenTelemetry
 {
@@ -90,7 +91,11 @@ public void Dispose()
                 // Drain anything left in the batch.
                 while (this.circularBuffer.RemovedCount < this.targetCount)
                 {
-                    this.circularBuffer.Read();
+                    T item = this.circularBuffer.Read();
+                    if (typeof(T) == typeof(LogRecord))
+                    {
+                        LogRecordSharedPool.Current.Return((LogRecord)(object)item);
+                    }
                 }
             }
         }
@@ -140,6 +145,29 @@ public struct Enumerator : IEnumerator<T>
                 return false;
             };
 
+            private static readonly BatchEnumeratorMoveNextFunc MoveNextCircularBufferLogRecord = (ref Enumerator enumerator) =>
+            {
+                var circularBuffer = enumerator.circularBuffer;
+
+                var currentItem = enumerator.Current;
+                if (currentItem != null)
+                {
+                    if (typeof(T) == typeof(LogRecord))
+                    {
+                        LogRecordSharedPool.Current.Return((LogRecord)(object)currentItem);
+                    }
+                }
+
+                if (circularBuffer!.RemovedCount < enumerator.targetCount)
+                {
+                    enumerator.current = circularBuffer.Read();
+                    return true;
+                }
+
+                enumerator.current = null;
+                return false;
+            };
+
             private static readonly BatchEnumeratorMoveNextFunc MoveNextArray = (ref Enumerator enumerator) =>
             {
                 var items = enumerator.items;
@@ -179,7 +207,7 @@ internal Enumerator(CircularBuffer<T> circularBuffer, long targetCount)
                 this.circularBuffer = circularBuffer;
                 this.targetCount = targetCount;
                 this.itemIndex = 0;
-                this.moveNextFunc = MoveNextCircularBuffer;
+                this.moveNextFunc = typeof(T) == typeof(LogRecord) ? MoveNextCircularBufferLogRecord : MoveNextCircularBuffer;
             }
 
             internal Enumerator(T[] items, long targetCount)
@@ -201,6 +229,15 @@ internal Enumerator(T[] items, long targetCount)
             /// <inheritdoc/>
             public void Dispose()
             {
+                if (typeof(T) == typeof(LogRecord))
+                {
+                    var currentItem = this.current;
+                    if (currentItem != null)
+                    {
+                        LogRecordSharedPool.Current.Return((LogRecord)(object)currentItem);
+                        this.current = null;
+                    }
+                }
             }
 
             /// <inheritdoc/>

src/OpenTelemetry/BatchExportProcessor.cs

@@ -18,6 +18,7 @@
 
 using System;
 using System.Diagnostics;
+using System.Runtime.CompilerServices;
 using System.Threading;
 using OpenTelemetry.Internal;
 
@@ -95,8 +96,8 @@ protected BatchExportProcessor(
         /// </summary>
         internal long ProcessedCount => this.circularBuffer.RemovedCount;
 
-        /// <inheritdoc/>
-        protected override void OnExport(T data)
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        internal bool TryExport(T data)
         {
             if (this.circularBuffer.TryAdd(data, maxSpinCount: 50000))
             {
@@ -111,11 +112,19 @@ protected override void OnExport(T data)
                     }
                 }
 
-                return; // enqueue succeeded
+                return true; // enqueue succeeded
             }
 
             // either the queue is full or exceeded the spin limit, drop the item on the floor
             Interlocked.Increment(ref this.droppedCount);
+
+            return false;
+        }
+
+        /// <inheritdoc/>
+        protected override void OnExport(T data)
+        {
+            this.TryExport(data);
         }
 
         /// <inheritdoc/>

src/OpenTelemetry/CHANGELOG.md

@@ -22,6 +22,9 @@
   `set` methods
   ([#3378](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3378))
 
+* `LogRecord` instances are now reused to reduce memory pressure
+  ([#3385](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3385))
+
 ## 1.3.0
 
 Released 2022-Jun-03

src/OpenTelemetry/CompositeProcessor.cs

@@ -26,7 +26,7 @@ namespace OpenTelemetry
 {
     public class CompositeProcessor<T> : BaseProcessor<T>
     {
-        private readonly DoublyLinkedListNode head;
+        internal readonly DoublyLinkedListNode Head;
         private DoublyLinkedListNode tail;
         private bool disposed;
 
@@ -40,8 +40,8 @@ public CompositeProcessor(IEnumerable<BaseProcessor<T>> processors)
                 throw new ArgumentException($"'{iter}' is null or empty", nameof(iter));
             }
 
-            this.head = new DoublyLinkedListNode(iter.Current);
-            this.tail = this.head;
+            this.Head = new DoublyLinkedListNode(iter.Current);
+            this.tail = this.Head;
 
             while (iter.MoveNext())
             {
@@ -66,7 +66,7 @@ public CompositeProcessor<T> AddProcessor(BaseProcessor<T> processor)
         /// <inheritdoc/>
         public override void OnEnd(T data)
         {
-            for (var cur = this.head; cur != null; cur = cur.Next)
+            for (var cur = this.Head; cur != null; cur = cur.Next)
             {
                 cur.Value.OnEnd(data);
             }
@@ -75,7 +75,7 @@ public override void OnEnd(T data)
         /// <inheritdoc/>
         public override void OnStart(T data)
         {
-            for (var cur = this.head; cur != null; cur = cur.Next)
+            for (var cur = this.Head; cur != null; cur = cur.Next)
             {
                 cur.Value.OnStart(data);
             }
@@ -85,7 +85,7 @@ internal override void SetParentProvider(BaseProvider parentProvider)
         {
             base.SetParentProvider(parentProvider);
 
-            for (var cur = this.head; cur != null; cur = cur.Next)
+            for (var cur = this.Head; cur != null; cur = cur.Next)
             {
                 cur.Value.SetParentProvider(parentProvider);
             }
@@ -99,7 +99,7 @@ protected override bool OnForceFlush(int timeoutMilliseconds)
                 ? null
                 : Stopwatch.StartNew();
 
-            for (var cur = this.head; cur != null; cur = cur.Next)
+            for (var cur = this.Head; cur != null; cur = cur.Next)
             {
                 if (sw == null)
                 {
@@ -125,7 +125,7 @@ protected override bool OnShutdown(int timeoutMilliseconds)
                 ? null
                 : Stopwatch.StartNew();
 
-            for (var cur = this.head; cur != null; cur = cur.Next)
+            for (var cur = this.Head; cur != null; cur = cur.Next)
             {
                 if (sw == null)
                 {
@@ -150,7 +150,7 @@ protected override void Dispose(bool disposing)
             {
                 if (disposing)
                 {
-                    for (var cur = this.head; cur != null; cur = cur.Next)
+                    for (var cur = this.Head; cur != null; cur = cur.Next)
                     {
                         try
                         {
@@ -169,7 +169,7 @@ protected override void Dispose(bool disposing)
             base.Dispose(disposing);
         }
 
-        private class DoublyLinkedListNode
+        internal sealed class DoublyLinkedListNode
         {
             public readonly BaseProcessor<T> Value;
 

src/OpenTelemetry/Logs/BatchLogRecordExportProcessor.cs

@@ -57,9 +57,14 @@ public override void OnEnd(LogRecord data)
             // happen here.
             Debug.Assert(data != null, "LogRecord was null.");
 
-            data!.BufferLogScopes();
+            data!.Buffer();
 
-            base.OnEnd(data);
+            data.AddReference();
+
+            if (!this.TryExport(data))
+            {
+                LogRecordSharedPool.Current.Return(data);
+            }
         }
     }
 }