Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add logging buffering #5635

Draft
wants to merge 28 commits into
base: main
Choose a base branch
from
Draft

Add logging buffering #5635

wants to merge 28 commits into from

Conversation

evgenyfedorov2
Copy link
Contributor

@evgenyfedorov2 evgenyfedorov2 commented Nov 13, 2024 •
edited by dotnet-policy-service bot
Loading

Related to the #5123 proposal, this PR is focused on the logging buffering only. See also the sampling part #5574.

Microsoft Reviewers: Open in CodeFlow

noahfalk
noahfalk reviewed Nov 23, 2024
View reviewed changes
@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch 2 times, most recently from e40b7b6 to 9d61d12 Compare December 12, 2024 16:30
@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch from 9d61d12 to 2f1a335 Compare December 12, 2024 17:36
@evgenyfedorov2
Fix namespaces
f7eaab1 
Address PR comments
Add .NET 8 support
Add ExceptionJsonConverter
@evgenyfedorov2
Merge branch 'main' into evgenyfedorov2/log_buffering
1f464df
@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch from 883334d to 022f00c Compare December 16, 2024 14:23
@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch from 022f00c to a371d9c Compare December 16, 2024 14:51
@dotnet-comment-bot
Copy link
Collaborator

‼️ Found issues ‼️

Project Coverage Type Expected Actual
Microsoft.AspNetCore.Diagnostics.Middleware Line 100 96.03 🔻
Microsoft.AspNetCore.Diagnostics.Middleware Branch 100 98.51 🔻
Microsoft.Extensions.Telemetry Line 93 86.2 🔻
Microsoft.Extensions.Telemetry Branch 93 84.59 🔻
Microsoft.Extensions.Diagnostics.Testing Line 99 85.78 🔻
Microsoft.Extensions.Diagnostics.Testing Branch 99 79.57 🔻

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project Expected Actual
Microsoft.Extensions.Diagnostics.Probes 70 76
Microsoft.Extensions.Caching.Hybrid 75 86
Microsoft.Extensions.AI.OpenAI 72 77

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=896358&view=codecoverage-tab

KalleOlaviNiemitalo
KalleOlaviNiemitalo reviewed Dec 17, 2024
View reviewed changes
src/Libraries/Microsoft.Extensions.Telemetry/Buffering/BufferSink.cs Outdated
Comment on lines 72 to 77
logger.Log(
serializedRecord.LogLevel,
serializedRecord.EventId,
serializedRecord.Attributes,
exception,
(_, _) => serializedRecord.FormattedMessage ?? string.Empty);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This allocates a closure and a delegate for each ILogger.Log<TState> call. I can think of two ways to minimize the allocations:

  • Instead of serializedRecord.Attributes, pass serializedRecord itself as the state to ILogger.Log<TState>. Implement IReadOnlyList<KeyValuePair<string, object?>> in SerializedLogRecord by calling the corresponding methods of public IReadOnlyList<KeyValuePair<string, string>> Attributes.
  • Alternatively, keep using the same delegate across all iterations of both foreach loops; declare the serializedRecord variable and a delegate variable before the outer loop. That way, it would allocate only one closure and one delegate per BufferSink.LogRecords call, no matter how many log records are in IEnumerable<T> serializedRecords. This is safe because ILogger.Log<TState> is not allowed to save the formatter delegate for later calling.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense for optimizations later, thank you

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code moved from BufferSink to BufferedLoggerProxy in d7661a6. The BufferedLogRecord instances are not pooled, so each BufferedLogRecord call costs at least one allocation per BufferedLogRecord; that may make the delegate and closure allocations less important.

KalleOlaviNiemitalo
KalleOlaviNiemitalo reviewed Dec 18, 2024
View reviewed changes
src/Libraries/Microsoft.Extensions.Telemetry/Buffering/PooledLogRecord.cs Outdated
using Microsoft.Extensions.ObjectPool;

namespace Microsoft.Extensions.Diagnostics.Buffering;
internal sealed class PooledLogRecord : BufferedLogRecord, IResettable
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add DebuggerDisplayAttribute so that the list of log records in a buffer can be viewed more easily.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or add the DebuggerDisplayAttribute to SerializedLogRecord, instead.

