Node.js process 종료 이벤트 감지

🎯 Goals

• Node.js 프로세스 종료시 이벤트를 발생, 감지한다.
• 자주 쓰이는 process event 의 용례와 주의사항을 알아본다.

 

 

process.exit

When to use?

프로세스 종료 이벤트를 감지거나 추가 작업을 하고 싶을 때

ex) 로깅

 

When this occur?

exit 이벤트가 emit 되는 상황은 다음과 같다.

• 콜스택, 콜백큐, 잡큐가 모두 비워져서 더 이상 할 일이 없을 때 == 정상 종료 (exit code 0)
• process.exit(N) 로 직접 종료 이벤트 전달(emit).
• Exception 발생시 exit code 1 (단, process.on('uncaughtException') 미등록시)
  등록했을 경우 exit code 0으로 종료
  👉🏻 당연한 것이, 하나의 테스크(이벤트 리스너)가 event queue 에 추가되고 정상적으로 처리되면 종료 코드가 자동으로 0으로 변환된다.

 

⚠️ Execption 이 아닌 async funciton 내에서 throw  (reject) 가 발생하면 process.exit 이 발동하지 않는다.
이 때는 process.on('unhandledRejection') 을 등록해서 처리해줘야한다.

 

 

 

예제 코드

// Use `beforeExit`
// When event loop has no additional work to schedule.
// Normally, Node.js process will exit when there is no work scheduled.
// But a listener registered on `beforeExit` event can make asynchronous call, thereby Node.js process to continue.

// explicit termination 시 `beforeExit` 이 발동하지 않음.
// 👉🏻 이때는 오로지 'exit' 이벤트만 발생 또는 uncaughtException 발동.

// Explicit termination examples
// (1) calling process.exit()
// (2) uncaught exceptions.
// 위 2가지 케이스는 Callback queue, job queue 에 일이 남아있어도 바로 종료.

process.on('beforeExit', (code)=>{
    logger.error({
        exitCode: code,
        message: 'Process exit!',
        timestamp: new Date(),
    });

});

// 0 외에도 모두 발생
process.on('exit', (code)=>{
    console.log(`exit code : ${code}`);

    if(code !== 0) {
        logger.error({
            exitCode: code,
            message: "I'm gone",
            timestamp: new Date(),
        });
    }

});

// [Default Behavior]
// 이게 없으면 보통 process.stderr.fd 에 찍힌 내역을 logging 하고 종료함.
// exitCode 1 과 함께.

// process.on('uncaughtException') 은 이 기본 behavior 를 오버라이딩 하는것.
process.on('uncaughtException', (err)=>{
    console.error('exception');
    logger.error({
        exitCode: err.name,
        message: err.message,
        timestamp: new Date(),
    });
    
    // 아래와 같이 일부러 exitCode를 수정할 수 있음.
    process.exitCode = -1;
});

// 'SGITERM' means process was terminated gracefully
process.once('SIGTERM', (code)=>{
    console.log('SIGTERM exit code : ', code);
});

throw new Error('기모리');

 

 

 

 

🤔 위 코드대로하면  process.exit 이벤트 리스너가 동작하지 않는다. (로깅 X)

uncaughtException 에서 로깅없이 바로 프로세스 종료 

왜 로깅이 안되고 끝날까?

 

 

모든 이벤트가 등록되기 전에
너무 급하게 throw 하거나
process 를 종료시켰기 때문.

 

// 1초후 지연 실행
setTimeout(()=>{
    // process.exit(-1);
    throw new Error('기모리');
}, 1000)

이렇게만 해도 로깅이 제대로 된다.

 

 

Ctrl + C (SIGINT) 이벤트 감지는?

$ process.on('SIGINT')

 

위 예제에서 Ctrl + C 키를 눌러 SIGINT 시그널을 전송할 때는 process.exit 이벤트 리스너가 동작하지 않는다.

 

대신 다음과 같은 코드로 잡아낼 수 있다.

process.on('exit', (code)=>{
    console.log(`exit code : ${code}`);

// exit code 가 0이 아닐 때만 추가 로깅
    if(code !== 0) {
        logger.error({
            exitCode: code,
            message: "I'm gone",
            timestamp: new Date(),
        });
    }
});

// log 가 찍히고 
// 별도로 process.exit(0) 과 같은 코드를 추가하지 않아도.
// process.exitCode 가 0으로 종료된다.

process.once('SIGINT', ()=>{
    console.log("You've pressed Ctrl + C on this process.");
})

// Print:
// exit code: 0

 

 

 

---

🔗 Reference

Process | Node.js v17.3.0 Documentation