.NET의 로깅 공급자

  • 아티클

로그를 표준 출력으로만 표시하는 Console 공급자를 제외하고 로깅 공급자는 로그를 유지합니다. 예를 들어 Azure Application Insights 공급자는 Azure Application Insights에 로그를 저장합니다. 여러 공급자를 사용하도록 설정할 수 있습니다.

기본 .NET 작업자 앱 템플릿:

using Microsoft.Extensions.Hosting;

using IHost host = Host.CreateApplicationBuilder(args).Build();

// Application code should start here.

await host.RunAsync();

위의 코드는 .NET 작업자 앱 템플릿을 사용하여 만든 Program 클래스를 보여 줍니다. 다음 몇 개 섹션에서는 제네릭 호스트를 사용하는 .NET 작업자 앱 템플릿을 기반으로 하는 샘플을 제공합니다.

Host.CreateApplicationBuilder를 통해 추가된 로깅 공급자의 기본 세트를 재정의하려면 ClearProviders를 호출하고 원하는 로깅 공급자를 추가합니다. 예를 들어, 다음 코드는

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

builder.Logging.ClearProviders();
builder.Logging.AddConsole();

추가 공급자는 다음을 참조하세요.

ILogger에 종속되는 서비스 구성

ILogger<T>에 종속되는 서비스를 구성하려면 생성자 주입을 사용하거나 팩터리 메서드를 제공합니다. 팩터리 메서드 접근 방식은 다른 옵션이 없는 경우에만 권장됩니다. 예를 들어 DI에서 제공하는 ILogger<T> 인스턴스가 필요한 서비스를 살펴보겠습니다.

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

builder.Services.AddSingleton<IExampleService>(
    container => new DefaultExampleService
    {
        Logger = container.GetRequiredService<ILogger<IExampleService>>()
    });

이전 코드는 DI 컨테이너가 IExampleService의 인스턴스를 처음 생성해야 할 때 실행되는 Func<IServiceProvider, IExampleService>입니다. 이러한 방식으로 등록된 서비스에 액세스할 수 있습니다.

기본 제공 로깅 공급자

Microsoft 확장에는 런타임 라이브러리의 일부로 다음 로깅 공급자가 포함됩니다.

다음 로깅 공급자는 Microsoft에서 제공되지만 런타임 라이브러리의 일부로 제공되지 않습니다. 해당 공급자는 추가 NuGet 패키지로 설치해야 합니다.

콘솔

Console 공급자는 콘솔에 출력을 로그합니다.

디버그

Debug 공급자는 특히 Debug.WriteLine 메서드를 통해 특히 디버거가 연결된 경우에만 System.Diagnostics.Debug 클래스를 사용하여 로그 출력을 작성합니다. DebugLoggerProvider는 ILogger 인터페이스의 구현인 DebugLogger 인스턴스를 만듭니다.

이벤트 원본

EventSource 공급자는 이름이 Microsoft-Extensions-Logging인 플랫폼 간 이벤트 원본에 기록합니다. Windows에서 공급자는 ETW를 사용합니다.

dotnet 추적 도구

dotnet 추적 도구는 실행 중인 프로세스의 .NET Core 추적을 수집할 수 있도록 하는 플랫폼 간 CLI 전역 도구입니다. 이 도구는 LoggingEventSource를 사용하여 Microsoft.Extensions.Logging.EventSource 공급자 데이터를 수집합니다.

설치 지침은 dotnet-trace를 참조하세요. dotnet-trace를 사용하는 진단 자습서를 보려면 .NET Core에서 높은 CPU 사용량 디버그를 참조하세요.

Windows EventLog

EventLog 공급자는 로그 출력을 Windows 이벤트 로그에 보냅니다. 다른 공급자와 달리 EventLog 공급자는 기본 비공급자 설정을 상속하지 않습니다. EventLog 로그 설정을 지정하지 않으면 기본적으로 LogLevel.Warning으로 설정됩니다.

LogLevel.Warning 수준보다 낮은 이벤트를 기록하려면 로그 수준을 명시적으로 설정합니다. 다음 예제에서는 이벤트 로그 기본 로그 수준을 LogLevel.Information으로 설정합니다.

"Logging": {
  "EventLog": {
    "LogLevel": {
      "Default": "Information"
    }
  }
}

AddEventLog 오버로드는 EventLogSettings를 전달할 수 있습니다. null이거나 지정하지 않으면 다음 기본 설정이 사용됩니다.

  • LogName: "Application"
  • SourceName: “.NET Runtime”
  • MachineName: 로컬 컴퓨터 이름이 사용됩니다.

다음 코드에서는 SourceName을 기본값 ".NET Runtime"에서 CustomLogs로 변경합니다.

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

builder.Logging.AddEventLog(
    config => config.SourceName = "CustomLogs");

using IHost host = builder.Build();

host.Run();

Azure App Service

Microsoft.Extensions.Logging.AzureAppServices 공급자 패키지는 Azure App Service 앱의 파일 시스템과 Azure Storage 계정의 Blob 스토리지에 텍스트 파일을 기록합니다.

공급자 패키지는 런타임 라이브러리에 포함되지 않습니다. 이 공급자를 사용하려면 프로젝트에 공급자 패키지를 추가합니다.

공급자 설정을 구성하려면 다음 예제와 같이 AzureFileLoggerOptions 및 AzureBlobLoggerOptions를 사용합니다.

using Microsoft.Extensions.Logging.AzureAppServices;

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args)

builder.Logging.AddAzureWebAppDiagnostics();
builder.Services.Configure<AzureFileLoggerOptions>(options =>
{
    options.FileName = "azure-diagnostics-";
    options.FileSizeLimit = 50 * 1024;
    options.RetainedFileCountLimit = 5;
});
builder.Services.Configure<AzureBlobLoggerOptions>(options =>
{
    options.BlobName = "log.txt";
});

using IHost host = builder.Build();

// Application code should start here.

await host.RunAsync();

Azure App Service에 배포하는 경우 앱은 Azure Portal에서 App Service 페이지에 있는 App Service 로그 섹션의 설정을 사용합니다. 다음 설정이 업데이트되면 앱을 다시 시작하거나 재배포하지 않아도 변경 내용이 즉시 적용됩니다.

로그 파일의 기본 위치는 D:\home\LogFiles\Application 폴더에 있습니다. 추가 기본값은 공급자에 따라 다릅니다.

  • 애플리케이션 로깅(파일 시스템): 기본 파일 시스템 파일 이름은 diagnostics-yyyymmdd.txt입니다. 기본 파일 크기 제한은 10MB이고, 보존되는 기본 최대 파일 수는 2입니다.
  • 애플리케이션 로깅(Blob): 기본 Blob 이름은 {app-name}/yyyy/mm/dd/hh/{guid}_applicationLog.txt입니다.

이 공급자는 프로젝트가 Azure 환경에서 실행되는 경우에만 로그합니다.

Azure 로그 스트리밍

Azure 로그 스트리밍을 통해 다음의 로그 활동을 실시간으로 볼 수 있습니다.

  • 앱 서버
  • 웹 서버
  • 실패한 요청 추적

Azure 로그 스트리밍을 구성하려면:

  • 앱의 포털 페이지에서 App Service 로그 페이지로 이동합니다.
  • 애플리케이션 로깅(파일 시스템)을 On으로 설정합니다.
  • 로그 수준을 선택합니다. 이 설정은 Azure 로그 스트리밍에만 적용됩니다.

로그 스트림 페이지로 이동하여 로그를 봅니다. 로드되는 메시지는 ILogger 인터페이스를 사용하여 로그됩니다.

Azure Application Insights

Microsoft.Extensions.Logging.ApplicationInsights 공급자 패키지는 Azure Application Insights에 로그를 기록합니다. Application Insights는 웹앱을 모니터링하고 원격 분석 데이터를 쿼리 및 분석하기 위한 도구를 제공하는 서비스입니다. 이 공급자를 사용하는 경우 Application Insights 도구를 사용하여 로그를 쿼리 및 분석할 수 있습니다.

자세한 내용은 다음 리소스를 참조하세요.

로깅 공급자 디자인 고려 사항

ILoggerProvider 인터페이스의 고유한 구현과 ILogger의 해당 사용자 지정 구현을 개발하려는 경우 다음 사항을 고려하세요.

  • ILogger.Log 메서드는 동기적입니다.
  • 로그 상태 및 개체의 수명을 가정해서는 안 됩니다.

ILoggerProvider를 구현하면 ILoggerProvider.CreateLogger 메서드를 통해 ILogger가 생성됩니다. 구현에서 차단되지 않는 방식으로 로깅 메시지를 큐에 대기 시키려면 먼저 메시지를 구체화하거나 로그 항목을 구체화하는 데 사용되는 개체 상태를 직렬화해야 합니다. 이렇게 하면 삭제되는 개체에서 예외가 발생하지 않습니다.

자세한 내용은 .NET에서 사용자 지정 로깅 공급자 구현을 참조하세요.

타사 로깅 공급자

다음은 다양한 .NET 워크로드에서 작동하는 일부 타사 로깅 프레임워크입니다.

일부 타사 프레임워크는 구조적 로깅이라고 하는 의미 체계 로깅을 수행할 수 있습니다.

타사 프레임워크를 사용하는 방법은 다음과 같이 기본 공급자 중 하나를 사용하는 방법과 비슷합니다.

  1. 프로젝트에 NuGet 패키지를 추가합니다.
  2. 로깅 프레임워크에서 제공되는 ILoggerFactory 또는 ILoggingBuilder 확장 메서드를 호출합니다.

자세한 내용은 각 공급자의 설명서를 참조하세요. 타사 로깅 공급자는 Microsoft에서 지원되지 않습니다.

참고 항목