Skip to content
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
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.1.16
2.1.17
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
namespace VirtualClient.Logging
{
using Microsoft.Extensions.Logging;
using VirtualClient.Common;

/// <summary>
/// A very thin settings passthrough provider as a stop gap to handle the missing obsoleted functionality .NET Core 2.2 and .NET Core 3.0 implementation.
/// See https://github.com/aspnet/EntityFramework.Docs/pull/1164 for full discussion of issue.
/// </summary>
[LoggerAlias("Console")]
public sealed class ConsoleLoggerProvider : ILoggerProvider
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ namespace VirtualClient.Logging
{
using System;
using Microsoft.Extensions.Logging;
using VirtualClient.Common;
using VirtualClient.Common.Extensions;
using VirtualClient.Contracts;
using ILogger = Microsoft.Extensions.Logging.ILogger;
Expand All @@ -13,6 +14,7 @@ namespace VirtualClient.Logging
/// Provides methods for creating <see cref="ILogger"/> instances that can be used
/// to write metrics data to a CSV file.
/// </summary>
[LoggerAlias("Csv,File")]
public sealed class MetricsCsvFileLoggerProvider : ILoggerProvider
{
private string filePath;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ namespace VirtualClient.Logging
{
using System;
using Microsoft.Extensions.Logging;
using VirtualClient.Common;
using VirtualClient.Common.Extensions;
using VirtualClient.Common.Telemetry;

/// <summary>
/// Provides methods for creating <see cref="ILogger"/> instances that can
/// be used to log events/messages to an Application Insights endpoint.
/// </summary>
[LoggerAlias("Eventhub")]
[LoggerSpecialization(Name = SpecializationConstant.Telemetry)]
public sealed class EventHubTelemetryLoggerProvider : ILoggerProvider
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

namespace VirtualClient.Common
{
using System;
using System.Collections.Generic;
using VirtualClient.Common.Extensions;

/// <summary>
/// Defines one or more aliases for ILoggerProvider class.
/// </summary>
[AttributeUsage(validOn: AttributeTargets.Class)]
public class LoggerAliasAttribute : Attribute
{
/// <summary>
/// Initializes a new instance of the <see cref="LoggerAliasAttribute"/> class.
/// </summary>
/// <param name="alias">Alias or aliases delimited by comma.</param>
public LoggerAliasAttribute(string alias)
{
alias.ThrowIfNullOrEmpty(nameof(alias));
this.Aliases = alias.Split(',');
}

/// <summary>
/// The aliases for the logger provider.
/// </summary>
public IEnumerable<string> Aliases { get; }
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ namespace VirtualClient.Logging
using System.Collections.Generic;
using global::Serilog;
using Microsoft.Extensions.Logging;
using VirtualClient.Common;
using VirtualClient.Common.Extensions;
using VirtualClient.Common.Telemetry;
using ILogger = Microsoft.Extensions.Logging.ILogger;
Expand All @@ -15,6 +16,7 @@ namespace VirtualClient.Logging
/// Provides methods for creating <see cref="ILogger"/> instances that can
/// be used to log events/messages to a local file.
/// </summary>
[LoggerAlias("File")]
[LoggerSpecialization(Name = SpecializationConstant.StructuredLogging)]
public sealed class SerilogFileLoggerProvider : ILoggerProvider, IDisposable
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,12 +313,14 @@ private string CreateSucceededOrFailedMessage(EventContext context)
string scenarioName = context.Properties["scenarioName"].ToString();
string outcome = context.Properties["metricName"].ToString();
outcome = outcome == "Succeeded" ? "PASS" : "* Failed *";
TimeSpan duration = (DateTime)context.Properties["scenarioEndTime"] - (DateTime)context.Properties["scenarioStartTime"];
DateTime scenarioStartTime = (DateTime)context.Properties["scenarioStartTime"];
DateTime scenarioEndTime = (DateTime)context.Properties["scenarioEndTime"];
TimeSpan duration = scenarioEndTime - scenarioStartTime;

messageBuilder.AppendLine();
messageBuilder.AppendMessage($"Component : {componentName} -> {scenarioName}");
messageBuilder.AppendMessage(SummaryFileLogger.DashLine);
messageBuilder.AppendMessage($"Duration : {duration.ToString()}");
messageBuilder.AppendMessage($"Duration : {duration.ToString()}. Start Time : {scenarioStartTime}. End Time : {scenarioEndTime}.");
messageBuilder.AppendMessage($"Outcome : {outcome}");
messageBuilder.AppendLine();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ namespace VirtualClient.Logging
using System;
using System.Runtime.InteropServices;
using Microsoft.Extensions.Logging;
using VirtualClient.Common;
using VirtualClient.Contracts;
using ILogger = Microsoft.Extensions.Logging.ILogger;

/// <summary>
/// Provides methods for creating <see cref="ILogger"/> instances that can be used
/// to write summary log files.
/// </summary>
[LoggerAlias("Summary,File")]
public sealed class SummaryFileLoggerProvider : ILoggerProvider
{
private string filePath;
Expand Down
13 changes: 6 additions & 7 deletions src/VirtualClient/VirtualClient.Main/CommandBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ namespace VirtualClient
using VirtualClient.Contracts.Metadata;
using VirtualClient.Contracts.Proxy;
using VirtualClient.Identity;
using VirtualClient.Logging;
using VirtualClient.Proxy;

/// <summary>
Expand Down Expand Up @@ -443,13 +444,6 @@ protected virtual IEnumerable<string> GetLoggerDefinitions()
loggerDefinitions.Add("console");
}

// Add default file logging
// e.g. (--logger=file)
if (loggerDefinitions?.Any(l => Regex.IsMatch(l, "^file", RegexOptions.IgnoreCase)) != true)
{
loggerDefinitions.Add("file");
}

// backward compatibility for --eventhub
if (!string.IsNullOrEmpty(this.EventHubStore))
{
Expand Down Expand Up @@ -688,6 +682,11 @@ protected virtual IList<ILoggerProvider> InitializeLoggerProviders(IConfiguratio
CommandBase.AddProxyApiLogging(loggingProviders, configuration, platformSpecifics, new Uri(loggerParameters), this.CertificateManager, source);
break;

case "summary":
ILoggerProvider summaryLoggerProvider = new SummaryFileLoggerProvider(string.Empty);
loggingProviders.Add(summaryLoggerProvider);
break;

default:
if (!ComponentTypeCache.Instance.TryGetComponentType(loggerName, out Type subcomponentType))
{
Expand Down
Loading