|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.ComponentModel;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Logging.EventLog;
namespace Microsoft.Extensions.Logging
{
/// <summary>
/// Extension methods for the <see cref="ILoggerFactory"/> class.
/// </summary>
public static class EventLoggerFactoryExtensions
{
/// <summary>
/// Adds an event logger. Use <paramref name="settings"/> to enable logging for specific log levels.
/// </summary>
/// <param name="factory">The extension method argument.</param>
/// <param name="settings">The <see cref="EventLogSettings"/>.</param>
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("This method is retained only for compatibility. The recommended alternative is AddEventLog(this ILoggingBuilder builder).", error: true)]
public static ILoggerFactory AddEventLog(this ILoggerFactory factory, EventLog.EventLogSettings settings)
{
ThrowHelper.ThrowIfNull(factory);
ThrowHelper.ThrowIfNull(settings);
factory.AddProvider(new EventLogLoggerProvider(settings));
return factory;
}
/// <summary>
/// Adds an event logger that is enabled for <see cref="LogLevel"/>s of minLevel or higher.
/// </summary>
/// <param name="factory">The extension method argument.</param>
/// <param name="minLevel">The minimum <see cref="LogLevel"/> to be logged.</param>
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("This method is retained only for compatibility. The recommended alternative is AddEventLog(this ILoggingBuilder builder).", error: true)]
public static ILoggerFactory AddEventLog(this ILoggerFactory factory, LogLevel minLevel) =>
AddEventLog(factory, new EventLogSettings() { Filter = (_, logLevel) => logLevel >= minLevel });
/// <summary>
/// Adds an event logger that is enabled for <see cref="LogLevel"/>.Information or higher.
/// </summary>
/// <param name="factory">The extension method argument.</param>
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("This method is retained only for compatibility. The recommended alternative is AddEventLog(this ILoggingBuilder builder).", error: true)]
public static ILoggerFactory AddEventLog(this ILoggerFactory factory) => AddEventLog(factory, LogLevel.Information);
/// <summary>
/// Adds an event logger named 'EventLog' to the factory.
/// </summary>
/// <param name="builder">The extension method argument.</param>
/// <returns>The <see cref="ILoggingBuilder"/> so that additional calls can be chained.</returns>
public static ILoggingBuilder AddEventLog(this ILoggingBuilder builder)
{
ThrowHelper.ThrowIfNull(builder);
builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, EventLogLoggerProvider>());
return builder;
}
/// <summary>
/// Adds an event logger. Use <paramref name="settings"/> to enable logging for specific log levels.
/// </summary>
/// <param name="builder">The extension method argument.</param>
/// <param name="settings">The <see cref="EventLogSettings"/>.</param>
/// <returns>The <see cref="ILoggingBuilder"/> so that additional calls can be chained.</returns>
public static ILoggingBuilder AddEventLog(this ILoggingBuilder builder, EventLogSettings settings)
{
ThrowHelper.ThrowIfNull(builder);
ThrowHelper.ThrowIfNull(settings);
builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider>(new EventLogLoggerProvider(settings)));
return builder;
}
/// <summary>
/// Adds an event logger. Use <paramref name="configure"/> to enable logging for specific log levels.
/// </summary>
/// <param name="builder">The extension method argument.</param>
/// <param name="configure">A delegate to configure the <see cref="EventLogSettings"/>.</param>
/// <returns>The <see cref="ILoggingBuilder"/> so that additional calls can be chained.</returns>
public static ILoggingBuilder AddEventLog(this ILoggingBuilder builder, Action<EventLogSettings> configure)
{
ThrowHelper.ThrowIfNull(configure);
builder.AddEventLog();
builder.Services.Configure(configure);
return builder;
}
}
}
|