Skip to content

feat(logs): rework method overloads of Structured Logger #4451

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

Merged
jamescrosswell merged 4 commits into from
Aug 25, 2025
Merged

feat(logs): rework method overloads of Structured Logger #4451

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6da7bca
feat(logs): rework Logger overloads
Flash0ver Aug 15, 2025
3f35a57
Merge branch 'main' into feat/logs-api-overloads
Flash0ver Aug 16, 2025
4d0ff81
docs: update CHANGELOG.md
Flash0ver Aug 16, 2025
0d19dea
style: unwrap Param-Array arguments
Flash0ver Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
style: unwrap Param-Array arguments
  • Loading branch information
@Flash0ver
Flash0ver committed Aug 22, 2025
commit 0d19dea8994bf1cc63cf3800be8d8f7928a8a0cd
16 changes: 8 additions & 8 deletions test/Sentry.Tests/SentryStructuredLoggerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public void Log_WithoutTraceHeader_CapturesEnvelope()
Envelope envelope = null!;
_fixture.Hub.CaptureEnvelope(Arg.Do<Envelope>(arg => envelope = arg));

logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", ["string", true, 1, 2.2]);
logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);
logger.Flush();

_fixture.Hub.Received(1).CaptureEnvelope(Arg.Any<Envelope>());
Expand All @@ -124,7 +124,7 @@ public void Log_WithBeforeSendLog_InvokesCallback()
});
var logger = _fixture.GetSut();

logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", ["string", true, 1, 2.2]);
logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);
logger.Flush();

_fixture.Hub.Received(1).CaptureEnvelope(Arg.Any<Envelope>());
Expand All @@ -145,7 +145,7 @@ public void Log_WhenBeforeSendLogReturnsNull_DoesNotCaptureEnvelope()
});
var logger = _fixture.GetSut();

logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", ["string", true, 1, 2.2]);
logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);

_fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
invocations.Should().Be(1);
Expand All @@ -157,7 +157,7 @@ public void Log_InvalidFormat_DoesNotCaptureEnvelope()
_fixture.Options.Experimental.EnableLogs = true;
var logger = _fixture.GetSut();

logger.LogTrace("Template string with arguments: {0}, {1}, {2}, {3}, {4}", ["string", true, 1, 2.2]);
logger.LogTrace("Template string with arguments: {0}, {1}, {2}, {3}, {4}", "string", true, 1, 2.2);

_fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
var entry = _fixture.DiagnosticLogger.Dequeue();
Expand All @@ -173,7 +173,7 @@ public void Log_InvalidConfigureLog_DoesNotCaptureEnvelope()
_fixture.Options.Experimental.EnableLogs = true;
var logger = _fixture.GetSut();

logger.LogTrace(static (SentryLog log) => throw new InvalidOperationException(), "Template string with arguments: {0}, {1}, {2}, {3}", ["string", true, 1, 2.2]);
logger.LogTrace(static (SentryLog log) => throw new InvalidOperationException(), "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);

_fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
var entry = _fixture.DiagnosticLogger.Dequeue();
Expand All @@ -190,7 +190,7 @@ public void Log_InvalidBeforeSendLog_DoesNotCaptureEnvelope()
_fixture.Options.Experimental.SetBeforeSendLog(static (SentryLog log) => throw new InvalidOperationException());
var logger = _fixture.GetSut();

logger.LogTrace("Template string with arguments: {0}, {1}, {2}, {3}", ["string", true, 1, 2.2]);
logger.LogTrace("Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);

_fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
var entry = _fixture.DiagnosticLogger.Dequeue();
Expand All @@ -213,7 +213,7 @@ public void Flush_AfterLog_CapturesEnvelope()
_fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
envelope.Should().BeNull();

logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", ["string", true, 1, 2.2]);
logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);
_fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
envelope.Should().BeNull();

Expand All @@ -230,7 +230,7 @@ public void Dispose_BeforeLog_DoesNotCaptureEnvelope()

var defaultLogger = logger.Should().BeOfType<DefaultSentryStructuredLogger>().Which;
defaultLogger.Dispose();
logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", ["string", true, 1, 2.2]);
logger.LogTrace(ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);

_fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
var entry = _fixture.DiagnosticLogger.Dequeue();
Expand Down
Loading