JavaScript 및 TypeScript를 위한 종속성 없는 구조적 로깅 라이브러리인 LogTape이 v0.6.0을 출시했습니다. 무엇이 바뀌었나요?

상위 로거의 싱크 재정의

LogTape의 기능 중 하나는 계층적 범주를 통한 싱크의 상속입니다. 예를 들어 다음과 같이 두 개의 로거를 설정하는 경우:

import { configure, getConsoleSink, getFileSink } from "@logtape/logtape";

await configure({
  sinks: {
    console: getConsoleSink(),
    file:    getFileSink("app.log"),
  },
  loggers: [
    { category: ["app"],           level: "debug", sinks: ["file"] },
    { category: ["app", "module"], level: "debug", sinks: ["console"] },
  ],
});

["app"] 로거에 기록된 로그는 app.log 파일에만 저장되지만, ["app", "module"] 로거에 기록된 로그는 두 파일 모두에 저장됩니다. app.log 파일을 작성하여 콘솔에 출력합니다. 이는 ["app", "module"] 로거가 상위 카테고리 ["app"]에서 싱크를 상속하기 때문입니다.

그러나 때로는 이 동작을 원하지 않을 수도 있습니다. LogTape 0.6.0부터 이제 상위 로거의 싱크를 재정의할 수 있습니다. 예를 들어, 다음과 같이 하위 로거에 대해 parentSinks: "재정의" 옵션을 활성화하는 경우:

await configure({
  sinks: { /* omitted; same as above */ },
  loggers: [
    { category: ["app"],           level: "debug", sinks: ["file"] },
    { category: ["app", "module"], level: "debug", sinks: ["console"], parentSinks: "override" },
  ],
});

["app"] 로거에 기록된 로그는 app.log 파일에만 저장되고, ["app", "module"] 로거에 기록된 로그는 다음 파일로만 출력됩니다. 콘솔. 이는 하위 로거 ["app", "module"]가 ["app"] 로거의 싱크를 재정의했기 때문입니다.

물론 기본값은 parentSinks: "inherit"이므로 옵션을 지정하지 않으면 이전처럼 동작하게 됩니다.

이 기능 추가 배경이 궁금하시다면 GitHub 이슈 #15를 참고해주세요.

메시지 템플릿의 자리 표시자에 선행/후행 공백 허용

이전 버전에서는 다음과 같이 로그인한 경우:

logger.info("Hello, { name }!", { name: "Alice" });

기대와는 달리 Hello, undefine! 생성될 것입니다. 이는 자리 표시자 { name }에 공백 문자가 포함되어 있어 "name" 대신 " name " 속성을 찾았기 때문입니다. 즉, 다음과 같이 자리 표시자에서 공백을 제거해야 했습니다.

logger.info("Hello, {name}!", { name: "Alice" });

또는 다음과 같이 실제 속성 이름에 동일한 공백을 추가합니다.

logger.info("Hello, { name }!", { " name ": "Alice" });

엄밀히 말하면 버그는 아니지만 코딩 습관에 따라 실수가 발생하기 쉬운 동작이었습니다.

그러나 LogTape 0.6.0부터는 자리 표시자의 시작과 끝 부분에 공백이 있어도 공백이 없는 속성 이름을 찾습니다. 예를 들어 다음과 같이 로그하는 경우:

logger.info("Hello, { name }!", { name: "Alice" });

역시 Hello, Alice!의 로그입니다. 생성됩니다.

단, 공백 문자를 포함하여 정확히 일치하는 속성이 있는 경우 이를 우선으로 처리합니다. 예를 들어 다음과 같이 로그하는 경우:

logger.info("Hello, { name }!", { name: "Alice", " name ": "Bob" });

안녕하세요, 밥! Hello, Alice! 대신 기록됩니다.

이 기능 추가 배경이 궁금하시다면 GitHub 이슈 #16을 참고해주세요.

LogRecord.rawMessage 속성

LogRecord는 LogTape에 의해 출력 및 포맷되기 전의 로그를 나타내는 데이터 유형입니다.

LogRecord.message 속성이 이미 존재하지만 이 속성에는 메시지 템플릿의 자리 표시자가 실제 속성 값으로 대체된 후의 결과가 포함되어 있습니다. 대부분의 경우 이는 충분했지만 로그 출력 대상(싱크)이 다른 로깅 시스템인 경우 원본 메시지 템플릿과 속성 값을 별도로 출력하여 수신 로깅 시스템이 메시지 템플릿의 자리 표시자를 속성으로 바꿀 수 있도록 할 수 있습니다. 값을 직접적으로 지정합니다.

LogTape 0.6.0에 추가된 LogRecord.rawMessage는 자리 표시자가 대체되지 않은 메시지 템플릿의 원래 상태를 포함하는 정확히 이 목적을 위한 속성입니다. 예를 들어 다음과 같이 로그하는 경우:

logger.info("Hello, {name}!", { name: "Alice" });

LogRecord.message에는 ["Hello, ", "Alice", "!"] 값이 포함되지만 LogRecord.rawMessage에는 "Hello, {name}!" 값이 포함됩니다.

이 기능 추가 배경이 궁금하시다면 GitHub 이슈 #17을 참고해주세요.

사용자 정의 가능한 내장 텍스트 포맷터

텍스트 포맷터는 스트림 싱크, 파일 싱크 등에서 각 로그의 형식을 텍스트로 지정하는 방법을 결정하는 인터페이스입니다. 실제 유형 정의는 매우 간단합니다.

export type TextFormatter = (record: LogRecord) => string;

그러나 매번 텍스트 포맷터를 직접 정의하는 것은 번거로울 수 있으므로 LogTape에는 사용할 수 있는 defaultTextFormatter 및 ansiColorFormatter가 내장되어 있습니다. 지금까지는 추가적인 구성이 불가능했기 때문에 미리 정해진 형식을 그대로 받아들여야 했습니다. 예를 들어 "경고"와 같은 로그 수준이 WRN과 같은 3글자 약어로 출력되는 것이 마음에 들지 않으면 처음부터 TextFormatter를 구현해야 했습니다.

그러나 LogTape 0.6.0부터는 처음부터 TextFormatter를 구현할 필요 없이 getDefaultTextFormatter() 및 getAnsiColorFormatter() 함수를 통해 다양한 서식 설정을 원하는 대로 사용자 정의할 수 있습니다.

예를 들어 '경고'와 같은 로그 수준을 단일 대문자 W로 표시하려는 경우 다음과 같이 구성할 수 있습니다.

const myFormatter = getDefaultTextFormatter({ level: "L" });

또는 타임스탬프에서 날짜와 시간대를 생략하고 시간만 표시하려는 경우 다음과 같이 구성할 수 있습니다.

const myFormatter = getDefaultTextFormatter({ timestamp: "time" });

더 많은 서식 옵션에 대한 설명은 관련 문서를 참고하세요.

이번 기능 추가 배경이 궁금하시다면 GitHub 이슈 #13을 참고해주세요.

JSR 및 npm에서 가져오기

LogTape 0.6.0은 이미 JSR 및 npm에서 사용 가능하므로 지금 다운로드하세요!

deno add @logtape/[email protected]  # Deno
npm  add @logtape/[email protected]  # npm
pnpm add @logtape/[email protected]  # pnpm
yarn add @logtape/[email protected]  # Yarn
bun  add @logtape/[email protected]  # Bun

즐거운 로깅을 즐기세요!