LogTape .0에 암시적 컨텍스트 도입

암시적 컨텍스트를 도입한 LogTape 0.7.0의 출시를 발표하게 되어 기쁘게 생각합니다. 전체 지원서.

암시적 컨텍스트란 무엇입니까?

애플리케이션에서 HTTP 요청을 처리하고 있다고 상상해 보세요. 코드베이스에서 로그가 생성된 위치에 관계없이 요청 처리 중에 생성된 모든 로그 메시지에 요청 ID가 포함되기를 원합니다. 암시적 컨텍스트 이전에 다음을 수행해야 합니다.

1. 모든 함수 호출을 통해 요청 ID를 전달
2. 각 모듈에 대한 컨텍스트가 포함된 새 로거 생성
3. 또는 전역 변수를 사용합니다(자체 문제가 있음)

암시적 컨텍스트를 사용하면 이제 요청 핸들러 시작 부분에 컨텍스트를 설정할 수 있으며 해당 실행 컨텍스트 내의 모든 로그 메시지에 해당 정보가 자동으로 포함됩니다. 다음은 간단한 예입니다.

function handleRequest(requestId: string) {
  withContext({ requestId }, () => {
    // Any log message in this function or any function it calls
    // will automatically include the requestId
    processRequest();
  });
}

function processRequest() {
  // Note that we don't need to pass the requestId explicitly
  getLogger("processor").info(
    "Processing request: {requestId}"
  );
}

어떻게 작동하나요?

암시적 컨텍스트는 기본 런타임의 컨텍스트-로컬 스토리지 메커니즘(예: Node.js의 AsyncLocalStorage)을 사용하여 코드 실행 전반에 걸쳐 컨텍스트 정보를 유지합니다. 이는 비동기 작업에서도 컨텍스트가 적절하게 유지된다는 것을 의미합니다.

애플리케이션에서 암시적 컨텍스트를 활성화하려면 컨텍스트-로컬 스토리지로 LogTape을 구성해야 합니다.

import { AsyncLocalStorage } from "node:async_hooks";
import { configure } from "@logtape/logtape";

await configure({
  // ... other settings ...
  contextLocalStorage: new AsyncLocalStorage(),
});

중첩된 컨텍스트 및 우선순위

암시적 컨텍스트의 강력한 기능 중 하나는 중첩이 가능하다는 것입니다. 컨텍스트를 중첩하면 내부 컨텍스트가 외부 컨텍스트의 값을 상속하고 재정의할 수 있습니다.

function handleRequest(requestId: string) {
  withContext({ requestId, stage: "request" }, () => {
    // stage is "request" here
    processUser(1234);
  });
}

function processUser(userId: number) {
  withContext({ userId, stage: "user" }, () => {
    // stage is "user" here, but requestId is still available
    getLogger("processor").info(
      "Processing user: {userId} for request: {requestId}"
    );
  });
}

컨텍스트 값을 확인할 때 LogTape은 명확한 우선순위를 따릅니다.

1. 로그 메시지의 명시적 속성이 가장 높은 우선순위를 갖습니다
2. Logger.with()를 통해 설정된 명시적 컨텍스트가 두 번째 우선순위를 갖습니다
3. withContext()를 통해 설정된 암시적 컨텍스트는 가장 낮은 우선순위를 갖습니다

런타임 지원

2024년 10월부터 다음에서 암시적 컨텍스트가 지원됩니다.

• Node.js
• 데노
• 번

웹 브라우저는 TC39 비동기 컨텍스트 제안의 구현을 기다리고 있으므로 아직 암시적 컨텍스트를 지원하지 않습니다.

사용 사례

암시적 컨텍스트는 다음과 같은 경우에 특히 유용합니다.

1. 요청 추적: 요청 내의 모든 로그에 요청 ID, 사용자 ID 또는 세션 ID 추가
2. 거래 모니터링: 여러 작업 전반에 걸쳐 거래 ID 추적
3. 오류 컨텍스트: 오류 로그에 항상 관련 컨텍스트 정보가 있는지 확인
4. 성능 모니터링: 여러 작업에 걸쳐 타이밍 정보 추가
5. 테넌트 컨텍스트: 다중 테넌트 애플리케이션에서 모든 작업에 걸쳐 테넌트 정보를 추적합니다

모범 사례

암시적 컨텍스트를 사용할 때는 다음 모범 사례를 고려하세요.

1. 실제로 전체 실행 컨텍스트에 속하는 정보에 대해 암시적 컨텍스트를 사용하세요
2. 컨텍스트 데이터를 가볍게 유지하세요. 전체 실행을 통해 전달된다는 점을 기억하세요
3. 애플리케이션 전반에 걸쳐 의미 있고 일관된 키 이름을 사용하세요
4. 컨텍스트 구조의 일관성을 보장하기 위해 TypeScript 사용을 고려하세요
5. 애플리케이션에 대해 예상되는 컨텍스트 구조를 문서화하세요

마이그레이션 가이드

이미 LogTape을 사용하고 있다면 암시적 컨텍스트를 사용하도록 업그레이드하는 것이 간단합니다.

1. LogTape 0.7.0으로 업데이트
2. LogTape 구성에 컨텍스트-로컬 스토리지 추가
3. 컨텍스트가 수동으로 전달되는 장소를 식별
4. 적절한 경계에서 withContext() 호출로 대체

결론

LogTape 0.7.0의 암시적 컨텍스트는 코드를 복잡하게 만들거나 호출 스택을 통해 컨텍스트를 수동으로 전달하지 않고도 로그에 컨텍스트 정보를 추가할 수 있는 강력한 방법을 제공합니다. 이는 운영 전반에 걸쳐 컨텍스트를 추적하는 것이 중요한 웹 서비스, API 및 기타 애플리케이션에서 특히 유용합니다.

이 기능을 어떻게 사용하여 애플리케이션의 로깅 및 관찰 가능성을 향상시킬지 기대됩니다. 한번 시도해 보시고 의견을 알려주세요!

자세한 내용은 암시적 컨텍스트에 대한 전체 문서를 확인하세요.

위 내용은 LogTape .0에 암시적 컨텍스트 도입의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!