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

비밀번호

댓글 작성자
 




... 46  47  48  49  50  51  52  53  54  55  56  57  58  59  [60]  ...
NoWriterDateCnt.TitleFile(s)
12531정성태2/5/202120378개발 환경 구성: 537. Wireshark + C#으로 확인하는 PSH flag와 Nagle 알고리듬파일 다운로드1
12530정성태2/4/202123030개발 환경 구성: 536. Wireshark + C#으로 확인하는 TCP 통신의 Receive Window
12529정성태2/4/202122352개발 환경 구성: 535. Wireshark + C#으로 확인하는 TCP 통신의 MIN RTO [1]
12528정성태2/1/202122846개발 환경 구성: 534. Wireshark + C#으로 확인하는 TCP 통신의 MSS(Maximum Segment Size) - 윈도우 환경
12527정성태2/1/202122774개발 환경 구성: 533. Wireshark + C#으로 확인하는 TCP 통신의 MSS(Maximum Segment Size) - 리눅스 환경파일 다운로드1
12526정성태2/1/202119391개발 환경 구성: 532. Azure Devops의 파이프라인 빌드 시 snk 파일 다루는 방법 - Secure file
12525정성태2/1/202117884개발 환경 구성: 531. Azure Devops - 파이프라인 실행 시 빌드 이벤트를 생략하는 방법
12524정성태1/31/202117656개발 환경 구성: 530. 기존 github 프로젝트를 Azure Devops의 빌드 Pipeline에 연결하는 방법 [1]
12523정성태1/31/202120689개발 환경 구성: 529. 기존 github 프로젝트를 Azure Devops의 Board에 연결하는 방법
12522정성태1/31/202122974개발 환경 구성: 528. 오라클 클라우드의 리눅스 VM - 9000 MTU Jumbo Frame 테스트
12521정성태1/31/202120191개발 환경 구성: 527. 이더넷(Ethernet) 환경의 TCP 통신에서 MSS(Maximum Segment Size) 확인 [1]
12520정성태1/30/202119477개발 환경 구성: 526. 오라클 클라우드의 VM에 ping ICMP 여는 방법
12519정성태1/30/202119060개발 환경 구성: 525. 오라클 클라우드의 VM을 외부에서 접근하기 위해 포트 여는 방법
12518정성태1/30/202137536Linux: 37. Ubuntu에 Wireshark 설치 [2]
12517정성태1/30/202124146Linux: 36. 윈도우 클라이언트에서 X2Go를 이용한 원격 리눅스의 GUI 접속 - 우분투 20.04
12516정성태1/29/202120710Windows: 188. Windows - TCP default template 설정 방법
12515정성태1/28/202123191웹: 41. Microsoft Edge - localhost에 대해 http 접근 시 무조건 https로 바뀌는 문제 [3]
12514정성태1/28/202123496.NET Framework: 1021. C# - 일렉트론 닷넷(Electron.NET) 소개 [1]파일 다운로드1
12513정성태1/28/202118723오류 유형: 698. electronize - User Profile 디렉터리에 공백 문자가 있는 경우 빌드가 실패하는 문제 [1]
12512정성태1/28/202121412오류 유형: 697. The program can't start because VCRUNTIME140.dll is missing from your computer. Try reinstalling the program to fix this problem.
12511정성태1/27/202120761Windows: 187. Windows - 도스 시절의 8.3 경로를 알아내는 방법
12510정성태1/27/202121585.NET Framework: 1020. .NET Core Kestrel 호스팅 - Razor 지원 추가 [1]파일 다운로드1
12509정성태1/27/202119623개발 환경 구성: 524. Jupyter Notebook에서 C#(F#, PowerShell) 언어 사용을 위한 환경 구성 [3]
12508정성태1/27/202120773개발 환경 구성: 523. Jupyter Notebook - Slide 플레이 버튼이 없는 경우
12507정성태1/26/202121182VS.NET IDE: 157. Visual Studio - Syntax Visualizer 메뉴가 없는 경우
12506정성태1/25/202123917.NET Framework: 1019. Microsoft.Tye 기본 사용법 소개 [1]
... 46  47  48  49  50  51  52  53  54  55  56  57  58  59  [60]  ...