Skip to content

Commit 3198e00

Browse files
authored
Merge pull request #19 from jonathansant/patch-1
Expose `SerilogLoggerFactory`
2 parents dd90767 + 9cf699b commit 3198e00

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

src/Serilog.AspNetCore/AspNetCore/SerilogLoggerFactory.cs

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,49 @@
1818

1919
namespace Serilog.AspNetCore
2020
{
21-
class SerilogLoggerFactory : ILoggerFactory
21+
/// <summary>
22+
/// Implements <see cref="ILoggerFactory"/> so that we can inject Serilog Logger.
23+
/// </summary>
24+
public class SerilogLoggerFactory : ILoggerFactory
2225
{
23-
readonly SerilogLoggerProvider _provider;
26+
private readonly SerilogLoggerProvider _provider;
2427

25-
public SerilogLoggerFactory(Serilog.ILogger logger = null, bool dispose = false)
28+
/// <summary>
29+
/// Initializes a new instance of the <see cref="SerilogLoggerFactory"/> class.
30+
/// </summary>
31+
/// <param name="logger">The Serilog logger; if not supplied, the static <see cref="Serilog.Log"/> will be used.</param>
32+
/// <param name="dispose">When true, dispose <paramref name="logger"/> when the framework disposes the provider. If the
33+
/// logger is not specified but <paramref name="dispose"/> is true, the <see cref="Log.CloseAndFlush()"/> method will be
34+
/// called on the static <see cref="Log"/> class instead.</param>
35+
public SerilogLoggerFactory(ILogger logger = null, bool dispose = false)
2636
{
2737
_provider = new SerilogLoggerProvider(logger, dispose);
2838
}
2939

40+
/// <summary>
41+
/// Disposes the provider.
42+
/// </summary>
3043
public void Dispose()
3144
{
3245
_provider.Dispose();
3346
}
3447

48+
/// <summary>
49+
/// Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.
50+
/// </summary>
51+
/// <param name="categoryName">The category name for messages produced by the logger.</param>
52+
/// <returns>
53+
/// The <see cref="T:Microsoft.Extensions.Logging.ILogger" />.
54+
/// </returns>
3555
public Microsoft.Extensions.Logging.ILogger CreateLogger(string categoryName)
3656
{
3757
return _provider.CreateLogger(categoryName);
3858
}
3959

60+
/// <summary>
61+
/// Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to the logging system.
62+
/// </summary>
63+
/// <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" />.</param>
4064
public void AddProvider(ILoggerProvider provider)
4165
{
4266
SelfLog.WriteLine("Ignoring added logger provider {0}", provider);

0 commit comments

Comments
 (0)