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

Few more unit tests to cover MessageData and ExceptionData #27282

Merged
merged 1 commit into from
Mar 2, 2022
Merged

Few more unit tests to cover MessageData and ExceptionData #27282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 42 additions & 0 deletions ...penTelemetry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/LogsHelperTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using Azure.Core;
using Azure.Monitor.OpenTelemetry.Exporter.Models;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Logs;
using Xunit;

Expand Down Expand Up @@ -41,6 +43,7 @@ public void MessageIsSetToFormattedMessageWhenIncludeFormattedMessageIsSet()
Assert.Equal("tomato", name);
Assert.True(properties.TryGetValue("price", out string price));
Assert.Equal("2.99", price);
Assert.Equal(3, properties.Count);
}

[Fact]
Expand Down Expand Up @@ -70,6 +73,7 @@ public void MessageIsSetToOriginalFormatWhenIncludeFormattedMessageIsNotSet()
Assert.Equal("tomato", name);
Assert.True(properties.TryGetValue("price", out string price));
Assert.Equal("2.99", price);
Assert.Equal(2, properties.Count);
}

[Fact]
Expand Down Expand Up @@ -97,6 +101,7 @@ public void PropertiesContainFieldsFromStructuredLogs()
Assert.Equal("tomato", name);
Assert.True(properties.TryGetValue("price", out string price));
Assert.Equal("2.99", price);
Assert.Equal(2, properties.Count);
}

[Fact]
Expand Down Expand Up @@ -124,6 +129,7 @@ public void PropertiesContainFieldsFromStructuredLogsIfParseStateValuesIsSet()
Assert.Equal("Tomato", name);
Assert.True(properties.TryGetValue("Price", out string price));
Assert.Equal("2.99", price);
Assert.Equal(2, properties.Count);
}

[Fact]
Expand Down Expand Up @@ -152,6 +158,7 @@ public void PropertiesContainEventIdAndEventNameIfSetOnLog()
Assert.Equal("1", eventId);
Assert.True(properties.TryGetValue("EventName", out string eventName));
Assert.Equal("TestEvent", eventName);
Assert.Equal(2, properties.Count);
}

[Fact]
Expand All @@ -164,5 +171,40 @@ public void ValidateSeverityLevels()
Assert.Equal(SeverityLevel.Verbose, LogsHelper.GetSeverityLevel(LogLevel.Debug));
Assert.Equal(SeverityLevel.Verbose, LogsHelper.GetSeverityLevel(LogLevel.Trace));
}

[Theory]
[InlineData("ExceptionData")]
[InlineData("MessageData")]
public void ValidateTelemetryItem(string type)
{
var logRecords = new List<LogRecord>();
using var loggerFactory = LoggerFactory.Create(builder =>
{
builder.AddOpenTelemetry(options =>
{
options.ParseStateValues = true;
options.AddInMemoryExporter(logRecords);
});
builder.AddFilter(typeof(LogsHelperTests).FullName, LogLevel.Trace);
});

var logger = loggerFactory.CreateLogger<LogsHelperTests>();

if (type == "MessageData")
{
logger.LogInformation("This is a test log");
}
else
{
logger.LogWarning(new Exception("Test Exception"), "Test Exception");
}

var telemetryItem = LogsHelper.OtelToAzureMonitorLogs(new Batch<LogRecord>(logRecords.ToArray(), logRecords.Count), "roleName", "roleInstance", "Ikey");

Assert.Equal(type, telemetryItem[0].Data.BaseType);
Assert.Equal("Ikey", telemetryItem[0].InstrumentationKey);
Assert.Equal("roleName", telemetryItem[0].Tags[ContextTagKeys.AiCloudRole.ToString()]);
Assert.Equal("roleInstance", telemetryItem[0].Tags[ContextTagKeys.AiCloudRoleInstance.ToString()]);
}
}
}
43 changes: 43 additions & 0 deletions ...enTelemetry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/MessageDataTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System.Collections.Generic;
using Azure.Monitor.OpenTelemetry.Exporter.Models;
using Microsoft.Extensions.Logging;
using OpenTelemetry.Logs;
using Xunit;

namespace Azure.Monitor.OpenTelemetry.Exporter.Tests
{
public class MessageDataTests
{
[Theory]
[InlineData(LogLevel.Information)]
[InlineData(LogLevel.Warning)]
[InlineData(LogLevel.Critical)]
[InlineData(LogLevel.Error)]
public void ValidateMessageData(LogLevel logLevel)
{
var logRecords = new List<LogRecord>();
using var loggerFactory = LoggerFactory.Create(builder =>
{
builder.AddOpenTelemetry(options =>
{
options.AddInMemoryExporter(logRecords);
});
builder.AddFilter(typeof(LogsHelperTests).FullName, LogLevel.Trace);
});

var logger = loggerFactory.CreateLogger<MessageDataTests>();

logger.Log(logLevel, "Log Message");

var messageData = new MessageData(2, logRecords[0]);

Assert.Equal("Log Message", messageData.Message);
Assert.Equal(LogsHelper.GetSeverityLevel(logLevel), messageData.SeverityLevel);
Assert.Empty(messageData.Properties);
Assert.Empty(messageData.Measurements);
}
}
}
53 changes: 45 additions & 8 deletions ....Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/TelemetryExceptionDataTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,10 @@ public void ExceptionDataContainsExceptionDetails()
{
options.AddInMemoryExporter(logRecords);
});
builder.AddFilter(typeof(LogsHelperTests).FullName, LogLevel.Trace);
builder.AddFilter(typeof(TelemetryExceptionDataTests).FullName, LogLevel.Trace);
});

