[Node.js] Express 서버 Log 작성 및 .env 작성

[ Log ]

 - 컴퓨터의 처리 내용이나 이용 상황, 오류 출력 메시지 등을 시간의 흐름에 따라 기록한 것

 - 시스템 보안이나 유지보수 목적 등에 사용된다.

 - 유저의 이벤트, 데이터 요청, 트랜잭션 에러 규명 등을 정밀 분석 및 관리 가능

 

 

[ Dotenv ]

 - Node.js에서 사용자 환경 변수를 효과적으로 관리해주는 모듈

 - 보통 DB 관련 정보, API_KEY 등, 공개되면 안되는 정보들을 관리

 - 보통 .env라는 파일을 외부에 생성하여 불러와 사용

    1. dotenv 모듈 의존성 추가

$ npm install dotenv --save

 

    2. .env 환경 변수 파일 생성

// 본인은 프로젝트 최상위 루트 기준 ./config/.env 생성
PORT=3000	// 서버 포트 번호 지정
NODE_ENV=dev	// Node 개발 환경 지정

 

 

 

[ Winston ]

 - Node.js에서 log를 편리하게 관리할 수 있는 모듈

 - 실제 서버 운영 시 console.log, console.error를 대체하기 위한 모듈

    1. winston, winston-daily-rotate-file 모듈 의존성 추가

         => winston-daily-rotate-file은 로그 파일을 관리해주는 모듈

               기본값으로 하루 단위 새 로그 파일을 생성하며, 날짜별 로그파일 관리,

               로그 파일 설정등의 관리를 용이하게 해줌

$ npm install winston winston-daily-rotate-file --save

 

    2. logger.js 파일 생성

        => dotenv 모듈을 호출하여 .env 파일의 사용자 환경변수를 참조할 때

              만약 .env 파일이 프로젝트 최상위 루트 경로에 있지 않을 경우 dotenv.config() 메소드를 통해

              { path : {실제경로} } 실제 경로를 명시해주면 됨.

              .env 파일이 최상위 루트에 존재할 경우 그냥 dotenv.config() 사용

const winston = require("winston");	// winston 모듈 호출
const winstonDaily = require("winston-daily-rotate-file");	// winston-daily-rotate-file 모듈 호출
const process = require("process");	// process 모듈 호출
const dotenv = require("dotenv");	// dotenv 모듈 호출
dotenv.config({ path: `${process.cwd()}/config/.env` });

// Check .env
console.log("NODE ENV : " + process.env.NODE_ENV);
console.log("PORT : " + process.env.PORT);

// Set save logfile root path
const logDir = `${process.cwd() + "/logs"}`;
const { combine, timestamp, label, printf } = winston.format;

// Define log format
const logFormat = printf(({ timestamp, label, level, message }) => {
  return `[${timestamp}] [${label}] [${level}] | ${message}`;
});

/*
 * Log Level
 * Error: 0, Warn: 1, Info: 2, Http: 3, Verbose: 4, Debug: 5, Silly: 6
 * low level => high priority
 */
const logger = winston.createLogger({
  // Define log output format
  format: combine(
    timestamp({
      format: "YYYY-MM-DD HH:mm:ss",
    }),
    label({ label: "UMS Express Server" }), // App name
    logFormat // Log output Format
  ),

  // Define detail log output format settings
  transports: [
    /*
     * Define info level log settings
     * 자동으로 info:2 레벨 값보다 높은 warn: 1, error: 0 로그들도 포함됨
     */
    new winstonDaily({
      level: "info",
      datePattern: "YYYY-MM-DD",
      dirname: logDir,
      filename: `%DATE%.log`,
      maxFiles: 30, // 가장 최근 30일치 로그 파일 저장
      zippedArchive: true, // 아카이브된 로그 파일을 gzip 압축 여부
    }),

    /*
     * Define error level log settings
     * 기본적으로 info level에 포함되나, 구분을 위해 형식 변경 후 개별 지정
     */
    new winstonDaily({
      level: "error",
      datePattern: "YYYY-MM-DD",
      dirname: logDir + "/error", // log 기본 저장 경로 하위 /error 경로로 설정
      filename: `%DATE%.error.log`,
      maxFiles: 30,
      zippedArchive: true,
    }),

    /*
     * http
     */
    new winstonDaily({
      level: "http",
      datePattern: "YYYY-MM-DD",
      dirname: logDir + "/http",
      filename: `%DATE%.http.log`,
      maxFiles: 30,
      zippedArchive: true,
    }),
  ],

  // UncaughtException file settings
  exceptionHandlers: [
    new winstonDaily({
      level: "error",
      datePattern: "YYYY-MM-DD",
      dirname: logDir + "/exception",
      filename: `%DATE%.exception.log`,
      maxFiles: 30,
      zippedArchive: true,
    }),
  ],
});

