This repository was archived by the owner on Dec 13, 2018. It is now read-only.
File tree 5 files changed +50
-12
lines changed
src/Microsoft.Extensions.Logging.Abstractions
5 files changed +50
-12
lines changed Original file line number Diff line number Diff line change 6
6
namespace Microsoft . Extensions . Logging
7
7
{
8
8
/// <summary>
9
- /// A generic interface for logging.
9
+ /// Represents a type used to perform logging.
10
10
/// </summary>
11
11
public interface ILogger
12
12
{
Original file line number Diff line number Diff line change 6
6
namespace Microsoft . Extensions . Logging
7
7
{
8
8
/// <summary>
9
- /// Used to create logger instances of the given name.
9
+ /// Represents a type used to configure the logging system and create instances of <see cref="ILogger"/> from
10
+ /// the registered <see cref="ILoggerProvider"/>s.
10
11
/// </summary>
11
12
public interface ILoggerFactory : IDisposable
12
13
{
13
14
/// <summary>
14
- /// The minimum level of log messages sent to registered loggers.
15
+ /// The minimum level of log messages sent to loggers.
15
16
/// </summary>
16
17
LogLevel MinimumLevel { get ; set ; }
17
18
18
19
/// <summary>
19
- /// Creates a new ILogger instance of the given name .
20
+ /// Creates a new <see cref=" ILogger"/> instance.
20
21
/// </summary>
21
- /// <param name="categoryName"></param>
22
- /// <returns></returns>
22
+ /// <param name="categoryName">The category name for messages produced by the logger. </param>
23
+ /// <returns>The <see cref="ILogger"/>. </returns>
23
24
ILogger CreateLogger ( string categoryName ) ;
24
25
26
+ /// <summary>
27
+ /// Adds an <see cref="ILoggerProvider"/> to the logging system.
28
+ /// </summary>
29
+ /// <param name="provider">The <see cref="ILoggerProvider"/>.</param>
25
30
void AddProvider ( ILoggerProvider provider ) ;
26
31
}
27
32
}
Original file line number Diff line number Diff line change 6
6
namespace Microsoft . Extensions . Logging
7
7
{
8
8
/// <summary>
9
- /// A generic interface for logging where the category name is taken from the specified TCategoryName.
10
- /// For enabling activation of named ILogger from DI.
9
+ /// A generic interface for logging where the category name is derived from the specified
10
+ /// <paramref name="TCategoryName"/> type name.
11
+ /// Generally used to enable activation of a named <see cref="ILogger"/> from dependency injection.
11
12
/// </summary>
13
+ /// <typeparam name="TCategoryName">The type who's name is used for the logger category name.</typeparam>
12
14
public interface ILogger < out TCategoryName > : ILogger
13
15
{
14
16
Original file line number Diff line number Diff line change 6
6
namespace Microsoft . Extensions . Logging
7
7
{
8
8
/// <summary>
9
- /// Used to create logger instances of the given name .
9
+ /// Represents a type that can create instances of <see cref="ILogger"/> .
10
10
/// </summary>
11
11
public interface ILoggerProvider : IDisposable
12
12
{
13
13
/// <summary>
14
- /// Creates a new ILogger instance of the given name .
14
+ /// Creates a new <see cref=" ILogger"/> instance.
15
15
/// </summary>
16
- /// <param name="name"> </param>
16
+ /// <param name="categoryName">The category name for messages produced by the logger. </param>
17
17
/// <returns></returns>
18
- ILogger CreateLogger ( string name ) ;
18
+ ILogger CreateLogger ( string categoryName ) ;
19
19
}
20
20
}
Original file line number Diff line number Diff line change 3
3
4
4
namespace Microsoft . Extensions . Logging
5
5
{
6
+ /// <summary>
7
+ /// Defines logging severity levels.
8
+ /// </summary>
6
9
public enum LogLevel
7
10
{
11
+ /// <summary>
12
+ /// Logs that contain the most detailed messages. These messages may contain sensitive application data.
13
+ /// These messages are disabled by default and should never be enabled in a production environment.
14
+ /// </summary>
8
15
Debug = 1 ,
16
+
17
+ /// <summary>
18
+ /// Logs that are used for interactive investigation during development. These logs should primarily contain
19
+ /// information useful for debugging and have no long-term value.
20
+ /// </summary>
9
21
Verbose = 2 ,
22
+
23
+ /// <summary>
24
+ /// Logs that track the general flow of the application. These logs should have long-term value.
25
+ /// </summary>
10
26
Information = 3 ,
27
+
28
+ /// <summary>
29
+ /// Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
30
+ /// application execution to stop.
31
+ /// </summary>
11
32
Warning = 4 ,
33
+
34
+ /// <summary>
35
+ /// Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
36
+ /// failure in the current activity, not an application-wide failure.
37
+ /// </summary>
12
38
Error = 5 ,
39
+
40
+ /// <summary>
41
+ /// Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
42
+ /// immediate attention.
43
+ /// </summary>
13
44
Critical = 6 ,
14
45
}
15
46
}
You can’t perform that action at this time.
0 commit comments