@dotnet-comment-bot
Copy link
Collaborator

‼️ Found issues ‼️

Project Coverage Type Expected Actual
Microsoft.Extensions.Telemetry Line 93 91.91 🔻
Microsoft.AspNetCore.Diagnostics.Middleware Line 100 96.36 🔻
Microsoft.AspNetCore.Diagnostics.Middleware Branch 100 98.48 🔻

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project Expected Actual
Microsoft.Extensions.AI.OpenAI 77 78
Microsoft.Extensions.AI 88 89

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=925013&view=codecoverage-tab

@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch from 8319dc8 to 8a91c15 Compare January 22, 2025 14:28
@dotnet-comment-bot
Copy link
Collaborator

‼️ Found issues ‼️

Project Coverage Type Expected Actual
Microsoft.Extensions.Telemetry Line 93 92 🔻
Microsoft.AspNetCore.Diagnostics.Middleware Line 100 96.04 🔻
Microsoft.AspNetCore.Diagnostics.Middleware Branch 100 98.44 🔻

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project Expected Actual
Microsoft.Extensions.AI.OpenAI 77 78
Microsoft.Extensions.AI 88 89

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=925328&view=codecoverage-tab

@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch from d387358 to 4f524eb Compare January 22, 2025 16:03
@dotnet-comment-bot
Copy link
Collaborator

‼️ Found issues ‼️

Project Coverage Type Expected Actual
Microsoft.Extensions.Telemetry Line 93 91.87 🔻
Microsoft.AspNetCore.Diagnostics.Middleware Line 100 96.04 🔻
Microsoft.AspNetCore.Diagnostics.Middleware Branch 100 98.44 🔻

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project Expected Actual
Microsoft.Extensions.AI.OpenAI 77 78
Microsoft.Extensions.AI 88 89

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=925376&view=codecoverage-tab

@KalleOlaviNiemitalo KalleOlaviNiemitalo mentioned this pull request Jan 23, 2025
Open
KalleOlaviNiemitalo
KalleOlaviNiemitalo reviewed Jan 23, 2025
View reviewed changes
src/Libraries/Microsoft.Extensions.Telemetry/Buffering/BufferFilterRule.cs Outdated
Comment on lines 11 to 15
/// <summary>
/// Defines a rule used to filter log messages for purposes of futher buffering.
/// </summary>
[Experimental(diagnosticId: DiagnosticIds.Experiments.Telemetry, UrlFormat = DiagnosticIds.UrlFormat)]
public class BufferFilterRule
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should have docs about what happens if a log entry matches a rule, and what happens if the log entry does not match any rule.

  • Is the log entry discarded, buffered, or written directly to underlying loggers?
  • Does it cause other log entries to be flushed from the buffer to underlying loggers? If so, does that apply to all log categories or only to the same category?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, if this type is used with different semantics in different contexts, then document the behaviour in HttpRequestBufferOptions.Rules and GlobalBufferOptions.Rules, and link to those docs from here.

@KalleOlaviNiemitalo KalleOlaviNiemitalo mentioned this pull request Feb 5, 2025
Closed
@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch 2 times, most recently from 5201765 to 7afd271 Compare February 14, 2025 12:52
@evgenyfedorov2 evgenyfedorov2 force-pushed the evgenyfedorov2/log_buffering branch from 7afd271 to b2b6e56 Compare February 14, 2025 15:27
@KalleOlaviNiemitalo KalleOlaviNiemitalo mentioned this pull request Feb 28, 2025
Open
@evgenyfedorov2 evgenyfedorov2 mentioned this pull request Mar 14, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@noahfalk noahfalk noahfalk left review comments

@tarekgh tarekgh tarekgh left review comments

@geeknoid geeknoid geeknoid left review comments

@KalleOlaviNiemitalo KalleOlaviNiemitalo KalleOlaviNiemitalo left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@evgenyfedorov2 evgenyfedorov2

Labels
area-telemetry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@evgenyfedorov2 @dotnet-comment-bot @tarekgh @noahfalk @geeknoid @KalleOlaviNiemitalo