더 나은 로깅을 위해 시도할 수 있는 9개의 Node.js 로거 라이브러리

코드 디버깅에 어려움을 겪고 계신가요? 디버깅 과정을 보다 간편하게 만들어 줄 로깅 솔루션을 찾고 계신가요? 그렇다면 계속 읽어보시고 자세히 알아보세요.

소프트웨어 개발은 요구사항 수집, 분석, 코딩, 테스트, 그리고 유지보수와 같은 여러 단계를 거칩니다. 이 모든 단계 중에서 코딩 또는 개발 단계는 상당한 시간과 노력이 요구됩니다. 소프트웨어 엔지니어는 구문 오류, 논리적 오류, 그리고 런타임 오류와 같은 다양한 유형의 오류를 처리합니다. 구문 오류는 코드가 프로그래밍 언어의 규칙을 따르지 않기 때문에 컴파일 시간에 즉시 발견됩니다.

반면에 논리적 오류와 런타임 오류는 IDE(통합 개발 환경)에서 감지하기 어려우며, 디버깅과 수정에 많은 어려움이 따르는 경우가 많습니다. 버그를 수정하는 것은 시간 소모적인 작업이며, 상당한 디버깅 노력을 필요로 합니다.

디버깅은 작성한 코드가 예상대로 작동하지 않는 원인을 파악하는 과정입니다. 오류가 발생한 코드의 정확한 위치와 문제점을 알면, 문제를 쉽게 해결할 수 있습니다. 따라서 로깅은 코드 디버깅에 매우 효과적인 도구입니다.

로깅이란 무엇일까요?

로깅은 프로그램이 실행되는 동안 메시지를 수집하는 기술입니다. 디버깅에 유용한 정보만을 기록해야 합니다. 그러므로 코드에 로그 문을 추가해야 할 시점을 정확히 파악하는 것이 중요합니다. 로그 문들을 구분하는 것 또한 매우 중요합니다. 정보, 경고, 오류, 디버그, 그리고 상세 정보 등 로깅에는 다양한 수준이 존재하며, 오류 및 경고 메시지는 예외 처리에 활용됩니다.

함수에서 반환되는 데이터, 배열 조작의 결과, API에서 가져온 데이터 등은 정보 메시지를 사용하여 기록할 수 있는 예시입니다. 디버그 및 상세 로그는 오류에 대한 자세한 설명을 제공하는 데 사용됩니다.

디버그 로그는 스택 추적, 입출력 매개변수와 같은 정보를 제공합니다. “상세 정보” 로그는 “디버그” 로그만큼 자세하지는 않지만, 발생한 모든 이벤트의 목록을 제공합니다. 로그는 콘솔, 파일, 그리고 출력 스트림에 기록됩니다. 로그 관리 도구는 체계화되고 형식이 갖춰진 로깅에 유용하게 사용될 수 있습니다.

Node.js 로깅

Node.js는 자바스크립트 런타임 환경입니다. Node.js 애플리케이션은 비동기식 및 논블로킹 방식으로 작동하며, 데이터 집약적인 실시간 시스템에서 주로 사용됩니다. Node.js에 대해 더 자세히 알아보려면 Node.js 튜토리얼과 문서를 참고하는 것이 좋습니다. 성능 향상, 문제 해결, 그리고 오류 추적을 위해 로깅은 필수적입니다. Node.js에서의 로깅은 내장 기능인 `console.log`를 사용하여 수행할 수 있습니다. 또한, 디버그 기능은 다양한 패키지와 연동하여 더욱 효율적으로 사용할 수 있습니다.

미들웨어는 요청과 응답을 관리하는 데 사용됩니다. 미들웨어는 애플리케이션이나 다른 자바스크립트 프레임워크일 수 있습니다. 미들웨어 로깅은 애플리케이션과 라우터를 통해 수행될 수 있습니다. 모든 Node.js 로거는 `npm` 또는 `yarn install` 명령을 사용하여 설치해야 합니다.

`npm`은 “Node Package Manager”의 약자이고, `YARN`은 “Yet Another Resource Negotiator”의 약자입니다. 하지만, `Yarn`은 패키지를 병렬로 설치하여 더 빠른 속도를 제공하므로, 일반적으로 `npm`보다 선호됩니다.

다음은 대표적인 Node.js 로거들입니다.

피노

Pino는 Node.js 애플리케이션을 위한 가장 뛰어난 로거 라이브러리 중 하나입니다. 오픈 소스이며, 매우 빠른 속도를 자랑하며, 읽기 쉬운 JSON 형식으로 메시지를 기록합니다. Pino 로그 수준에는 디버그, 경고, 오류, 그리고 정보 메시지 등이 있습니다. Pino 로거 인스턴스를 프로젝트에 가져와서 `console.log` 구문을 `logger.info` 구문으로 대체하여 사용할 수 있습니다.

