Express로 NodeJS 헬스 체크 엔드포인트 만드는 방법!

Express 기반 NodeJS Health Check 엔드포인트 만들기

이번 글에서는 Express 기반으로 NodeJS Health Check 엔드포인트 만드는 법에 대해 알아보도록 하겠습니다. NodeJS Health Check는 현대의 애플리케이션이 안정적으로 운용되기 위해 꼭 필요한 요소입니다. 고객 기반이 성장함에 따라 항상 작동하는 서비스를 제공해야 하는 책임도 커집니다. 간단한 코드 몇 줄로 이를 구현할 수 있다는 점에서 큰 매력을 느낄 수 있습니다.

상태 확인 엔드포인트가 필요한 이유

상태 확인 엔드포인트는 필수적인 요소입니다. 특히, 클라우드 기반의 서비스나 마이크로서비스 아키텍처를 사용하는 경우, 서비스의 가용성을 실시간으로 모니터링할 수 있는 수단이 됩니다. 다음은 상태 확인 엔드포인트를 만들어야 하는 주요 이유입니다.

SLA 준수: 서비스 수준 계약(SLA)을 통해 고객에게 약속한 가동 시간을 반드시 지켜야 합니다. 이 엔드포인트를 통해 실시간으로 서비스의 상태를 확인할 수 있으며, SLA 준수를 보장하는 데 필수적입니다.
금전적 손실 방지: 일부 산업에서는 서비스 중단 한 분이 수만 달러의 손실로 이어질 수 있습니다. 예를 들어, 온라인 쇼핑몰에서 서버가 다운되면 그 시간 동안 장바구니에 있는 고객들이 구매를 포기할 수 있습니다.
비즈니스 평판 관리: 반복적인 다운타임은 비즈니스의 평판을 크게 손상시킬 수 있습니다. 신뢰를 잃으면 고객이 이탈하게 되고, 이는 장기적으로 기업에 큰 손해를 가져옵니다.
간편한 모니터링: 건강 상태를 체크하는 엔드포인트는 다른 모니터링 도구와 통합하여 상태를 확인하는 데 매우 유용합니다. 이렇게 함으로써 문제가 발생하기 전에 예방할 수 있는 방법을 제공합니다.
결함 감지: 각 마이크로서비스의 상태를 모니터링함으로써 팀원들이 신속하게 문제를 파악하고 수정할 수 있습니다. 시스템이 정상적으로 작동할 때는 알림이 필요 없지만, 문제가 발생했을 때 적절한 알림을 받을 수 있는 시스템이 필요합니다.
스케일링: 서비스가 성장함에 따라 애플리케이션의 스케일링이 필요할 수 있습니다. 각 인스턴스의 상태를 확인함으로써, 적절히 리소스를 할당하고 불필요한 다운타임을 방지할 수 있습니다.

아래의 표는 상태 확인 엔드포인트의 중요성을 정리한 것입니다.

이유	설명
SLA 준수	약속된 서비스 가동시간을 보장합니다.
금전적 손실 방지	다운타임으로 인한 직접적인 손실을 예방할 수 있습니다.
비즈니스 평판 관리	고객 신뢰도를 유지합니다.
간편한 모니터링	타겟 시스템 상태를 실시간으로 확인합니다.
결함 감지	문제 발생 시 빠른 대응이 가능합니다.
스케일링	시스템의 성장을 지원합니다.

Express 기반 Health Check 엔드포인트 구현

이제 Express를 사용하여 Health Check 엔드포인트를 구현해보겠습니다. 간단한 코드로 시작하여 점차적으로 유용한 기능을 추가함으로써 해당 엔드포인트를 실질적으로 활용할 수 있게 됩니다. 아래는 Express를 사용하여 간단한 Health Check 엔드포인트를 만드는 코드입니다.

javascript
const express = require(express);
const http = require(http);

const app = express();
const router = express.Router();

router.use((req, res, next) => {
res.header(Access-Control-Allow-Methods, GET);
next();
});

router.get(/health, (req, res) => {
const data = {
uptime: process.uptime(),
message: Ok,
date: new Date()
}

res.status(200).send(data);
});

app.use(/api/v1, router);

const server = http.createServer(app);
server.listen(3000);

위 코드에서는 /api/v1/health 경로에 요청이 들어오면 Node.js의 process.uptime() 메서드를 사용하여 프로세스의 실행 시간을 초 단위로 반환합니다. 이는 서버의 가용성을 평가하는 데 유용한 데이터입니다. 이 뿐만 아니라, new Date()를 통해 요청이 들어온 시각 또한 반환합니다. 이를 통해 상태 확인 요청 간의 시각을 비교할 수 있습니다.

이 엔드포인트는 단순한 JSON 형태의 응답을 반환합니다. 그러나 단순한 상태 응답만으로는 부족할 수 있습니다. 다음 단계로 데이터베이스 연결과 같은 추가 검사를 할 수 있습니다.

데이터베이스 연결 검사

Health Check 엔드포인트의 유용성을 극대화하기 위해, 데이터베이스 연결 상태를 확인하는 로직을 추가해보겠습니다. 데이터베이스가 제대로 연결되어 있는지 점검하는 것은 서비스의 가용성을 평가하는 데 매우 중요합니다. 아래는 MongoDB를 예로 들어 연결 상태를 확인하는 코드입니다.

javascript
const mongoose = require(mongoose);

