Ruby 로깅 라이브러리 6개 비교: Logger, Lograge, Semantic Logger 외
Ruby 로깅 라이브러리 6개를 비교합니다. Rails 요청 로그 형식과 느린 쓰기에 대응하는 방법, 수집기에 전달되는 최종 출력을 확인합니다.
결제 요청이 503을 반환했다. Rails 요청 로그에는 응답 코드가, 애플리케이션 오류 로그에는 어느 업스트림 호출에서 시간이 초과됐는지가 남는다. 같은 탐색기에서 두 로그를 보더라도 각 필드의 역할은 다르다. Ruby 로깅 라이브러리를 고를 때는 누가 어떤 레코드를 남기고 수집기는 어떤 한 줄을 받는지부터 정리하는 편이 좋다.
출력 대상이 하나인 스크립트나 서비스는 Ruby의 Logger로 시작할 수 있다. Rails에서는 애플리케이션 로거 전체를 바꾸기 전에 요청 로그에 전용 포매터가 필요한지 살펴본다. 구조화 페이로드, 여러 출력 대상, 느린 쓰기에 대응하는 정책이 필요할 때 다른 구현을 검토한다.
Ruby 로깅 라이브러리 6개 비교
| 라이브러리 | 적합한 용도 | 확인할 점 |
|---|---|---|
| Ruby Logger | IO 하나나 파일 하나에 동기식으로 기록. 레벨과 포매터를 설정할 수 있다 | 기본 출력은 텍스트다. JSON 포매터와 파일 회전은 따로 설정한다 |
| Lograge | Rails 요청을 짧은 요약으로 정리 | 기본은 키-값 형식이다. JSON을 명시적으로 선택하고 최종 출력은 연결한 로거에서 확인한다 |
| Semantic Logger | 구조화 페이로드와 여러 appender, 기본 백그라운드 쓰기 | 큐와 느린 목적지의 처리 정책을 정한다. 5.2.0은 Ruby 3.2 이상이 필요하다 |
| Log4r | 계층형 로거와 이름이 있는 outputter를 쓰는 기존 코드 | 확인한 최신 RubyGems 버전은 2012년의 1.1.10이다. 실제 Ruby와 설정의 호환성을 확인한다 |
| Logging | 여러 appender와 레이아웃을 쓰는 기존 코드 | 이관 전에 JSON 레이아웃과 버퍼 동작을 확인한다. 확인한 최신 버전은 2024년의 2.4.0이다 |
| Ougai | 구조화 필드를 지원하는 Logger의 서브클래스. 기본은 Bunyan JSON |
레벨 값, 시간, 예외 형식은 포매터에 따라 다르다. 2.1.0은 Ruby 3.1 이상이 필요하다 |
Logger는 Ruby 표준 라이브러리에 포함되며 gem으로도 배포된다. 파일 쓰기는 동기화되며 크기나 주기에 따라 회전하도록 설정할 수 있다. JSON 포매터를 직접 작성하는 코드를 줄이고 싶다면 Ougai를 검토할 수 있다. 구조화 필드와 before_log 훅을 지원한다. Bunyan 포매터는 레벨을 숫자, 시간을 문자열로 쓰고, Pino 포매터는 시간을 Unix 밀리초로 쓰며 예외 구조도 다르다. 선택한 형식이 수집기의 파서와 맞는지 확인한다. Ougai 포매터(영어)
Rails 요청 요약을 어느 쪽에서 기록할지 정하기
Lograge는 구독한 Rails 이벤트를 한 줄로 정리한다. 컨트롤러 요약에는 메서드, 경로, 상태 코드, 처리 시간이 들어가고, 데이터가 있는 경우 DB와 뷰 처리 시간이 추가된다. 결제가 실패한 이유 같은 업무 이벤트는 애플리케이션이 별도로 남긴다. Lograge 0.15.1은 기본적으로 Lograge::Formatters::KeyValue를 사용하며 포맷한 메시지를 info 레벨로 로거에 넘긴다. JSON 메시지가 필요하면 Lograge::Formatters::Json을 지정하고 이를 받은 로거의 출력도 확인한다. Lograge 설정(영어)
rails_semantic_logger 같은 연동으로 이미 요청 로그를 남기고 있다면 Lograge를 활성화한 뒤 요청 하나가 어떻게 기록되는지 본다. 같은 요약이 두 줄 나오면 HTTP 실패 건수가 부풀 수 있다. 요청 요약과 애플리케이션 오류가 각각 한 줄 나오는 경우에는 두 레코드가 서로 다른 단서를 제공한다. HTTP 상태 코드와 로그 레벨은 별도 필드에 둔다. Semantic Logger의 Rails 연동(영어)
출력 대상이 느려졌을 때의 동작 고르기
Semantic Logger는 한 이벤트를 여러 appender에 보낼 수 있다. 큐에 여유가 있을 때 쓰기는 백그라운드 스레드가 처리한다. 5.2.0의 기본 메인 큐는 최대 10,000건을 담고, 가득 차면 기본 정책은 호출자를 대기시킨다. 용량 제한이 있는 큐에서 비차단 모드를 선택하면 가득 찼을 때 새 로그를 버린다. 파일과 원격 대상을 함께 쓰는 경우 느린 appender까지 포함해 큐 깊이와 드롭 수를 확인한다. Semantic Logger 운영 문서(영어)
정상 종료 시 라이브러리는 큐를 flush하려고 시도하며, SemanticLogger.flush를 직접 호출할 수도 있다. 남은 이벤트를 설정된 appender에 넘기는 단계다. 프로세스가 비정상 종료하면 메모리에 남은 로그가 사라질 수 있고, flush를 끝냈어도 원격 대상에 영구 저장됐는지는 따로 확인해야 한다. 감사용 레코드라면 저장 보장과 실패 처리를 별도로 설계한다. Log4r나 Logging을 바꿀 때는 기존 출력 대상과 형식부터 목록으로 정리한다.
수집기에 들어가는 최종 로그 한 줄 확인하기
로컬에서 Lograge 0.15.1 포매터에 테스트 요청을 직접 넘기고, Ruby 2.6.10에서 Logger 1.7.0의 출력도 확인했다.
| 출력 단계 | 관찰된 내용 |
|---|---|
| Lograge 키-값 포매터 | method=GET path=/checkout status=503 duration=42.50 |
| Lograge JSON 포매터 | JSON 객체의 숫자형 status: 503과 duration: 42.5 |
같은 JSON을 기본 Ruby Logger의 info에 전달 |
INFO가 있는 텍스트 접두부 뒤에 JSON 메시지가 붙는다 |
| Ruby Logger의 사용자 지정 JSON 포매터로 업무 오류 기록 | level: "ERROR", message: "upstream timeout", ISO 8601 형식의 time |
줄 전체를 JSON으로 읽는 파서는 텍스트 접두부가 있으면 파싱하지 못한다. 바깥 로거가 구조화 출력을 하더라도 안쪽 JSON을 메시지 문자열로 담을 수 있다. 이 로컬 테스트에서는 포매터와 로거의 출력 형태를 확인했다.
DataKit은 설정된 컨테이너 stdout이나 파일의 로그를 수집할 수 있다. Guance Pipeline에 실제 출력된 요청과 애플리케이션 로그를 넣어 이벤트 시간, 로그 레벨, 페이로드와 응답 코드 타입을 확인한다. 요청의 503은 http_status_code 같은 별도 필드에 두고, ERROR나 숫자형 레벨은 모니터가 사용하는 심각도 필드에 매핑한다. 테스트 소스에서 기존 요청 필터와 오류 필터가 어떻게 동작하는지도 확인한다. DataKit 로그 수집 · Guance Pipeline(영어)