다음 명령어를 사용하여 Pino를 설치할 수 있습니다.

$ npm install pino

생성된 로그는 JSON 형식으로 정교하며, 로그의 줄 번호, 로그 유형, 그리고 기록 시간 등을 강조 표시합니다. Pino는 애플리케이션에 미치는 로깅 오버헤드를 최소화하며, 로그를 처리하는 과정에서 뛰어난 유연성을 제공합니다.

Pino는 Hapi, Restify, Express와 같은 웹 프레임워크와 통합될 수 있습니다. Pino에서 생성된 로그는 파일에도 저장할 수 있습니다. 워커 스레드를 활용하여 작업을 처리하고, TypeScript와도 호환됩니다.

윈스턴

Winston은 유연성과 확장성에 중점을 두고 있으며, 다양한 웹 프레임워크에서 로깅을 지원합니다. 여러 유형의 전송을 지원하여 로그를 다양한 파일 위치에 저장할 수 있습니다. 여기서 전송이란 로그 메시지가 저장되는 위치를 의미합니다.

Http, 콘솔, 파일, 그리고 스트림과 같은 기본 전송 외에도, Cloudwatch, MongoDB와 같은 다른 전송도 지원합니다. 다양한 수준과 형식으로 로깅을 수행할 수 있습니다. 로깅 수준은 문제의 심각도를 나타냅니다.

다양한 로깅 수준은 다음과 같습니다.

{
  error: 0,
  warn: 1,
  info: 2,
  http: 3,
  verbose: 4,
  debug: 5,
  silly: 6
}

로그 출력 형식은 사용자 정의, 필터링, 그리고 결합도 가능합니다. 로그에는 타임스탬프, 로그와 연결된 레이블, 이전 로그로부터 경과된 밀리초 등에 대한 정보가 포함됩니다.

Winston은 예외와 잡히지 않은 프로미스도 처리합니다. 또한 쿼리 런타임 파일링, 스트리밍 로그와 같은 추가 기능을 제공합니다. Winston을 사용하려면 먼저 설치해야 합니다. 그 다음, 전송과 함께 Winston 구성 객체를 생성하여 로그를 저장합니다. 로거 객체는 `createLogger()` 함수를 사용하여 생성되고, 로그 메시지가 전달됩니다.

노드 번연

Bunyan은 JSON 형식으로 로그를 빠르게 기록하기 위해 node.js에서 사용됩니다. 또한 로그를 보기 위한 CLI(명령줄 인터페이스) 도구도 제공합니다. Bunyan은 가볍고, Node.js, Browserify, WebPack, NW.js와 같은 다양한 런타임 환경을 지원합니다. 예쁜 인쇄 기능을 사용하여 로그의 JSON 형식을 더욱 보기 좋게 만들어줍니다. 로그에는 치명적, 오류, 경고, 정보, 디버그, 그리고 추적과 같은 다양한 수준이 있으며, 각각 숫자 값과 연결되어 있습니다.

인스턴스에 대해 설정된 수준 이상의 모든 수준의 메시지가 기록됩니다. Bunyan 스트림은 출력이 기록되는 장소입니다. 애플리케이션의 하위 구성 요소는 `log.child()` 함수를 사용하여 로깅할 수 있습니다. 모든 하위 로거는 특정 상위 애플리케이션에 바인딩됩니다. 스트림 유형은 파일, 회전 파일, 원시 데이터 등이 될 수 있습니다. 스트림을 정의하기 위한 코드 예시는 다음과 같습니다.

var bunyan = require('bunyan');
var log = bunyan.createLogger({
    name: "foo",
    streams: [
        {
            stream: process.stderr,
            level: "debug"
        },
        ...
    ]
});

Bunyan은 DTrace 로깅도 지원합니다. DTrace 로깅과 관련된 프로브에는 `log-trace`, `log-warn`, `log-error`, `log-info`, `log-debug`, 그리고 `log-fatal`이 있습니다. Bunyan은 직렬 변환기를 사용하여 JSON 형식의 로그를 생성합니다. 직렬 변환기 함수는 예외를 발생시키지 않으며 방어적으로 작동합니다.

로그 수준

Loglevel은 Javascript 애플리케이션에서 로깅을 수행하는 데 사용됩니다. 또한 가볍고 단순하기 때문에 Node.js의 인기 있는 로거 중 하나입니다. 주어진 레벨을 기록하며, 로깅에 종속성이 없는 단일 파일을 사용합니다. 기본 로그 수준은 “경고”입니다. 로그 출력은 줄 번호와 함께 형식이 잘 갖춰져 있습니다. 로깅에 사용되는 메서드에는 추적, 디버그, 경고, 오류, 그리고 정보 등이 있습니다.

