Winston: 기능요청: 기본 메타데이터의 함수

여기의 근본적인 문제는 다소 복잡하므로 여기에서 우리가 요구하는 것을 요약하겠습니다 -- 우리는 defaultMetadata 가 필드로 함수를 제공하여 동적으로 생성된 값을 포함하는 기능을 보는 데 관심이 있을 것입니다. 예를 들어:

const logger = createLogger({
  defaultMeta: {
    // Function to be evaluated every time a log is written.
    timeWritten: () => { return `Date.now()`; }
  },
  // ...
});

전체 근거는 아래를 참조하십시오.

귀하의 환경에 대해 알려주십시오.

• _ winston 버전?_
  
  
  
  • [ ] winston@2
  
  
  • [x] winston@3
  
  
• _ node -v 출력:_ v10.15.2
• _운영 체제?_ macOS(관련 없음)
• _언어?_ ES7(관련 없음)

문제가 무엇입니까?

Winston용 Stackdriver Logging Transport의 작성자로서 우리는 로그 요청 상관 관계를 지원하고 싶습니다. async_hooks 모듈은 요청 ID와 같은 요청별 정보를 저장할 수 있는 기능을 제공합니다. 그러나 Transport 측에서 안정적으로 검색할 수 있는 수단이 없습니다.

문제는 예를 통해 가장 잘 설명됩니다. 다음 코드는 ~100개의 요청이 연속적으로 빠르게 이루어질 때 이 출력 을 생성합니다.

const ah = require('async_hooks');
const express = require('express');
const { createLogger } = require('winston');
const TransportStream = require('winston-transport');

// Activate async hooks.
let requestIdHighWater = 0;
const requestIdTable = {};
ah.createHook({
  init: (child, resource, parent) => {
    requestIdTable[child] = requestIdTable[parent];
  }
}).enable();

// OUR CODE

class MyTransport extends TransportStream {
  log(info, next) {
    // From the transport, the request ID is not reliable.
    const actualRequestId = requestIdTable[ah.executionAsyncId()];
    console.log(`Expected: ${info.expectedRequestId}, Actual: ${actualRequestId}`);
    setImmediate(next);
  }
}

// OUR USER'S CODE

const logger = createLogger({
  transports: [new MyTransport()]
});

const app = express();

app.get('/', async (req, res) => {
  // Store a request ID.
  const requestId = requestIdHighWater++;
  requestIdTable[ah.executionAsyncId()] = requestId;
  logger.info('hello', { expectedRequestId: requestId });
  res.sendStatus(200);
});

app.listen(3000);

"예상" 및 "실제" 요청 ID의 불일치에 유의하십시오. 우리가 MyTransport 의 작성자라면 현재 실행 ID("실제")를 참조하여 올바른 요청 ID를 정확하게 얻을 수 있는 방법이 없습니다. 대신 메타데이터("예상")로 올바른 요청 ID를 전달하는 사용자에 의존해야 합니다. 이는 Transport가 log 콜백 호출을 연기할 때 Winston 3가 로그를 일괄 처리하기 때문입니다( readable-stream 를 통해).

문제는 우리를 위해 요청 ID를 전달하는 사용자에 의존하고 싶지 않다는 것입니다. 우리는 그것이 자동으로 일어나기를 원합니다. 결국 사용자는 아마도 다음과 같이 쓰고 싶을 것입니다.

app.get('/', async (req, res) => {
  logger.info('hello');
  res.sendStatus(200);
});

그리고 우리에게 맡기십시오.

그 대신 어떤 일이 일어나기를 기대하십니까?

연결된 출력의 예상 및 실제 요청 ID가 일치합니다.

기타 정보

실제 요청 ID가 일치하도록 코드를 수정하는 것은 불가능하므로 이 문제에 대한 해결책은 사용자가 로거가 호출될 때 호출되는 defaultMetadata 의 필드로 함수를 지정할 수 있도록 하는 것입니다. 그렇게 하면 코드가 this 로 변경되어 사용자가 요청 ID를 인식하지 않고도 코드를 작성할 수 있으며 defaultMetadata 필드로 썽크를 제공한다는 작은 경고가 있습니다(아마도 우리 모듈은 사용).