var logger = loggerFactory.CreateLogger<LogsHelperTests>();
var logger = loggerFactory.CreateLogger<TelemetryExceptionDataTests>();

var exception = CreateException(1);
logger.LogWarning(exception, exception.Message);
Expand All @@ -207,10 +207,10 @@ public void ExceptionDataContainsExceptionDetailsofAllInnerExceptionsOfAggregate
{
options.AddInMemoryExporter(logRecords);
});
builder.AddFilter(typeof(LogsHelperTests).FullName, LogLevel.Trace);
builder.AddFilter(typeof(TelemetryExceptionDataTests).FullName, LogLevel.Trace);
});

var logger = loggerFactory.CreateLogger<LogsHelperTests>();
var logger = loggerFactory.CreateLogger<TelemetryExceptionDataTests>();

Exception innerException1 = new ArgumentException("Inner1");
Exception innerException2 = new ArgumentException("Inner2");
Expand Down Expand Up @@ -239,10 +239,10 @@ public void ExceptionDataContainsExceptionDetailsWithAllInnerExceptions()
{
options.AddInMemoryExporter(logRecords);
});
builder.AddFilter(typeof(LogsHelperTests).FullName, LogLevel.Trace);
builder.AddFilter(typeof(TelemetryExceptionDataTests).FullName, LogLevel.Trace);
});

var logger = loggerFactory.CreateLogger<LogsHelperTests>();
var logger = loggerFactory.CreateLogger<TelemetryExceptionDataTests>();

var innerException1 = new Exception("Inner1");

Expand Down Expand Up @@ -272,10 +272,10 @@ public void AggregateExceptionsWithMultipleNestedExceptionsAreTrimmedAfterReachi
{
options.AddInMemoryExporter(logRecords);
});
builder.AddFilter(typeof(LogsHelperTests).FullName, LogLevel.Trace);
builder.AddFilter(typeof(TelemetryExceptionDataTests).FullName, LogLevel.Trace);
});

var logger = loggerFactory.CreateLogger<LogsHelperTests>();
var logger = loggerFactory.CreateLogger<TelemetryExceptionDataTests>();

int numberOfExceptions = 15;
int maxNumberOfExceptionsAllowed = 10;
Expand Down Expand Up @@ -315,6 +315,43 @@ public void AggregateExceptionsWithMultipleNestedExceptionsAreTrimmedAfterReachi
lastExceptionInList.Message);
}

[Theory]
[InlineData(LogLevel.Information)]
[InlineData(LogLevel.Warning)]
[InlineData(LogLevel.Critical)]
[InlineData(LogLevel.Error)]
public void ValidateTelemetryExceptionData(LogLevel logLevel)
{
var logRecords = new List<LogRecord>();
using var loggerFactory = LoggerFactory.Create(builder =>
{
builder.AddOpenTelemetry(options =>
{
options.AddInMemoryExporter(logRecords);
});
builder.AddFilter(typeof(TelemetryExceptionDataTests).FullName, LogLevel.Trace);
});

var logger = loggerFactory.CreateLogger<TelemetryExceptionDataTests>();

var ex = new Exception("Message");
logger.Log(logLevel, ex, "Message");

var exceptionData = new TelemetryExceptionData(2, logRecords[0]);

Assert.Equal(2, exceptionData.Version);
Assert.Equal(LogsHelper.GetSeverityLevel(logLevel), exceptionData.SeverityLevel);
Assert.Empty(exceptionData.Properties);
Assert.Empty(exceptionData.Measurements);
Assert.Equal(typeof(Exception).FullName + " at UnknownMethod", exceptionData.ProblemId);
Assert.Equal(1, exceptionData.Exceptions.Count);
Assert.Equal("Message", exceptionData.Exceptions[0].Message);
Assert.Null(exceptionData.Exceptions[0].Stack);
Assert.Equal(ex.GetHashCode(), exceptionData.Exceptions[0].Id);
Assert.Empty(exceptionData.Exceptions[0].ParsedStack);
Assert.True(exceptionData.Exceptions[0].HasFullStack);
}

[MethodImpl(MethodImplOptions.NoInlining)]
private Exception CreateException(int stackDepth)
{
Expand Down