모든 환경에서 실패에 대한 복원력이 있습니다. `getLogger()`는 로거 객체를 검색하는 데 사용되는 메서드입니다. 기능을 확장하기 위해 다른 플러그인과 결합하여 사용할 수도 있습니다. 플러그인에는 `loglevel-plugin-prefix`, `loglevel-plugin-remote`, `ServerSend`, 그리고 `DEBUG` 등이 있습니다. 로깅에 접두사 메시지를 추가하는 플러그인은 다음과 같습니다.

var originalFactory = log.methodFactory;
log.methodFactory = function (methodName, logLevel, loggerName) {
    var rawMethod = originalFactory(methodName, logLevel, loggerName);

    return function (message) {
        rawMethod("Newsflash: " + message);
    };
};
log.setLevel(log.getLevel()); // Be sure to call setLevel method in order to apply plugin

빌드는 `npm run dist` 명령을 사용하여 실행할 수 있으며, 테스트는 `npm test` 명령을 사용하여 실행할 수 있습니다. 로그 수준은 Webjar, Bower, 그리고 Atmosphere 패키지를 지원합니다. 새로운 기능이 추가될 때마다 새로운 버전의 Loglevel이 출시됩니다.

시그널

Signale은 Javascript 애플리케이션을 위한 19개의 로거로 구성되어 있습니다. TypeScript와 범위 로깅을 지원하며, 타임스탬프, 데이터, 그리고 파일 이름을 기록하는 데 도움이 되는 타이머를 포함하고 있습니다. `await`, `complete`, `fatal`, `fav`, `info` 등 19개의 로거 외에도, 사용자 정의 로그를 생성할 수 있습니다.

사용자 정의 로그는 로거 데이터로 JSON 객체와 필드를 정의하여 생성됩니다. 대화형 로거 또한 생성할 수 있습니다. 대화형 로거를 true로 설정하면, 대화형 로거의 새로운 값이 이전 값을 덮어씁니다.

Signale의 가장 큰 장점은 비밀스럽거나 민감한 정보를 필터링하는 기능입니다. 여러 비밀이 배열에 저장됩니다. `addSecrets()`와 `clearSecrets()` 함수는 배열에서 비밀을 추가하고 삭제하는 데 사용됩니다. Boostnote, Docz, Shower, Taskbook, 그리고 Vant는 로깅에 Signale을 사용합니다. Signale에서 API를 호출하는 구문은 다음과 같습니다.

signale.<logger>(message[,message]|messageObj|errorObj)

이 글을 쓰는 현재 시점에서 Signale의 다운로드 수는 100만 회를 넘어섰습니다.

트레이서

Tracer는 자세한 로깅 메시지를 생성하는 데 사용됩니다. 로깅 메시지는 타임스탬프, 파일 이름, 줄 번호, 그리고 메서드 이름으로 구성됩니다. 헬퍼 패키지를 설치하여 출력 로깅 형식을 사용자 정의할 수 있습니다. 헬퍼 패키지는 다음 명령어를 사용하여 설치할 수 있습니다.

 npm install -dev tracer

Tracer는 파일, 스트림, 그리고 MongoDB 전송을 지원합니다. 또한 로깅에서 색상 콘솔 및 필터 조건을 지원합니다. 먼저 `npm install`을 사용하여 Tracer를 설치해야 합니다. 두 번째로, 로거 객체를 생성하고 콘솔 유형을 선택해야 합니다. 그 다음, 추가 로깅을 위해 객체에 다양한 로그 수준 또는 유형을 지정할 수 있습니다.

함수 본문에 있는 비즈니스 로직을 사용하여 동기 함수를 정의하여 사용자 정의 필터를 생성할 수 있습니다. `tinytim`과 같은 마이크로 템플릿도 시스템 로깅에 사용할 수 있습니다.

캐빈.js

Cabin은 node.js 애플리케이션의 서버 및 클라이언트 측 로깅에 사용됩니다. 민감하고 중요한 정보의 마스킹이 필요한 경우에 주로 사용됩니다. 여기에는 신용 카드 번호, BasicAuth 헤더, 솔트, 비밀번호, CSRF 토큰, 그리고 은행 계좌 번호가 포함됩니다. 다음 코드 스니펫은 Cabin.js를 사용한 로깅 방법을 보여줍니다.

const Cabin = require('cabin');
const cabin = new Cabin();
cabin.info('hello world');
cabin.error(new Error('oops!'));

1600개 이상의 필드 이름으로 구성되어 있습니다. 또한 BYOL(Bring Your Own Logger) 원칙을 따릅니다. 따라서 Axe, Pino, Bunyan, Winston과 같은 다른 로거와도 호환됩니다. 자동 스트림 및 Cabin 버퍼 덕분에 디스크 저장 비용이 절감됩니다. 또한 플랫폼 간 호환이 가능하고, 디버깅이 용이합니다.

