From c935db93dd73381be1f3b593d8c97f3d366b2446 Mon Sep 17 00:00:00 2001 From: Keivan Beigi Date: Wed, 27 Feb 2013 18:43:01 -0800 Subject: [PATCH] config file based logging configuration. --- NzbDrone.Common/LogConfiguration.cs | 52 +- NzbDrone.Test.Common/LoggingTest.cs | 7 +- NzbDrone.Update/Program.cs | 3 - NzbDrone/CentralDispatch.cs | 2 - NzbDrone/NLog.config | 17 + NzbDrone/NLog.xsd | 2585 +++++++++++++++++++++++++++ NzbDrone/NzbDrone.Console.csproj | 6 + NzbDrone/packages.config | 2 + 8 files changed, 2616 insertions(+), 58 deletions(-) create mode 100644 NzbDrone/NLog.config create mode 100644 NzbDrone/NLog.xsd diff --git a/NzbDrone.Common/LogConfiguration.cs b/NzbDrone.Common/LogConfiguration.cs index d7c16699a..ebea74d87 100644 --- a/NzbDrone.Common/LogConfiguration.cs +++ b/NzbDrone.Common/LogConfiguration.cs @@ -25,57 +25,7 @@ namespace NzbDrone.Common } } - public static void RegisterConsoleLogger(LogLevel minLevel, string loggerNamePattern = "*") - { - try - { - var consoleTarget = new ConsoleTarget(); - consoleTarget.Layout = "${message} ${exception}"; - LogManager.Configuration.AddTarget(consoleTarget.GetType().Name, consoleTarget); - LogManager.Configuration.LoggingRules.Add(new LoggingRule(loggerNamePattern, minLevel, consoleTarget)); - - LogManager.ConfigurationReloaded += (sender, args) => RegisterConsoleLogger(minLevel, loggerNamePattern); - } - catch (Exception e) - { - Console.WriteLine(e); - - if (LogManager.ThrowExceptions) - throw; - } - } - - public static void RegisterUdpLogger() - { - try - { - var udpTarget = new NLogViewerTarget(); - udpTarget.Address = "udp://127.0.0.1:20480"; - udpTarget.IncludeCallSite = true; - udpTarget.IncludeSourceInfo = true; - udpTarget.IncludeNLogData = true; - udpTarget.IncludeNdc = true; - udpTarget.Parameters.Add(new NLogViewerParameterInfo - { - Name = "Exception", - Layout = "${exception:format=ToString}" - }); - - LogManager.Configuration.AddTarget(udpTarget.GetType().Name, udpTarget); - LogManager.Configuration.LoggingRules.Add(new LoggingRule("*", LogLevel.Trace, udpTarget)); - - LogManager.ConfigurationReloaded += (sender, args) => RegisterUdpLogger(); - } - catch (Exception e) - { - Console.WriteLine(e); - - if (LogManager.ThrowExceptions) - throw; - } - } - - + private static FileTarget GetBaseTarget() { var fileTarget = new FileTarget(); diff --git a/NzbDrone.Test.Common/LoggingTest.cs b/NzbDrone.Test.Common/LoggingTest.cs index 78788d3ff..93765a35e 100644 --- a/NzbDrone.Test.Common/LoggingTest.cs +++ b/NzbDrone.Test.Common/LoggingTest.cs @@ -1,5 +1,6 @@ using NLog; using NLog.Config; +using NLog.Targets; using NUnit.Framework; using NzbDrone.Common; @@ -15,8 +16,10 @@ namespace NzbDrone.Test.Common if (LogManager.Configuration == null || LogManager.Configuration is XmlLoggingConfiguration) { LogManager.Configuration = new LoggingConfiguration(); - LogConfiguration.RegisterConsoleLogger(LogLevel.Trace); - LogConfiguration.RegisterUdpLogger(); + var consoleTarget = new ConsoleTarget(); + consoleTarget.Layout = "${message} ${exception}"; + LogManager.Configuration.AddTarget(consoleTarget.GetType().Name, consoleTarget); + LogManager.Configuration.LoggingRules.Add(new LoggingRule("*", consoleTarget)); RegisterExceptionVerification(); LogConfiguration.Reload(); diff --git a/NzbDrone.Update/Program.cs b/NzbDrone.Update/Program.cs index aeceb4089..66eb95c11 100644 --- a/NzbDrone.Update/Program.cs +++ b/NzbDrone.Update/Program.cs @@ -66,9 +66,6 @@ namespace NzbDrone.Update LogConfiguration.RegisterRemote(); - LogConfiguration.RegisterConsoleLogger(LogLevel.Trace); - LogConfiguration.RegisterUdpLogger(); - var logPath = Path.Combine(new EnvironmentProvider().GetSandboxLogFolder(), DateTime.Now.ToString("yyyy.MM.dd-H-mm") + ".txt"); LogConfiguration.RegisterFileLogger(logPath, LogLevel.Info); diff --git a/NzbDrone/CentralDispatch.cs b/NzbDrone/CentralDispatch.cs index 8f3972d58..eff74a6d5 100644 --- a/NzbDrone/CentralDispatch.cs +++ b/NzbDrone/CentralDispatch.cs @@ -45,8 +45,6 @@ namespace NzbDrone ReportingService.SetupExceptronDriver(); LogConfiguration.RegisterRollingFileLogger(environmentProvider.GetLogFileName(), LogLevel.Info); - LogConfiguration.RegisterConsoleLogger(LogLevel.Debug); - LogConfiguration.RegisterUdpLogger(); LogConfiguration.RegisterRemote(); LogConfiguration.Reload(); logger.Info("Start-up Path:'{0}'", environmentProvider.ApplicationPath); diff --git a/NzbDrone/NLog.config b/NzbDrone/NLog.config new file mode 100644 index 000000000..61c6ca938 --- /dev/null +++ b/NzbDrone/NLog.config @@ -0,0 +1,17 @@ + + + + + + + Exception + ${exception:format=ToString} + + + + + + + + \ No newline at end of file diff --git a/NzbDrone/NLog.xsd b/NzbDrone/NLog.xsd new file mode 100644 index 000000000..2203f4ede --- /dev/null +++ b/NzbDrone/NLog.xsd @@ -0,0 +1,2585 @@ + + + + + + + + + + + + + + Watch config file for changes and reload automatically. + + + + + Print internal NLog messages to the console. Default value is: false + + + + + Print internal NLog messages to the console error output. Default value is: false + + + + + Write internal NLog messages to the specified file. + + + + + Log level threshold for internal log messages. Default value is: Info. + + + + + Global log level threshold for application log messages. Messages below this level won't be logged.. + + + + + Pass NLog internal exceptions to the application. Default value is: false. + + + + + + + + + + + + + + Make all targets within this section asynchronous (creates additional threads but the calling thread isn't blocked by any target writes). + + + + + + + + + + + + + + + + + Prefix for targets/layout renderers/filters/conditions loaded from this assembly. + + + + + Load NLog extensions from the specified file (*.dll) + + + + + Load NLog extensions from the specified assembly. Assembly name should be fully qualified. + + + + + + + + + + Name of the logger. May include '*' character which acts like a wildcard. Allowed forms are: *, Name, *Name, Name* and *Name* + + + + + Comma separated list of levels that this rule matches. + + + + + Minimum level that this rule matches. + + + + + Maximum level that this rule matches. + + + + + Level that this rule matches. + + + + + Comma separated list of target names. + + + + + Ignore further rules if this one matches. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the file to be included. The name is relative to the name of the current config file. + + + + + Ignore any errors in the include file. + + + + + + + Variable name. + + + + + Variable value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Limit on the number of requests in the lazy writer thread request queue. + + + + + Time in milliseconds to sleep between batches. + + + + + Number of log events that should be processed in a batch by the lazy writer thread. + + + + + Action to be taken when the lazy writer thread request queue count exceeds the set limit. + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + + + + + + + + + + + + + Name of the target. + + + + + Indicates whether to use sliding timeout. + + + + + Number of log events to be buffered. + + + + + Timeout (in milliseconds) after which the contents of buffer will be flushed if there's no write in the specified period of time. Use -1 to disable timed flushes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Indicates whether to append newline at the end of log message. + + + + + Instance of that is used to format log messages. + + + + + Action that should be taken if the message is larger than maxMessageSize. + + + + + Maximum message size in bytes. + + + + + Encoding to be used. + + + + + Size of the connection cache (number of connections which are kept alive). + + + + + Network address. + + + + + Indicates whether to keep connection open whenever possible. + + + + + Indicates whether to include source info (file name and line number) in the information sent over the network. + + + + + Indicates whether to include call site (class and method name) in the information sent over the network. + + + + + AppInfo field. By default it's the friendly name of the current AppDomain. + + + + + NDC item separator. + + + + + Indicates whether to include stack contents. + + + + + Indicates whether to include NLog-specific extensions to log4j schema. + + + + + Indicates whether to include dictionary contents. + + + + + + + + + + + + + + + + + + + + Layout that should be use to calcuate the value for the parameter. + + + + + Viewer parameter name. + + + + + + + + + + + + + + + + Name of the target. + + + + + Text to be rendered. + + + + + Footer. + + + + + Header. + + + + + Indicates whether to send the log messages to the standard error instead of the standard output. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Database user name. If the ConnectionString is not provided this value will be used to construct the "User ID=" part of the connection string. + + + + + Name of the database provider. + + + + + Indicates whether to use database transactions. Some data providers require this. + + + + + Name of the connection string (as specified in <connectionStrings> configuration section. + + + + + Connection string. When provided, it overrides the values specified in DBHost, DBUserName, DBPassword, DBDatabase. + + + + + Indicates whether to keep the database connection open between the log events. + + + + + Database name. If the ConnectionString is not provided this value will be used to construct the "Database=" part of the connection string. + + + + + Database password. If the ConnectionString is not provided this value will be used to construct the "Password=" part of the connection string. + + + + + Database host name. If the ConnectionString is not provided this value will be used to construct the "Server=" part of the connection string. + + + + + Connection string using for installation and uninstallation. If not provided, regular ConnectionString is being used. + + + + + Text of the SQL command to be run on each log level. + + + + + + + + + + + + + + + + + + + + + + + Type of the command. + + + + + Connection string to run the command against. If not provided, connection string from the target is used. + + + + + Indicates whether to ignore failures. + + + + + Command text. + + + + + + + + + + + + + + Layout that should be use to calcuate the value for the parameter. + + + + + Database parameter name. + + + + + Database parameter precision. + + + + + Database parameter scale. + + + + + Database parameter size. + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + + + + + + + + + + + Name of the target. + + + + + Indicates whether to return to the first target after any successful write. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Text to be rendered. + + + + + Header. + + + + + Footer. + + + + + File encoding. + + + + + Line ending mode. + + + + + Size in bytes above which log files will be automatically archived. + + + + + Maximum number of archive files that should be kept. + + + + + Name of the file to be used for an archive. + + + + + Way file archives are numbered. + + + + + Indicates whether to automatically archive log files every time the specified time passes. + + + + + Indicates whether to replace file contents on each write instead of appending log message at the end. + + + + + File attributes (Windows only). + + + + + Name of the file to write to. + + + + + Indicates whether to delete old log file on startup. + + + + + Indicates whether to enable log file(s) to be deleted. + + + + + Indicates whether to create directories if they don't exist. + + + + + Indicates whether concurrent writes to the log file by multiple processes on the same host. + + + + + Maximum number of seconds that files are kept open. If this number is negative the files are not automatically closed after a period of inactivity. + + + + + Number of files to be kept open. Setting this to a higher value may improve performance in a situation where a single File target is writing to many files (such as splitting by level or by logger). + + + + + Indicates whether concurrent writes to the log file by multiple processes on different network hosts. + + + + + Delay in milliseconds to wait before attempting to write to the file again. + + + + + Number of times the write is appended on the file before NLog discards the log message. + + + + + Log file buffer size in bytes. + + + + + Indicates whether to automatically flush the file buffers after each log message. + + + + + Indicates whether to keep log file open instead of opening and closing it on each logging event. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Condition expression. Log events who meet this condition will be forwarded to the wrapped target. + + + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + Message box title. + + + + + + + + + + + + + + + + + Name of the target. + + + + + Method name. The method must be public and static. + + + + + Class name. + + + + + + + + + + + + + + Layout that should be use to calcuate the value for the parameter. + + + + + Name of the parameter. + + + + + Type of the parameter. + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Action that should be taken if the message is larger than maxMessageSize. + + + + + Indicates whether to append newline at the end of log message. + + + + + Layout used to format log messages. + + + + + Maximum message size in bytes. + + + + + Encoding to be used. + + + + + Size of the connection cache (number of connections which are kept alive). + + + + + Indicates whether to keep connection open whenever possible. + + + + + Network address. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Indicates whether to append newline at the end of log message. + + + + + Instance of that is used to format log messages. + + + + + Action that should be taken if the message is larger than maxMessageSize. + + + + + Maximum message size in bytes. + + + + + Encoding to be used. + + + + + Size of the connection cache (number of connections which are kept alive). + + + + + Network address. + + + + + Indicates whether to keep connection open whenever possible. + + + + + Indicates whether to include source info (file name and line number) in the information sent over the network. + + + + + Indicates whether to include call site (class and method name) in the information sent over the network. + + + + + AppInfo field. By default it's the friendly name of the current AppDomain. + + + + + NDC item separator. + + + + + Indicates whether to include stack contents. + + + + + Indicates whether to include NLog-specific extensions to log4j schema. + + + + + Indicates whether to include dictionary contents. + + + + + + + + + + + + + + + + Name of the target. + + + + + Indicates whether to perform layout calculation. + + + + + Layout used to format log messages. + + + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + + + + + + + + + + + + Name of the target. + + + + + Default filter to be applied when no specific rule matches. + + + + + + + + + + + + + Condition to be tested. + + + + + Resulting filter to be applied when the condition matches. + + + + + + + + + + + + Name of the target. + + + + + + + + + + + + + + + Name of the target. + + + + + Number of times to repeat each log message. + + + + + + + + + + + + + + + + Name of the target. + + + + + Time to wait between retries in milliseconds. + + + + + Number of retries that should be attempted on the wrapped target in case of a failure. + + + + + + + + + + + + + + Name of the target. + + + + + + + + + + + + + + Name of the target. + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Web service URL. + + + + + Encoding. + + + + + Protocol to be used when calling web service. + + + + + Web service namespace. + + + + + Web service method name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Body layout (can be repeated multiple times). + + + + + Footer layout. + + + + + Header layout. + + + + + Quoting mode. + + + + + Quote Character. + + + + + Indicates whether CVS should include header. + + + + + Custom column delimiter value (valid when ColumnDelimiter is set to 'Custom'). + + + + + Column delimiter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Layout of the column. + + + + + Name of the column. + + + + + + + + + + + + Layout text. + + + + + + + + + + + + + + + + Body layout (can be repeated multiple times). + + + + + Header layout. + + + + + Footer layout. + + + + + + + + + + + + + + + + + + + + + + Condition expression. + + + + + Action to be taken when filter matches. + + + + + + + + + + + + + + + + + + + + + + + + + + Layout to be used to filter log messages. + + + + + Substring to be matched. + + + + + Action to be taken when filter matches. + + + + + Indicates whether to ignore case when comparing strings. + + + + + + + + + + + + + + + + + Indicates whether to ignore case when comparing strings. + + + + + Layout to be used to filter log messages. + + + + + Action to be taken when filter matches. + + + + + String to compare the layout to. + + + + + + + + + + + + + + + + + Layout to be used to filter log messages. + + + + + Substring to be matched. + + + + + Action to be taken when filter matches. + + + + + Indicates whether to ignore case when comparing strings. + + + + + + + + + + + + + + + + + Indicates whether to ignore case when comparing strings. + + + + + Layout to be used to filter log messages. + + + + + Action to be taken when filter matches. + + + + + String to compare the layout to. + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Indicates whether to use the XML format when serializing message. + + + + + Encoding to be used when writing text to the queue. + + + + + Layout used to format log messages. + + + + + Indicates whether to use recoverable messages (with guaranteed delivery). + + + + + Indicates whether to create the queue if it doesn't exists. + + + + + Label to associate with each message. + + + + + Name of the queue to write to. + + + + + + + + + + + + + + + + + Name of the target. + + + + + Maximum number of log events that the buffer can keep. + + + + + Indicates whether buffer should grow as needed. + + + + + Number of log events to be buffered. + + + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + + + + + + + + + + + + Name of the target. + + + + + Indicates whether to add <!-- --> comments around all written texts. + + + + + Layout used to format log messages. + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Text to be rendered. + + + + + Header. + + + + + Footer. + + + + + Indicates whether to use default row highlighting rules. + + + + + Indicates whether the error stream (stderr) should be used instead of the output stream (stdout). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Background color. + + + + + Condition that must be met in order to set the specified foreground and background color. + + + + + Foreground color. + + + + + + + + + + + + + + + Background color. + + + + + Foreground color. + + + + + Indicates whether to ignore case when comparing texts. + + + + + Regular expression to be matched. You must specify either text or regex. + + + + + Text to be matched. You must specify either text or regex. + + + + + Indicates whether to match whole words only. + + + + + + + + + + + + + + + Name of the target. + + + + + Footer. + + + + + Text to be rendered. + + + + + Header. + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + Name of the machine on which Event Log service is running. + + + + + Value to be used as the event Source. + + + + + Layout that renders event Category. + + + + + Layout that renders event ID. + + + + + Name of the Event Log to write to. This can be System, Application or any user-defined name. + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + Indicates whether log text should be appended to the text of the control instead of overwriting it. + + + + + Name of control to which NLog will log write log text. + + + + + Name of the Form on which the control is located. + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Username to change context to. + + + + + User account password. + + + + + Indicates whether to revert to the credentials of the process instead of impersonating another user. + + + + + Required impersonation level. + + + + + Windows domain name to change context to. + + + + + Logon Type. + + + + + Type of the logon provider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Header. + + + + + Footer. + + + + + Text to be rendered. + + + + + Indicates whether to send message as HTML instead of plain text. + + + + + Indicates whether to add new lines between log entries. + + + + + Encoding to be used for sending e-mail. + + + + + Mail subject. + + + + + Recipients' email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). + + + + + BCC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). + + + + + CC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). + + + + + Sender's email address (e.g. joe@domain.com). + + + + + Mail message body (repeated for each log message send in one mail). + + + + + Username used to connect to SMTP server (used when SmtpAuthentication is set to "basic"). + + + + + Indicates whether SSL (secure sockets layer) should be used when communicating with SMTP server. + + + + + Password used to authenticate against SMTP server (used when SmtpAuthentication is set to "basic"). + + + + + SMTP Authentication mode. + + + + + SMTP Server to be used for sending. + + + + + Port number that SMTP Server is listening on. + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Performance counter instance name. + + + + + Counter help text. + + + + + Performance counter type. + + + + + Indicates whether performance counter should be automatically created. + + + + + Name of the performance counter category. + + + + + Name of the performance counter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + Initial height of the form with rich text box. + + + + + Indicates whether scroll bar will be moved automatically to show most recent log entries. + + + + + Maximum number of lines the rich text box will store (or 0 to disable this feature). + + + + + Indicates whether the created form will be initially minimized. + + + + + Indicates whether the created window will be a tool window. + + + + + Name of RichTextBox to which Nlog will write. + + + + + Name of the Form on which the control is located. If there is no open form of a specified name than NLog will create a new one. + + + + + Initial width of the form with rich text box. + + + + + Indicates whether to use default coloring rules. + + + + + + + + + + + + + + + + + + + + + + + + + + + Background color. Names are identical with KnownColor enum extended with Empty value which means that background color won't be changed. + + + + + Font color. Names are identical with KnownColor enum extended with Empty value which means that font color won't be changed. + + + + + Indicates whether to ignore case when comparing texts. + + + + + Regular expression to be matched. You must specify either text or regex. + + + + + Font style of matched text. Possible values are the same as in FontStyle enum in System.Drawing. + + + + + Text to be matched. You must specify either text or regex. + + + + + Indicates whether to match whole words only. + + + + + + + + + + + + + Background color. + + + + + Condition that must be met in order to set the specified font color. + + + + + Font color. + + + + + Font style of matched text. + + + + + + + + + + + + + Name of the target. + + + + + Layout used to format log messages. + + + + + + + + + + + + + + + + + + + + Name of the target. + + + + + Name of the endpoint configuration in WCF configuration file. + + + + + Endpoint address. + + + + + Indicates whether to use binary message encoding. + + + + + Client ID. + + + + + Indicates whether to include per-event properties in the payload sent to the server. + + + + + + \ No newline at end of file diff --git a/NzbDrone/NzbDrone.Console.csproj b/NzbDrone/NzbDrone.Console.csproj index f389cc73f..a5730ad8f 100644 --- a/NzbDrone/NzbDrone.Console.csproj +++ b/NzbDrone/NzbDrone.Console.csproj @@ -113,6 +113,12 @@ + + Always + + + Designer + diff --git a/NzbDrone/packages.config b/NzbDrone/packages.config index 4f796cc1f..b257e3b6d 100644 --- a/NzbDrone/packages.config +++ b/NzbDrone/packages.config @@ -5,4 +5,6 @@ + + \ No newline at end of file