Skip to content

Enabled command line trace option #516

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

Draft
vamsipolavarapu-msft wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Enabled command line trace option #516

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f581bed
Enabled command-line trace option
vamsipolavarapu Oct 22, 2025
7b22670
Refactor logging configuration and usage
vamsipolavarapu Oct 23, 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
14 changes: 14 additions & 0 deletions src/Shared.CLI/BaseTool.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,20 @@ protected void SelectOutput(string outputFile)
}
}

protected void ConfigureLogging(BaseToolOptions options)
{
if (options.EnableTraceLogging)
{
var config = NLog.LogManager.Configuration;
var rule = config.LoggingRules.FirstOrDefault();
if (rule != null)
{
rule.SetLoggingLevels(NLog.LogLevel.Trace, NLog.LogLevel.Fatal);
NLog.LogManager.ReconfigExistingLoggers();
}
}
}

private bool redirectConsole = false;
}
}
3 changes: 3 additions & 0 deletions src/Shared.CLI/Options/BaseToolOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ namespace Microsoft.CST.OpenSource.OssGadget.Options;

public class BaseToolOptions
{
[Option('t', "trace", Required = false, Default = false,
HelpText = "Enable trace-level logging")]
public bool EnableTraceLogging { get; set; }
Copy link
Contributor

@danfiedler-msft danfiedler-msft Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've added an option to enable trace logging to the BaseToolOptions which is used by most, if not all, commands in OSSGadget. However, your change only enables trace logging for the DownloadTool. This will be confusing for users.

Suggestions

  1. Allow the user to specify the log level using either string or numeric values. See nlog log levels and CommandLineParser docs

  2. The log level configuration should be respected across all commands. Ideally this logic isn't distributed across the commands (perhaps in BaseTool?)

}
2 changes: 2 additions & 0 deletions src/Shared.CLI/Tools/DownloadTool.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ public DownloadTool(ProjectManagerFactory projectManagerFactory)

public override async Task<ErrorCode> RunAsync(DownloadToolOptions options)
{
ConfigureLogging(options);

if (options.Targets is IEnumerable<string> targetList && targetList.Any())
{
foreach (string? target in targetList)
Expand Down