/*
 * Production 환경이 아닌, 개발 환경의 경우 콘솔에 출력
 */
if (process.env.NODE_ENV !== "production") {
  logger.add(
    new winston.transports.Console({
      format: winston.format.combine(
        winston.format.colorize({ level: true, message: true }),
        // winston.format.label(),
        winston.format.simple(), // Output format => JSON.stringify({ ...rest })
        logFormat
      ),
    })
  );
}

module.exports = logger;

 

    3. 로그 작동 테스트

// test.js
const logger = require("./config/logger");

logger.info("hello world");
logger.error("hello world");
logger.warn("hello world");

레벨별 로그 색상별 출력 확인

 

 

[ Morgan ]

 - http 요청 및 응답에 대한 정보를 로깅하기 위한 모듈

 - winston 로그의 http level을 활용할 때 사용

    1. morgan 모듈 의존성 추가

$ npm install morgan --save

  

    2. morgan 미들웨어 작성

// ./utils/morgan.js
const morgan = require("morgan");
const logger = require("../config/logger");
const dotenv = require("dotenv");
dotenv.config({ path: `${process.cwd()}/config/.env` });

/*
 * NODE_ENV에 따라서 morgan 옵션 format 변경
 * combined 옵션이 dev 옵션보다 상세함
 */
const format = () => {
  const result = process.env.NODE_ENV === "production" ? "combined" : "dev";
  return result;
};

// 로그 작성을 위한 Output stream 옵션
const stream = {
  write: (message) => {
    logger.http(
      message.replace(
        /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
        ""
      )
    );
  },
};

/*
 * 로깅 스킵 여부 체크
 * 배포환경(production | res.statusCode < 400)일 경우 로그 기록 x
 */
const skip = (_, res) => {
  if (process.env.NODE_ENV === "production") {
    return res.statusCode < 400;
  }
  return false;
};

const morganMiddleware = morgan(format(), { stream, skip });

module.exports = morganMiddleware;

 

 

[ 메인 앱 서버 Winston + Morgan 적용 ]

 1. 메인 앱 서버 파일에 로그, 모건 모듈 작성 파일 및 라우터 등록

// app.js
const express = require("express");
const morganMiddleware = require("./utils/morganMiddleware");	// 사용자 morgan 모듈 호출
const logger = require("./config/logger");	// 사용자 log 모듈 호출
const router = require("./routes/router");	// 라우터 모듈 호출
const dotenv = require("dotenv");
dotenv.config();
const app = express();

const PORT = process.env.PORT;

// 프록시 서버의 ip 주소 출력
app.set("trust proxy", true);
app.use(morganMiddleware);
app.use("/router", router);

app.get("/", (req, res) => {
  res.send("Hello World");
});

app.listen(PORT, "0.0.0.0", () => {
  logger.info(`Server listening on port ${PORT}`);
});

// ./routes/router.js
const express = require("express");
const logger = require("../config/logger");
const router = express.Router();

router.get("/logging", (req, res) => {
  logger.info("Get /router/logging : " + req.ip);
  res.writeHead(404, { "Content-Type": "text/html" });
  res.end("error!!");
});

router.get("/skip", (req, res) => {
  logger.info("Get /router/info : " + req.ip);
  res.writeHead(200, { "Content-Type": "text/html" });
  res.end("success!!");
});

module.exports = router;

 

 2. 메인 앱 서버 실행 결과 확인

      => logger.js 파일 코드 하단부의 NODE_ENV가 'production'이 아니기 때문에 로그 내용 콘솔 출력

 

 3. 로그 관리 폴더 및 파일 생성 확인

상위 레벨 로그 하위 로그들은 자동으로 같이 저장되는 것을 확인

 

---

참고 : https://velog.io/@sung-ik-je/%EA%B0%9C%EB%85%90-Log 

Log란?

 

참고 : https://inpa.tistory.com/entry/NODE-%F0%9F%93%9A-Winston-%EB%AA%A8%EB%93%88-%EC%82%AC%EC%9A%A9%EB%B2%95-%EC%84%9C%EB%B2%84-%EB%A1%9C%EA%B7%B8-%EA%B4%80%EB%A6%AC

[NODE] 📚 Winston 모듈 사용법 - 서버 로그 관리

 

참고 : https://inpa.tistory.com/entry/EXPRESS-%F0%9F%93%9A-morgan-%EB%AF%B8%EB%93%A4%EC%9B%A8%EC%96%B4#[options]

[EXPRESS] 📚 morgan 미들웨어 💯 사용법 정리