Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

.NET Core/5+ - 에러 로깅을 위한 Middleware가 동작하지 않는 경우

실습을 해볼까요? ^^ .NET 6/기본 웹 애플리케이션 API 프로젝트를 만든 후, 코드에 예외를 발생하는 상황을 만들어둡니다.

// WeatherForecastController.cs
[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
    if (HttpContext.Request.Query.TryGetValue("test", out _) == true)
    {
        throw new ApplicationException("test is not null");
    }

    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = Summaries[Random.Shared.Next(Summaries.Length)]
    })
    .ToArray();
}

당연히 이 상황에서는 "http://localhost:5202/weatherforecast?test=1" 요청을 전송하면 예외가 발생할 것입니다. 자, 그럼 이 예외를 전역적으로 한 곳에서 처리하기 위해 Middleware를 하나 만들어보겠습니다.

public class ErrorLoggingMiddleware
{
    private readonly RequestDelegate _next;

    public ErrorLoggingMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception e)
        {
            System.Diagnostics.Debug.WriteLine($"The following error happened: {e.Message}");
        }
    }
}

그리고 이것을 .NET Core/5+ Pipeline에 등록해 주면,

// Program.cs

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);

    // Add services to the container.

    builder.Services.AddControllers();

    var app = builder.Build();

    // Configure the HTTP request pipeline.
    app.UseMiddleware<ErrorLoggingMiddleware>();

    app.UseAuthorization();


    app.MapControllers();

    app.Run();
}

이후 "http://localhost:5202/weatherforecast?test=1" 요청에 대해 ErrorLoggingMiddleware.Invoke 내에서 try/catch에 걸려 System.Diagnostics.Debug.WriteLine 코드가 동작하는 것을 확인할 수 있습니다.




그런데, ErrorLoggingMiddleware가 동작하지 않을 수도 있습니다. 왜냐하면 Web API를 처리하는 또 다른 Middleware가 등록돼 중간에서 예외를 가로챌 수 있기 때문입니다. 그리고 그러한 가장 대표적인 예가 ASP.NET Core에서 제공하는 "DeveloperExceptionPageMiddleware"입니다. 그래서 이것을 우리가 만든 Middleware 다음에 등록하면,

// ...[생략]..

// Configure the HTTP request pipeline.
app.UseMiddleware<ErrorLoggingMiddleware>();
app.UseDeveloperExceptionPage();

// ...[생략]..

Web API에서 발생한 예외를 DeveloperExceptionPageMiddleware에서 먼저 catch하게 되고 이전에 등록된 Middleware에서는 예외 처리가 안 되는 것입니다. 따라서 이런 경우 우리가 만든 ErrorLoggingMiddleware에서 예외를 받고 싶다면 UseDeveloperExceptionPage 호출을 제거해야 합니다.

이런 이유로 인해, 사실 예외 로깅을 위한 Middleware는 예외를 먹을 것이 아니라, 다시 throw하는 것이 더 바람직합니다.

public class ErrorLoggingMiddleware
{
    // ...[생략]...

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception e)
        {
            System.Diagnostics.Debug.WriteLine($"The following error happened: {e.Message}");
            throw;
        }
    }
}

저렇게 해주면, 우리가 만든 ErrorLoggingMiddleware는 UseDeveloperExceptionPage(또는, 예외 처리를 목적으로 하는 다른 Middleware)의 호출 위치에 상관없이 DeveloperExceptionPageMiddleware의 동작에는 영향을 주지 않습니다.




참고로, DeveloperExceptionPageMiddleware가 예외를 먹는 것이 잘못된 동작은 아닙니다. 왜냐하면 그 페이지는 예외 상황을 HTML로 구성해 내려주는 역할을 하기 때문에 거기서 다시 예외를 발생하게 되면 그러한 동작을 할 수 없게 됩니다.

더군다나, 이런 부분이 문제가 되지 않는 또 다른 이유는, 어차피 실 서비스에서는 DeveloperExceptionPageMiddleware를 사용하지 않기 때문에,

if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}
else
{
    app.UseExceptionHandler("/Home/Error");
}

위에서처럼 UseExceptionHandler로 등록되는 ExceptionHandlerMiddleware는 우리가 만든 Middleware처럼 throw를 다시 하도록 동작합니다.

그래서 UseExceptionHandler인 경우, Middleware 순서에 상관없이 잘 동작합니다.

// 이렇게 해도,
app.UseExceptionHandler("/Home/Error");
app.UseMiddleware();

// 또는 이렇게 해도, ErrorLoggingMiddleware의 try/catch에 예외가 잡힙니다.
app.UseMiddleware();
app.UseExceptionHandler("/Home/Error");

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]







[최초 등록일: ]
[최종 수정일: 9/29/2022]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




1  2  3  4  5  6  7  8  9  10  11  12  13  [14]  15  ...
NoWriterDateCnt.TitleFile(s)
13242정성태2/4/20233634디버깅 기술: 189. ASP.NET Web Application (.NET Framework) 프로젝트의 숨겨진 예외 - System.UnauthorizedAccessException
13241정성태2/3/20233240디버깅 기술: 188. ASP.NET Web Application (.NET Framework) 프로젝트의 숨겨진 예외 - System.IO.FileNotFoundException
13240정성태2/1/20233348디버깅 기술: 187. ASP.NET Web Application (.NET Framework) 프로젝트의 숨겨진 예외 - System.Web.HttpException
13239정성태2/1/20233010디버깅 기술: 186. C# - CacheDependency의 숨겨진 예외 - System.Web.HttpException
13238정성태1/31/20234840.NET Framework: 2092. IIS 웹 사이트를 TLS 1.2 또는 TLS 1.3 프로토콜로만 운영하는 방법
13237정성태1/30/20234461.NET Framework: 2091. C# - 웹 사이트가 어떤 버전의 TLS/SSL을 지원하는지 확인하는 방법
13236정성태1/29/20234233개발 환경 구성: 663. openssl을 이용해 인트라넷 IIS 사이트의 SSL 인증서 생성
13235정성태1/29/20233812개발 환경 구성: 662. openssl - 윈도우 환경의 명령행에서 SAN 적용하는 방법
13234정성태1/28/20234761개발 환경 구성: 661. dnSpy를 이용해 소스 코드가 없는 .NET 어셈블리의 코드를 변경하는 방법 [1]
13233정성태1/28/20236036오류 유형: 840. C# - WebClient로 https 호출 시 "The request was aborted: Could not create SSL/TLS secure channel" 예외 발생
13232정성태1/27/20234088스크립트: 43. uwsgi의 --processes와 --threads 옵션
13231정성태1/27/20233079오류 유형: 839. python - TypeError: '...' object is not callable
13230정성태1/26/20233390개발 환경 구성: 660. WSL 2 내부로부터 호스트 측의 네트워크로 UDP 데이터가 1개의 패킷으로만 제한되는 문제
13229정성태1/25/20234241.NET Framework: 2090. C# - UDP Datagram의 최대 크기
13228정성태1/24/20234396.NET Framework: 2089. C# - WMI 논리 디스크가 속한 물리 디스크의 정보를 얻는 방법 [2]파일 다운로드1
13227정성태1/23/20234091개발 환경 구성: 659. Windows - IP MTU 값을 바꿀 수 있을까요? [1]
13226정성태1/23/20233785.NET Framework: 2088. .NET 5부터 지원하는 GetRawSocketOption 사용 시 주의할 점
13225정성태1/21/20233158개발 환경 구성: 658. Windows에서 실행 중인 소켓 서버를 다른 PC 또는 WSL에서 접속할 수 없는 경우
13224정성태1/21/20233436Windows: 221. Windows - Private/Public/Domain이 아닌 네트워크 어댑터 단위로 방화벽을 on/off하는 방법
13223정성태1/20/20233660오류 유형: 838. RDP 연결 오류 - The two computers couldn't connect in the amount of time allotted
13222정성태1/20/20233365개발 환경 구성: 657. WSL - DockerDesktop.vhdx 파일 위치를 옮기는 방법
13221정성태1/19/20233545Linux: 57. C# - 리눅스 프로세스 메모리 정보파일 다운로드1
13220정성태1/19/20233700오류 유형: 837. NETSDK1045 The current .NET SDK does not support targeting .NET ...
13219정성태1/18/20233239Windows: 220. 네트워크의 인터넷 접속 가능 여부에 대한 판단 기준
13218정성태1/17/20233187VS.NET IDE: 178. Visual Studio 17.5 (Preview 2) - 포트 터널링을 이용한 웹 응용 프로그램의 외부 접근 허용
13217정성태1/13/20233740디버깅 기술: 185. windbg - 64비트 운영체제에서 작업 관리자로 뜬 32비트 프로세스의 덤프를 sos로 디버깅하는 방법
1  2  3  4  5  6  7  8  9  10  11  12  13  [14]  15  ...