Skip to content

[sdk.logging] More consistent handling of StateValues/Attributes #4334

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
utpilla merged 22 commits into from
Apr 20, 2023
Merged

[sdk.logging] More consistent handling of StateValues/Attributes #4334

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
cd70d9f
Bring back some of the logging enhancements done in the main-logs bra…
CodeBlanch Mar 21, 2023
7f2b483
Code review.
CodeBlanch Mar 28, 2023
2bb97b6
Fixes and cleanup.
CodeBlanch Mar 28, 2023
2b39d48
Test fixes WIP.
CodeBlanch Mar 30, 2023
ba21e1f
Test fixes.
CodeBlanch Mar 30, 2023
9a681e1
Code review.
CodeBlanch Mar 30, 2023
c25e48f
Tweak.
CodeBlanch Mar 30, 2023
8988973
Update commented out code for better perf in the future.
CodeBlanch Mar 30, 2023
162e8c1
Test updates.
CodeBlanch Mar 30, 2023
054cfef
CHANGELOG updates.
CodeBlanch Mar 30, 2023
4fddbde
Merge branch 'main' into logging-improvements
CodeBlanch Mar 30, 2023
23142c5
Merge from main.
CodeBlanch Apr 5, 2023
c037345
Code review.
CodeBlanch Apr 5, 2023
dff71fa
Code review.
CodeBlanch Apr 5, 2023
f061d69
Code review.
CodeBlanch Apr 5, 2023
ad67d6c
Test updates.
CodeBlanch Apr 5, 2023
755c1ab
Merge branch 'main' into logging-improvements
CodeBlanch Apr 5, 2023
841bfe1
Made new options internal.
CodeBlanch Apr 10, 2023
602449c
Merge from main.
CodeBlanch Apr 18, 2023
b065a05
Code review.
CodeBlanch Apr 18, 2023
27ee661
Merge branch 'main' into logging-improvements
utpilla Apr 19, 2023
32e48de
Merge branch 'main' into logging-improvements
cijothomas Apr 20, 2023
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
Next Next commit
Test fixes.
  • Loading branch information
@CodeBlanch
CodeBlanch committed Mar 30, 2023
commit ba21e1f1a8fe2841788fe543eaafec7ec038e689
144 changes: 94 additions & 50 deletions test/OpenTelemetry.Tests/Logs/LogRecordTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,92 +71,148 @@ public void CheckLogLevel(LogLevel logLevel)
Assert.Equal(logLevel, logLevelRecorded);
}

[Fact]
public void CheckStateForUnstructuredLog()
[Theory]
[InlineData(true)]
[InlineData(false)]
public void CheckStateForUnstructuredLog(bool includeFormattedMessage)
{
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: null);
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: o => o.IncludeFormattedMessage = includeFormattedMessage);
var logger = loggerFactory.CreateLogger<LogRecordTest>();

const string message = "Hello, World!";
logger.LogInformation(message);
var state = exportedItems[0].State as IReadOnlyList<KeyValuePair<string, object>>;

Assert.Null(exportedItems[0].State);

var attributes = exportedItems[0].Attributes;
Assert.NotNull(attributes);

// state only has {OriginalFormat}
Assert.Equal(1, state.Count);
Assert.Equal(1, attributes.Count);

Assert.Equal(message, state.ToString());
Assert.Equal(message, exportedItems[0].Body);
if (includeFormattedMessage)
{
Assert.Equal(message, exportedItems[0].FormattedMessage);
}
else
{
Assert.Null(exportedItems[0].FormattedMessage);
}
}

[Fact]
[Theory]
[InlineData(true)]
[InlineData(false)]
[SuppressMessage("CA2254", "CA2254", Justification = "While you shouldn't use interpolation in a log message, this test verifies things work with it anyway.")]
public void CheckStateForUnstructuredLogWithStringInterpolation()
public void CheckStateForUnstructuredLogWithStringInterpolation(bool includeFormattedMessage)
{
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: null);
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: o => o.IncludeFormattedMessage = includeFormattedMessage);
var logger = loggerFactory.CreateLogger<LogRecordTest>();

var message = $"Hello from potato {0.99}.";
logger.LogInformation(message);
var state = exportedItems[0].State as IReadOnlyList<KeyValuePair<string, object>>;

Assert.Null(exportedItems[0].State);

var attributes = exportedItems[0].Attributes;
Assert.NotNull(attributes);

// state only has {OriginalFormat}
Assert.Equal(1, state.Count);
Assert.Equal(1, attributes.Count);

Assert.Equal(message, state.ToString());
Assert.Equal(message, exportedItems[0].Body);
if (includeFormattedMessage)
{
Assert.Equal(message, exportedItems[0].FormattedMessage);
}
else
{
Assert.Null(exportedItems[0].FormattedMessage);
}
}

[Fact]
public void CheckStateForStructuredLogWithTemplate()
[Theory]
[InlineData(true)]
[InlineData(false)]
public void CheckStateForStructuredLogWithTemplate(bool includeFormattedMessage)
{
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: null);
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: o => o.IncludeFormattedMessage = includeFormattedMessage);
var logger = loggerFactory.CreateLogger<LogRecordTest>();

