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.

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

fix: does not serialize exception in ProduceTelemetry #539

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions src/KafkaFlow.Abstractions/ILogHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ public interface ILogHandler
/// <param name="data">Additional data related to the warning log</param>
void Warning(string message, object data);

/// <summary>
/// Writes a warning log entry
/// </summary>
/// <param name="message">Warning message</param>
/// <param name="ex">Exception thrown</param>
/// <param name="data">Additional data related to the warning log</param>
void Warning(string message, Exception ex, object data);

/// <summary>
/// Writes a info log entry
/// </summary>
Expand Down
6 changes: 6 additions & 0 deletions src/KafkaFlow.Abstractions/NullLogHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ public void Warning(string message, object data)
// Do nothing
}

/// <inheritdoc />
public void Warning(string message, Exception ex, object data)
{
// Do nothing
}

/// <inheritdoc />
public void Info(string message, object data)
{
Expand Down
2 changes: 1 addition & 1 deletion src/KafkaFlow.Admin/TelemetryScheduler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ private void ProduceTelemetry(
}
catch (Exception e)
{
_logHandler.Warning("Error producing telemetry data", new { Exception = e });
_logHandler.Warning("Error producing telemetry data", e, null);
}
}
}
15 changes: 15 additions & 0 deletions src/KafkaFlow.LogHandler.Console/ConsoleLogHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@ public void Warning(string message, object data) => Print(
$"\nKafkaFlow: {message} | Data: {JsonSerializer.Serialize(data)}",
ConsoleColor.Yellow);

public void Warning(string message, Exception ex, object data)
{
var serializedException = JsonSerializer.Serialize(
new
{
Type = ex.GetType().FullName,
ex.Message,
ex.StackTrace,
});

Print(
$"\nKafkaFlow: {message} | Data: {JsonSerializer.Serialize(data)} | Exception: {serializedException}",
ConsoleColor.Yellow);
}

public void Info(string message, object data) => Print(
$"\nKafkaFlow: {message} | Data: {JsonSerializer.Serialize(data)}",
ConsoleColor.Green);
Expand Down
36 changes: 32 additions & 4 deletions src/KafkaFlow.LogHandler.Microsoft/MicrosoftLogHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ namespace KafkaFlow;

internal class MicrosoftLogHandler : ILogHandler
{
private const string SerializationErrorMessage = "Log data serialization error.";

private readonly ILogger _logger;

public MicrosoftLogHandler(ILoggerFactory loggerFactory)
Expand All @@ -15,21 +17,47 @@ public MicrosoftLogHandler(ILoggerFactory loggerFactory)

public void Error(string message, Exception ex, object data)
{
_logger.LogError(ex, "{Message} | Data: {Data}", message, JsonSerializer.Serialize(data));
_logger.LogError(ex, "{Message} | Data: {Data}", message, SerializeData(data));
}

public void Warning(string message, object data)
{
_logger.LogWarning("{Message} | Data: {Data}", message, JsonSerializer.Serialize(data));
_logger.LogWarning("{Message} | Data: {Data}", message, SerializeData(data));
}

public void Warning(string message, Exception ex, object data)
{
_logger.LogWarning(ex, "{Message} | Data: {Data}", message, SerializeData(data));
}

public void Info(string message, object data)
{
_logger.LogInformation("{Message} | Data: {Data}", message, JsonSerializer.Serialize(data));
_logger.LogInformation("{Message} | Data: {Data}", message, SerializeData(data));
}

public void Verbose(string message, object data)
{
_logger.LogDebug("{Message} | Data: {Data}", message, JsonSerializer.Serialize(data));
_logger.LogDebug("{Message} | Data: {Data}", message, SerializeData(data));
}

private string SerializeData(object data)
joelfoliveira marked this conversation as resolved.
Show resolved Hide resolved
{
if (data is null)
{
return null;
}

try
{
return JsonSerializer.Serialize(data);
}
catch(Exception ex)
{
return JsonSerializer.Serialize(new
{
Error = SerializationErrorMessage,
Exception = $"Message: {ex.Message}, Trace: {ex.StackTrace}",
});
}
}
}
12 changes: 12 additions & 0 deletions tests/KafkaFlow.IntegrationTests/Core/TraceLogHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ public void Warning(string message, object data)
}));
}

public void Warning(string message, Exception ex, object data)
{
Trace.TraceWarning(
JsonSerializer.Serialize(
new
{
Message = message,
Exception = ex,
Data = data,
}));
}

public void Info(string message, object data)
{
Trace.TraceInformation(
Expand Down
29 changes: 29 additions & 0 deletions tests/KafkaFlow.UnitTests/LogHandlers/MicrosoftLogHandlerTests.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
using Microsoft.Extensions.Logging;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using System;
using System.Linq;

namespace KafkaFlow.UnitTests.LogHandlers;

Expand All @@ -21,4 +23,31 @@ public void Constructor_CreatesNamedLogger()
// Assert
loggerFactoryMock.Verify(x => x.CreateLogger("KafkaFlow"), Times.Once);
}

[TestMethod]
public void LogWarning_WithNotSerializableData_DoesNotSerializeObject()
{
// Arrange
var expectedMessage = "Any message";
var expectedSerializationErrorMessage = "Log data serialization error.";
var loggerMock = new Mock<ILogger>();
var loggerFactoryMock = new Mock<ILoggerFactory>();

loggerFactoryMock
.Setup(x => x.CreateLogger("KafkaFlow"))
.Returns(loggerMock.Object);

var handler = new MicrosoftLogHandler(loggerFactoryMock.Object);

// Act
handler.Warning(expectedMessage, new
{
In = new IntPtr(1)
});

// Assert
Assert.AreEqual(1, loggerMock.Invocations.Count);
Assert.IsTrue(loggerMock.Invocations[0].Arguments.Any(x => x.ToString().Contains(expectedMessage)));
Assert.IsTrue(loggerMock.Invocations[0].Arguments.Any(x => x.ToString().Contains(expectedSerializationErrorMessage)));
}
}
Loading