서버 측 로깅은 라우팅 및 자동 출력 로깅을 위해 미들웨어를 사용해야 합니다. 브라우저 측 로깅에는 XHR 요청과 스크립트가 필요합니다. 데이터, 스택 추적, 그리고 기타 오류 정보와 같은 메타 데이터를 표시하는 Axe를 사용합니다. `SHOW_STACK`과 `SHOW_META`는 스택 추적과 메타데이터를 표시하거나 숨기기 위해 true 또는 false로 설정하는 부울 변수입니다.

Npmlog

Npmlog는 npm에서 사용하는 기본 로거 유형입니다. 사용되는 로깅 메서드 중 일부는 `level`, `record`, `maxRecordSize`, `prefixStyle`, `제목`, 그리고 `stream`입니다. 컬러 로깅도 지원합니다. 다양한 로깅 수준으로는 어리석음, 장황함, 정보, 경고, http, 그리고 오류 등이 있습니다. npm 로그를 사용하는 샘플 코드 스니펫은 다음과 같습니다.

var log = require('npmlog')

// additional stuff ---------------------------+
// message ----------+                         |
// prefix ----+      |                         |
// level -+   |      |                         |
//        v   v      v                         v
    log.info('fyi', 'I have a kitty cat: %j', myKittyCat)

로그 수준으로 “무한대”가 지정된 경우, 모든 메시지가 표시되지 않습니다. 로그 수준으로 “-Infinity”가 지정된 경우에는, 로그를 보려면 로그 메시지를 표시하는 옵션을 활성화해야 합니다.

이벤트 및 메시지 객체는 로깅에 사용됩니다. 접두사 이벤트가 사용되면 접두사 메시지가 방출됩니다. 스타일 객체는 텍스트 및 배경에 색상을 추가하거나, 굵게, 기울임꼴, 밑줄과 같은 글꼴 스타일을 추가하는 등 로그 형식을 지정하는 데 사용됩니다. 일부 npm 로그 패키지에는 `brolog`, `npmlogger`, `npmdate log` 등이 있습니다.

포효

Roarr는 초기화가 필요 없고 구조화된 데이터를 생성하는 Node.js용 로거입니다. CLI와 환경 변수를 제공합니다. 브라우저와 호환되며, Fastify, Fastify, Elastic Search 등과 통합할 수 있습니다. 애플리케이션 코드와 종속성 코드를 구분할 수 있습니다. 모든 로그 메시지는 컨텍스트, 메시지, 시퀀스, 시간, 그리고 버전으로 구성되어 있습니다. 다양한 로그 수준에는 추적, 디버그, 정보, 경고, 오류, 그리고 치명적이 포함됩니다. Roarr를 사용하는 로그 방법의 샘플 코드는 다음과 같습니다.

import {
  ROARR,
} from 'roarr';

ROARR.write = (message) => {
  console.log(JSON.parse(message));
};

또한 오류 직렬화를 수행할 수 있습니다. 즉, 오류가 있는 인스턴스가 객체의 컨텍스트와 함께 기록될 수 있습니다. Node.js 및 Roarr에 특정한 환경 변수 중 일부는 `ROARR_LOG`와 `ROARR_STREAM`입니다. “adopt”는 node.js와 함께 사용하여 컨텍스트 속성을 다양한 수준으로 전달하는 기능입니다. 하위 기능은 로깅하는 동안 미들웨어와 함께 사용할 수도 있습니다.

마지막으로

로깅은 프로그램을 실행하는 동안 다양한 활동과 이벤트를 추적하는 방법입니다. 로깅은 코드 디버깅에서 핵심적인 역할을 담당하며, 코드 가독성을 향상시키는 데에도 도움이 됩니다. Node.js는 오픈 소스 자바스크립트 런타임 환경입니다. 주요 Node.js 로거에는 Pino, Winston, Bunyan, Signale, Tracer, Npmlog 등이 있습니다. 각 로거는 프로파일링, 필터링, 스트리밍, 그리고 전송과 같은 고유한 기능을 제공합니다.

일부 로거는 색상 콘솔을 지원하고, 다른 로거는 민감한 정보 처리에 적합합니다. 자세하고 형식이 갖춰진 로그는 개발자가 코드의 버그를 수정하는 데 큰 도움이 됩니다. JSON 형식은 키-값 쌍 형태로 데이터를 기록하여 사용자 친화적이므로 로깅에 선호됩니다.

로거는 다른 애플리케이션과 통합할 수 있으며, 여러 브라우저와 호환됩니다. 사용하려는 로거 유형을 선택하기 전에, 개발하려는 애플리케이션의 요구 사항과 특징을 항상 고려하는 것이 좋습니다.

Windows 및 macOS에 Node.js와 NPM을 설치하는 방법도 참고하시면 도움이 될 것입니다.