const string message = "Hello from {name} {price}.";
logger.LogInformation(message, "tomato", 2.99);
var state = exportedItems[0].State as IReadOnlyList<KeyValuePair<string, object>>;

Assert.Null(exportedItems[0].State);

var attributes = exportedItems[0].Attributes;
Assert.NotNull(attributes);

// state has name, price and {OriginalFormat}
Assert.Equal(3, state.Count);
Assert.Equal(3, attributes.Count);

// Check if state has name
Assert.Contains(state, item => item.Key == "name");
Assert.Equal("tomato", state.First(item => item.Key == "name").Value);
Assert.Contains(attributes, item => item.Key == "name");
Assert.Equal("tomato", attributes.First(item => item.Key == "name").Value);

// Check if state has price
Assert.Contains(state, item => item.Key == "price");
Assert.Equal(2.99, state.First(item => item.Key == "price").Value);
Assert.Contains(attributes, item => item.Key == "price");
Assert.Equal(2.99, attributes.First(item => item.Key == "price").Value);

// Check if state has OriginalFormat
Assert.Contains(state, item => item.Key == "{OriginalFormat}");
Assert.Equal(message, state.First(item => item.Key == "{OriginalFormat}").Value);
Assert.Contains(attributes, item => item.Key == "{OriginalFormat}");
Assert.Equal(message, attributes.First(item => item.Key == "{OriginalFormat}").Value);

Assert.Equal($"Hello from tomato 2.99.", state.ToString());
Assert.Equal(message, exportedItems[0].Body);
if (includeFormattedMessage)
{
Assert.Equal("Hello from tomato 2.99.", exportedItems[0].FormattedMessage);
}
else
{
Assert.Null(exportedItems[0].FormattedMessage);
}
}

[Fact]
public void CheckStateForStructuredLogWithStrongType()
[Theory]
[InlineData(true)]
[InlineData(false)]
public void CheckStateForStructuredLogWithStrongType(bool includeFormattedMessage)
{
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: null);
using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: o => o.IncludeFormattedMessage = includeFormattedMessage);
var logger = loggerFactory.CreateLogger<LogRecordTest>();

var food = new Food { Name = "artichoke", Price = 3.99 };
logger.LogInformation("{food}", food);
var state = exportedItems[0].State as IReadOnlyList<KeyValuePair<string, object>>;

Assert.Null(exportedItems[0].State);

var attributes = exportedItems[0].Attributes;
Assert.NotNull(attributes);

// state has food and {OriginalFormat}
Assert.Equal(2, state.Count);
Assert.Equal(2, attributes.Count);

// Check if state has food
Assert.Contains(state, item => item.Key == "food");
Assert.Contains(attributes, item => item.Key == "food");

var foodParameter = (Food)state.First(item => item.Key == "food").Value;
var foodParameter = (Food)attributes.First(item => item.Key == "food").Value;
Assert.Equal(food.Name, foodParameter.Name);
Assert.Equal(food.Price, foodParameter.Price);

// Check if state has OriginalFormat
Assert.Contains(state, item => item.Key == "{OriginalFormat}");
Assert.Equal("{food}", state.First(item => item.Key == "{OriginalFormat}").Value);
Assert.Contains(attributes, item => item.Key == "{OriginalFormat}");
Assert.Equal("{food}", attributes.First(item => item.Key == "{OriginalFormat}").Value);

Assert.Equal(food.ToString(), state.ToString());
Assert.Equal("{food}", exportedItems[0].Body);
if (includeFormattedMessage)
{
Assert.Equal(food.ToString(), exportedItems[0].FormattedMessage);
}
else
{
Assert.Null(exportedItems[0].FormattedMessage);
}
}

[Theory]
Expand Down Expand Up @@ -642,14 +698,8 @@ public void VerifyParseStateValues_UsingStandardExtensions(bool parseStateValues
logger.LogInformation("{Product} {Year}!", "OpenTelemetry", 2021);
var logRecord = exportedItems[0];

if (parseStateValues)
{
Assert.Null(logRecord.State);
}
else
{
Assert.NotNull(logRecord.State);
}
Assert.NotNull(logRecord.StateValues);
Assert.Null(logRecord.State);

Assert.NotNull(logRecord.StateValues);
Assert.Equal(3, logRecord.StateValues.Count);
Expand All @@ -662,14 +712,8 @@ public void VerifyParseStateValues_UsingStandardExtensions(bool parseStateValues
logger.LogInformation("{Product} {Year} {Complex}!", "OpenTelemetry", 2021, complex);
logRecord = exportedItems[1];

if (parseStateValues)
{
Assert.Null(logRecord.State);
}
else
{
Assert.NotNull(logRecord.State);
}
Assert.NotNull(logRecord.StateValues);
Assert.Null(logRecord.State);

Assert.NotNull(logRecord.StateValues);
Assert.Equal(4, logRecord.StateValues.Count);
Expand Down