// MongoDB 연결 설정
mongoose.connect(mongodb://localhost/test, { useNewUrlParser: true, useUnifiedTopology: true });

router.get(/health, async (req, res) => {
try {
const isDatabaseConnected = await mongoose.connection.readyState === 1;

const data = {
  uptime: process.uptime(),
  message: Ok,
  date: new Date(),
  dbStatus: isDatabaseConnected? Connected : Disconnected
};

res.status(200).send(data);

} catch (error) {
res.status(500).send({ message: Error connecting to database, error });
}
});

위 코드에서는 MongoDB와의 연결 상태를 확인하여 응답 객체에 포함시키고 있습니다. dbStatus 항목은 데이터베이스 연결 여부를 나타내며, 이는 클라우드 기반 애플리케이션에서 중요한 지표가 될 것입니다. 서비스가 원활히 작동하기 위해서는 데이터베이스의 연결 상태를 항상 확인해야 합니다.

아래의 표는 데이터베이스 연결 상태를 점검할 때 주의해야 할 사항들을 정리한 것입니다.

체크 항목	설명
연결 시간	데이터베이스의 연결 지연 시간을 확인합니다.
에러 핸들링	연결 오류를 적절히 처리하여 서비스 중단이 없도록 합니다.
성능 모니터링	데이터베이스의 성능을 모니터링하여 문제가 발생하기 전에 대응합니다.

이처럼 간단한 Health Check 엔드포인트를 구현하고 데이터를 확장해 나가면서, 응답 속도와 신뢰성을 극대화 할 수 있습니다.

건강 상태 모니터링 자동화

이제 앱의 상태를 확인할 수 있는 새로운 엔드포인트가 생겼다면, 주기적으로 이 엔드포인트를 호출하여 실시간으로 상태를 모니터링할 수 있는 방법을 모색해야 합니다. 이를 위해서는 다양한 모니터링 서비스와 솔루션이 있습니다. 예를 들어, Hyperping과 같은 플랫폼을 사용하면 앱의 가용성을 지속적으로 모니터링할 수 있습니다.

Hyperping은 설정이 매우 간단하여, 새로운 엔드포인트를 추가하고 몇 가지 클릭만으로 서비스를 시작할 수 있습니다. 신뢰할 수 있는 모니터링 도구를 사용하면 가동 원시 데이터를 쉽게 수집하고 분석할 수 있습니다. 모니터링이 시작된 후 몇 분 후, 선택된 지역에서의 가용성 및 응답 시간에 대한 데이터를 시각적으로 확인할 수 있습니다.

또한, Slack, OpsGenie와 같은 툴과 통합하여 팀원들에게 즉각적인 알림을 보낼 수 있습니다. 이를 통해 서비스 런칭 후 발생할 수 있는 각종 리스크를 예방하고, 필요한 경우 신속히 대응할 수 있는 시스템을 구축할 수 있습니다.

아래 표는 유용한 모니터링 도구들을 비교한 내용입니다.

도구 이름	주요 기능	가격 정책
Hyperping	가용성 모니터링, 사용자 정의 경고	기본 무료, 유료 플랜 제공
Datadog	전체 시스템 관찰, 성능 모니터링	무료 체험 후 유료 플랜
New Relic	애플리케이션 성능 관리(APM)	무료 체험 후 유료 플랜
UptimeRobot	간단한 HTTP 체킹, 알림 기능	무료 플랜 제공, 유료 플랜 있음

모니터링 도구를 통해 정기적으로 상태를 체크하면, 서비스가 운영 중에 발생할 수 있는 각종 문제를 사전에 예방하는 데 큰 도움이 됩니다. 이를 통해 사업자가 고객에게 더욱 안정적인 서비스를 제공할 수 있게 됩니다.

결론

이번 포스트에서는 Express 기반으로 NodeJS Health Check 엔드포인트를 만드는 방법에 대해 심도 있게 설명하였습니다. 상태 확인 엔드포인트는 가용성을 모니터링하는 데 매우 중요한 역할을 하며, SLA 준수와 금전적 손실을 방지하는 데 필요한 요소입니다. 이를 통해 비즈니스의 평판을 유지하고 고객의 신뢰를 얻을 수 있습니다.

모니터링 도구와의 통합을 통해, 보다 효율적이고 안정적인 서비스 운영이 가능합니다. 이제 구체적인 실습을 통해 이론을 실제로 옮겨보세요. 고객에게 사랑받는 서비스로 성장할 수 있는 기회가 될 것입니다.

자주 묻는 질문과 답변

질문1: Health Check 엔드포인트는 어떤 기술을 사용할 수 있나요?
답변1: 보통은 Express와 Node.js를 사용하지만, Flask, Django와 같은 다른 웹 프레임워크를 사용할 수도 있습니다.

질문2: 데이터베이스 연결을 확인하는 것이 왜 중요한가요?
답변2: 데이터베이스가 연결되지 않으면 애플리케이션이 정상적으로 작동하지 않을 수 있기 때문에, 이를 모니터링하는 것이 중요합니다.

질문3: 모니터링 도구를 사용하는 것이 필수인가요?
답변3: 필수는 아니지만, 데이터와 메트릭을 지속적으로 확인하여 신속히 대응할 수 있는 장점이 있습니다.

질문4: Express Health Check 엔드포인트는 어떻게 설정하나요?
답변4: Express 라우터를 생성하고, 특정 경로에서 상태를 반환하는 핸들러를 설정하면 됩니다.

질문5: 엔드포인트에 어떤 정보를 포함해야 하나요?
답변5: 서비스의 가용성, 데이터베이스 연결 상태, 처리된 요청 수와 같은 다양한 정보를 포함하는 것이 바람직합니다.