Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Better (and universal) logging (DNET-782).
- Loading branch information
1 parent
9d440ac
commit e9cdbaf
Showing
7 changed files
with
249 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
Provider/src/FirebirdSql.Data.FirebirdClient/Logging/ConsoleLoggingProvider.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * The contents of this file are subject to the Initial | ||
| * Developer's Public License Version 1.0 (the "License"); | ||
| * you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at | ||
| * https://github.com/FirebirdSQL/NETProvider/blob/master/license.txt. | ||
| * | ||
| * Software distributed under the License is distributed on | ||
| * an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either | ||
| * express or implied. See the License for the specific | ||
| * language governing rights and limitations under the License. | ||
| * | ||
| * All Rights Reserved. | ||
| */ | ||
|
|
||
| //$Authors = Jiri Cincura (jiri@cincura.net) | ||
|
|
||
| using System; | ||
| using System.Text; | ||
|
|
||
| namespace FirebirdSql.Data.Logging | ||
| { | ||
| public class ConsoleLoggerProvider : IFbLoggingProvider | ||
| { | ||
| readonly FbLogLevel _minimumLevel; | ||
|
|
||
| public ConsoleLoggerProvider(FbLogLevel minimumLevel = FbLogLevel.Info) | ||
| { | ||
| _minimumLevel = minimumLevel; | ||
| } | ||
|
|
||
| public IFbLogger CreateLogger(string name) => new ConsoleLogger(_minimumLevel); | ||
|
|
||
| sealed class ConsoleLogger : IFbLogger | ||
| { | ||
| readonly FbLogLevel _minimumLevel; | ||
|
|
||
| public ConsoleLogger(FbLogLevel minimumLevel) | ||
| { | ||
| _minimumLevel = minimumLevel; | ||
| } | ||
|
|
||
| public bool IsEnabled(FbLogLevel level) | ||
| { | ||
| return level >= _minimumLevel; | ||
| } | ||
|
|
||
| public void Log(FbLogLevel level, string msg, Exception exception = null) | ||
| { | ||
| if (!IsEnabled(level)) | ||
| return; | ||
|
|
||
| var sb = new StringBuilder(); | ||
| sb.Append("["); | ||
| sb.Append(level.ToString().ToUpper()); | ||
| sb.Append("]"); | ||
|
|
||
| sb.AppendLine(msg); | ||
|
|
||
| if (exception != null) | ||
| sb.AppendLine(exception.ToString()); | ||
|
|
||
| Console.Error.Write(sb.ToString()); | ||
| } | ||
| } | ||
| } | ||
| } |
29 changes: 29 additions & 0 deletions
29
Provider/src/FirebirdSql.Data.FirebirdClient/Logging/FbLogLevel.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * The contents of this file are subject to the Initial | ||
| * Developer's Public License Version 1.0 (the "License"); | ||
| * you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at | ||
| * https://github.com/FirebirdSQL/NETProvider/blob/master/license.txt. | ||
| * | ||
| * Software distributed under the License is distributed on | ||
| * an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either | ||
| * express or implied. See the License for the specific | ||
| * language governing rights and limitations under the License. | ||
| * | ||
| * All Rights Reserved. | ||
| */ | ||
|
|
||
| //$Authors = Jiri Cincura (jiri@cincura.net) | ||
|
|
||
| namespace FirebirdSql.Data.Logging | ||
| { | ||
| public enum FbLogLevel | ||
| { | ||
| Trace = 1, | ||
| Debug = 2, | ||
| Info = 3, | ||
| Warn = 4, | ||
| Error = 5, | ||
| Fatal = 6, | ||
| } | ||
| } |
52 changes: 52 additions & 0 deletions
52
Provider/src/FirebirdSql.Data.FirebirdClient/Logging/FbLogManager.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * The contents of this file are subject to the Initial | ||
| * Developer's Public License Version 1.0 (the "License"); | ||
| * you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at | ||
| * https://github.com/FirebirdSQL/NETProvider/blob/master/license.txt. | ||
| * | ||
| * Software distributed under the License is distributed on | ||
| * an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either | ||
| * express or implied. See the License for the specific | ||
| * language governing rights and limitations under the License. | ||
| * | ||
| * All Rights Reserved. | ||
| */ | ||
|
|
||
| //$Authors = Jiri Cincura (jiri@cincura.net) | ||
|
|
||
| using System; | ||
|
|
||
| namespace FirebirdSql.Data.Logging | ||
| { | ||
| public static class FbLogManager | ||
| { | ||
| public static IFbLoggingProvider Provider | ||
| { | ||
| get | ||
| { | ||
| _providerRetrieved = true; | ||
| return _provider; | ||
| } | ||
| set | ||
| { | ||
| if (_providerRetrieved) | ||
| throw new InvalidOperationException("The logging provider must be set before any action is taken"); | ||
|
|
||
| _provider = value ?? throw new ArgumentNullException(nameof(value)); | ||
| } | ||
| } | ||
|
|
||
| public static bool IsParameterLoggingEnabled { get; set; } | ||
|
|
||
| static IFbLoggingProvider _provider; | ||
| static bool _providerRetrieved; | ||
|
|
||
| static FbLogManager() | ||
| { | ||
| _provider = new NullLoggingProvider(); | ||
| } | ||
|
|
||
| internal static IFbLogger CreateLogger(string name) => Provider.CreateLogger("FirebirdClient." + name); | ||
| } | ||
| } |
44 changes: 44 additions & 0 deletions
44
Provider/src/FirebirdSql.Data.FirebirdClient/Logging/IFbLogger.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * The contents of this file are subject to the Initial | ||
| * Developer's Public License Version 1.0 (the "License"); | ||
| * you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at | ||
| * https://github.com/FirebirdSQL/NETProvider/blob/master/license.txt. | ||
| * | ||
| * Software distributed under the License is distributed on | ||
| * an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either | ||
| * express or implied. See the License for the specific | ||
| * language governing rights and limitations under the License. | ||
| * | ||
| * All Rights Reserved. | ||
| */ | ||
|
|
||
| //$Authors = Jiri Cincura (jiri@cincura.net) | ||
|
|
||
| using System; | ||
|
|
||
| namespace FirebirdSql.Data.Logging | ||
| { | ||
| public interface IFbLogger | ||
| { | ||
| bool IsEnabled(FbLogLevel level); | ||
| void Log(FbLogLevel level, string msg, Exception exception = null); | ||
| } | ||
|
|
||
| public static class IFbLoggerExtensions | ||
| { | ||
| public static void Trace(this IFbLogger logger, string msg) => logger.Log(FbLogLevel.Trace, msg); | ||
| public static void Debug(this IFbLogger logger, string msg) => logger.Log(FbLogLevel.Debug, msg); | ||
| public static void Info(this IFbLogger logger, string msg) => logger.Log(FbLogLevel.Info, msg); | ||
| public static void Warn(this IFbLogger logger, string msg) => logger.Log(FbLogLevel.Warn, msg); | ||
| public static void Error(this IFbLogger logger, string msg) => logger.Log(FbLogLevel.Error, msg); | ||
| public static void Fatal(this IFbLogger logger, string msg) => logger.Log(FbLogLevel.Fatal, msg); | ||
|
|
||
| public static void Trace(this IFbLogger logger, string msg, Exception ex) => logger.Log(FbLogLevel.Trace, msg, ex); | ||
| public static void Debug(this IFbLogger logger, string msg, Exception ex) => logger.Log(FbLogLevel.Debug, msg, ex); | ||
| public static void Info(this IFbLogger logger, string msg, Exception ex) => logger.Log(FbLogLevel.Info, msg, ex); | ||
| public static void Warn(this IFbLogger logger, string msg, Exception ex) => logger.Log(FbLogLevel.Warn, msg, ex); | ||
| public static void Error(this IFbLogger logger, string msg, Exception ex) => logger.Log(FbLogLevel.Error, msg, ex); | ||
| public static void Fatal(this IFbLogger logger, string msg, Exception ex) => logger.Log(FbLogLevel.Fatal, msg, ex); | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
Provider/src/FirebirdSql.Data.FirebirdClient/Logging/IFbLoggingProvider.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * The contents of this file are subject to the Initial | ||
| * Developer's Public License Version 1.0 (the "License"); | ||
| * you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at | ||
| * https://github.com/FirebirdSQL/NETProvider/blob/master/license.txt. | ||
| * | ||
| * Software distributed under the License is distributed on | ||
| * an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either | ||
| * express or implied. See the License for the specific | ||
| * language governing rights and limitations under the License. | ||
| * | ||
| * All Rights Reserved. | ||
| */ | ||
|
|
||
| //$Authors = Jiri Cincura (jiri@cincura.net) | ||
|
|
||
| namespace FirebirdSql.Data.Logging | ||
| { | ||
| public interface IFbLoggingProvider | ||
| { | ||
| IFbLogger CreateLogger(string name); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters