mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 01:25:40 -05:00
Enhanced Logging for sqltoolsservice (#695)
This change modifies the logging framework within sqltoolservice. Moves away from custom Logger object to start using .Net tracing framework. It supports for the static Trace and TraceSource way of logging. For all new code it is recommend that we log the log messages using the existing static Logger class, while the code changes will continue to route the older Trace.Write* calls from the process to same log listeners (and thus the log targets) as used by the Logger class. Thus tracing in SMO code that uses Trace.Write* methods gets routed to the same file as the messages from rest of SQLTools Service code. Make changes to start using .Net Frameworks codebase for all logging to unify our logging story. Allows parameter to set tracingLevel filters that controls what kinds of message make it to the log file. Allows a parameter to set a specific log file name so if these gets set by external code (the UI code using the tools service for example) then the external code is aware of the current log file in use. Adding unittests to test out the existing and improved logging capabilities. Sequences of checkins in development branch: * Saving v1 of logging to prepare for code review. Minor cleanup and some end to end testing still remains * Removing local launchSettings.json files * added support for lazy listener to sqltoolsloglistener and removed incorrect changes to comments across files in previous checkin * Converting time to local time when writing entries to the log * move the hosting.v2 to new .net based logging code * removing *.dgml files and addding them to .gitignore * fixing typo of defaultTraceSource * Addressing pull request feedback * Adding a test to verify logging from SMO codebase * propogating changes to v1 sqltools.hosting commandoptions.cs to the v2 version * Fixing comments on start and stop callstack methods and whitespaces * Commenting a test that got uncommented by mistake * addding .gitattributes file as .sql file was observed to be misconstrued as a binary file
This commit is contained in:
ranasaria
160
test/ScriptGenerator/CommandOptions.cs
Normal file
160
test/ScriptGenerator/CommandOptions.cs
Normal file
@@ -0,0 +1,160 @@
|
||||
//
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
||||
//
|
||||
|
||||
using System;
|
||||
using System.Globalization;
|
||||
using System.IO;
|
||||
|
||||
namespace ScriptGenerator
|
||||
{
|
||||
/// <summary>
|
||||
/// The command-line options helper class.
|
||||
/// </summary>
|
||||
public class CommandOptions
|
||||
{
|
||||
private const string DefaultFilePrefix = "AdventureWorks";
|
||||
/// <summary>
|
||||
/// Construct and parse command line options from the arguments array
|
||||
/// </summary>
|
||||
public CommandOptions(string[] args)
|
||||
{
|
||||
ErrorMessage = string.Empty;
|
||||
try
|
||||
{
|
||||
for (int i = 0; i < args.Length; ++i)
|
||||
{
|
||||
string arg = args[i];
|
||||
if (arg.StartsWith("--") || arg.StartsWith("-"))
|
||||
{
|
||||
// Extracting arguments and properties
|
||||
arg = arg.Substring(1).ToLowerInvariant();
|
||||
string argName = arg;
|
||||
switch (argName)
|
||||
{
|
||||
case "-filepathprefix":
|
||||
case "fp":
|
||||
FilePathPrefix = args[++i];
|
||||
break;
|
||||
case "-numberofdatabases":
|
||||
case "-numberofdbs":
|
||||
case "ndb":
|
||||
{
|
||||
if (int.TryParse(args[++i], out int n))
|
||||
{
|
||||
Databases = n;
|
||||
}
|
||||
else
|
||||
{
|
||||
ErrorMessage += $@"Argument for NumberOfDatabases:'{args[i]}' is not a valid integer";
|
||||
}
|
||||
break;
|
||||
}
|
||||
case "-tablesmultiplier":
|
||||
case "tm":
|
||||
{
|
||||
if (int.TryParse(args[++i], out int n))
|
||||
{
|
||||
TablesMultiplier = n;
|
||||
}
|
||||
else
|
||||
{
|
||||
ErrorMessage += $@"Argument for NumberOfTables:'{args[i]}' is not a valid integer";
|
||||
}
|
||||
break;
|
||||
}
|
||||
case "-storedproceduresmultiplier":
|
||||
case "spm":
|
||||
{
|
||||
if (int.TryParse(args[++i], out int n))
|
||||
{
|
||||
StoredProceduresMultiplier = n;
|
||||
}
|
||||
else
|
||||
{
|
||||
ErrorMessage += $@"Argument for NumberOfStoredProcedures:'{args[i]}' is not a valid integer";
|
||||
}
|
||||
break;
|
||||
}
|
||||
case "-viewsmultiplier":
|
||||
case "vm":
|
||||
{
|
||||
if (int.TryParse(args[++i], out int n))
|
||||
{
|
||||
ViewsMultiplier = n;
|
||||
}
|
||||
else
|
||||
{
|
||||
ErrorMessage += $@"Argument for NumberOfTables:'{args[i]}' is not a valid integer";
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case "h":
|
||||
case "-help":
|
||||
ShouldExit = true;
|
||||
return;
|
||||
default:
|
||||
ErrorMessage += string.Format("Unknown argument \"{0}\"" + Environment.NewLine, argName);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
ErrorMessage += ex.ToString();
|
||||
return;
|
||||
}
|
||||
finally
|
||||
{
|
||||
if (!string.IsNullOrEmpty(ErrorMessage) || ShouldExit)
|
||||
{
|
||||
Console.WriteLine(Usage);
|
||||
ShouldExit = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Contains any error messages during execution
|
||||
/// </summary>
|
||||
public string ErrorMessage { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Whether the program should exit immediately. Set to true when the usage is printed.
|
||||
/// </summary>
|
||||
public bool ShouldExit { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Get the usage string describing command-line arguments for the program
|
||||
/// </summary>
|
||||
public string Usage
|
||||
{
|
||||
get
|
||||
{
|
||||
var str = $@"{ErrorMessage}" + Environment.NewLine +
|
||||
" Options:" + Environment.NewLine +
|
||||
$@" [--filepathprefix **] (default {DefaultFilePrefix})" + Environment.NewLine +
|
||||
$@" [-fp **] (default {DefaultFilePrefix})" + Environment.NewLine +
|
||||
" [--NumberOfDatabases **] (default 1)" + Environment.NewLine +
|
||||
" [-ndb **] (default 1)" + Environment.NewLine +
|
||||
" [--TablesMultiplier **] (default 1)" + Environment.NewLine +
|
||||
" [-tm **] (default 1)" + Environment.NewLine +
|
||||
" [--ViewsMultiplier **] (default 1)" + Environment.NewLine +
|
||||
" [-vm **] (default 1)" + Environment.NewLine +
|
||||
" [--StoreProceduresMultiplier **] (default 1)" + Environment.NewLine +
|
||||
" [-spm **] (default 1)" + Environment.NewLine +
|
||||
" [--help]" + Environment.NewLine;
|
||||
return str;
|
||||
}
|
||||
}
|
||||
|
||||
public int Databases { get; private set; } = 1;
|
||||
public int TablesMultiplier { get; private set; } = 1;
|
||||
public int StoredProceduresMultiplier { get; private set; } = 1;
|
||||
public int ViewsMultiplier { get; private set; } = 1;
|
||||
public string FilePathPrefix { get; private set; } = DefaultFilePrefix;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user