Tomcat이 느려졌다면? “Tomcat 환경파일 setenv.bat”

들어가며

Tomcat을 윈도우 서버에서 사용하다 보면 setenv.bat라는 파일을 접하게 됩니다.

그런데 Tomcat을 처음 설정할 때는 이 파일이 어디에 있는지, 직접 만들어야 하는지, 그리고 JAVA_OPTS나 CATALINA_OPTS를 왜 여기에 넣는지 헷갈리는 경우가 많습니다.

저 역시 Tomcat 환경을 구성하다 보면 기본 설정 파일만 수정하기보다는 Tomcat 실행 환경을 별도로 관리할 필요가 있을 때 setenv.bat를 사용하는 방법을 먼저 확인하게 됩니다.

오늘은 윈도우 환경을 기준으로 Tomcat의 setenv.bat가 무엇인지, 어디에 만들어야 하는지, 그리고 JVM 메모리 설정은 어떻게 적용하는지 정리해보겠습니다.

1. setenv.bat 파일이란?

setenv.bat는 Tomcat을 실행할 때 필요한 환경변수나 JVM 옵션 등을 별도로 지정하기 위한 배치 파일입니다.

Tomcat의 기본 실행 스크립트인 startup.bat이나 catalina.bat 파일을 직접 수정할 수도 있지만, 이렇게 기본 파일을 수정하면 나중에 Tomcat을 업그레이드하거나 설정을 변경할 때 관리하기가 불편합니다.

그래서 별도의 setenv.bat 파일을 만들어 환경설정을 분리하는 방식이 많이 사용됩니다.

윈도우에서 일반적으로 다음과 같은 경로에 생성합니다.

%CATALINA_BASE%\bin\setenv.bat

또는 Tomcat 설치 환경에 따라 다음과 같이 사용할 수 있습니다.

%CATALINA_HOME%\bin\setenv.bat

여기서 중요한 것은 Tomcat의 실행 환경입니다.

CATALINA_HOME은 Tomcat이 설치된 위치를 의미하고, CATALINA_BASE는 실제 실행 인스턴스의 기본 디렉터리를 의미합니다.

단일 Tomcat 서버라면 두 경로가 같은 경우도 많습니다.

2. 왜 setenv.bat를 사용하는가?

가장 흔한 이유 중 하나가 JVM 메모리 설정입니다.

예를 들어 Tomcat에서 실행되는 웹 애플리케이션이 많아지거나 처리해야 할 데이터가 증가하면 기본 JVM 메모리만으로는 부족한 상황이 발생할 수 있습니다.

이때 JVM의 초기 힙 크기와 최대 힙 크기를 조정할 수 있습니다.

대표적으로 다음 옵션을 사용합니다.

-Xms1024m
-Xmx2048m

-Xms는 JVM이 시작할 때 사용할 초기 힙 크기이고, -Xmx는 JVM이 사용할 수 있는 최대 힙 크기입니다.

예를 들어 다음과 같이 설정할 수 있습니다.

set "CATALINA_OPTS=%CATALINA_OPTS% -Xms1024m -Xmx2048m"

이렇게 하면 Tomcat이 실행될 때 JVM에 해당 옵션이 전달됩니다.

다만 서버의 실제 물리 메모리가 4GB인데 무조건 -Xmx4096m처럼 크게 설정하는 것은 좋은 방법이 아닙니다.

운영체제와 다른 프로그램도 메모리를 사용하기 때문에 서버 전체 메모리와 애플리케이션의 실제 사용량을 고려해서 설정해야 합니다.

3. JAVA_OPTS와 CATALINA_OPTS의 차이

setenv.bat를 찾아보다 보면 JAVA_OPTS와 CATALINA_OPTS가 함께 등장하는 경우가 많습니다.

둘은 비슷해 보이지만 사용하는 목적에 차이가 있습니다.

JAVA_OPTS는 Tomcat뿐만 아니라 Java 실행 과정에서 사용되는 옵션에 적용될 수 있습니다.

반면 CATALINA_OPTS는 Tomcat을 시작하거나 실행할 때 사용하는 JVM 옵션을 지정하는 용도로 사용됩니다.

따라서 Tomcat의 힙 메모리나 GC와 같이 Tomcat 실행 자체에 필요한 JVM 옵션을 설정한다면 CATALINA_OPTS를 사용하는 방법을 먼저 고려할 수 있습니다.

예를 들어 다음처럼 작성할 수 있습니다.

set "CATALINA_OPTS=%CATALINA_OPTS% -Xms1024m -Xmx2048m"

환경에 따라 필요한 JVM 옵션을 추가할 수도 있습니다.

set "CATALINA_OPTS=%CATALINA_OPTS% -Xms1024m -Xmx2048m"
set "CATALINA_OPTS=%CATALINA_OPTS% -Dfile.encoding=UTF-8"

다만 JVM 옵션은 Java 버전과 Tomcat 버전에 따라 지원 여부가 달라질 수 있으므로 운영 서버에 적용하기 전에 현재 사용 중인 Java 버전을 확인하는 것이 좋습니다.

4. setenv.bat 파일이 없다면?

Tomcat을 설치했다고 해서 반드시 setenv.bat가 존재하는 것은 아닙니다.

파일이 없다면 직접 만들어 사용할 수 있습니다.

예를 들어 Tomcat의 bin 폴더에 setenv.bat를 생성합니다.

apache-tomcat
 └─ bin
     ├─ startup.bat
     ├─ shutdown.bat
     ├─ catalina.bat
     └─ setenv.bat

그리고 setenv.bat에 필요한 환경설정을 작성합니다.

간단하게 JVM 메모리만 설정한다면 다음 정도로 시작할 수 있습니다.

@echo off

set "CATALINA_OPTS=%CATALINA_OPTS% -Xms1024m -Xmx2048m"

여기서 중요한 부분은 기존 CATALINA_OPTS 값을 무조건 덮어쓰지 않고 기존 값에 옵션을 추가하는 형태로 작성했다는 점입니다.

5. startup.bat를 직접 수정하지 않는 이유

Tomcat 설정을 처음 접하면 startup.bat 또는 catalina.bat 파일을 열어서 JVM 옵션을 직접 넣고 싶은 생각이 들 수 있습니다.

실제로 그렇게 설정하는 것도 가능하지만 유지보수 측면에서는 주의할 필요가 있습니다.

Tomcat 버전을 변경하거나 설치 파일을 교체하면 수정했던 기본 스크립트가 다시 원래 상태로 돌아갈 수 있기 때문입니다.

반면 setenv.bat에 별도의 환경설정을 관리하면 Tomcat 기본 실행 스크립트와 운영 환경 설정을 분리할 수 있습니다.

특히 운영 서버에서는 어떤 JVM 옵션을 적용했는지 확인하기도 편합니다.

6. 메모리 설정은 크게 잡는 것이 무조건 좋은가?

그렇지는 않습니다.

-Xmx 값을 크게 설정한다고 해서 애플리케이션이 무조건 빨라지는 것은 아닙니다.

오히려 서버 메모리보다 과도하게 크게 설정하면 운영체제나 다른 서비스가 사용할 메모리가 부족해질 수 있습니다.

또한 Java 애플리케이션의 메모리 문제를 단순히 힙 크기만 늘려서 해결할 수 있는 것도 아닙니다.

실제 운영 환경에서는 다음과 같은 부분을 함께 확인하는 것이 좋습니다.

• 서버의 전체 메모리 용량
• Tomcat에서 실행되는 애플리케이션 수
• JVM Heap 사용량
• GC 발생 빈도
• 애플리케이션 로그
• DB 연결 수
• 동시 접속자 수
• 애플리케이션의 메모리 누수 여부

따라서 -Xms, -Xmx는 서버 상황에 맞게 설정하는 것이 중요합니다.

7. setenv.bat 적용 여부 확인하기

설정을 변경했다면 Tomcat을 재시작한 후 실제 JVM에 옵션이 적용됐는지 확인하는 것이 좋습니다.

단순히 setenv.bat 파일에 내용을 입력했다고 해서 설정이 정상적으로 적용됐다고 판단해서는 안 됩니다.

실제 실행 중인 Java 프로세스의 JVM 옵션이나 Tomcat 로그 등을 통해 적용 여부를 확인하는 것이 안전합니다.

특히 운영 서버에서는 메모리 설정을 변경한 뒤 장애가 발생할 수도 있기 때문에 기존 설정을 백업해 두는 것도 좋은 방법입니다.

마무리

Tomcat의 setenv.bat는 눈에 잘 띄지는 않지만 서버를 운영하다 보면 상당히 유용하게 사용할 수 있는 환경설정 파일입니다.

특히 윈도우에서 Tomcat을 운영하면서 JVM 메모리 설정이나 Java 시스템 속성 등을 관리해야 한다면 기본 startup.bat 파일을 직접 수정하기보다는 bin 디렉터리의 setenv.bat를 활용하는 방법을 알아두는 것이 좋습니다.

간단하게 정리하면 다음과 같습니다.

Tomcat
  ↓
bin
  ↓
setenv.bat
  ↓
CATALINA_OPTS
  ↓
JVM 옵션 설정

예를 들어 JVM 힙 메모리를 설정한다면 다음과 같은 형태로 사용할 수 있습니다.

set "CATALINA_OPTS=%CATALINA_OPTS% -Xms1024m -Xmx2048m"

다만 이 숫자를 모든 서버에 동일하게 적용하는 것은 적절하지 않습니다.

Tomcat이 설치된 서버의 메모리와 실제 애플리케이션 사용량을 확인한 뒤 적절한 값을 결정하는 것이 중요합니다.

결국 setenv.bat의 핵심은 Tomcat의 기본 실행 스크립트와 운영 환경에 필요한 설정을 분리해서 관리한다는 것이라고 볼 수 있습니다.

Tomcat을 운영하면서 JVM 메모리 부족이나 GC 문제 등을 겪고 있다면 가장 먼저 현재 setenv.bat와 JVM 실행 옵션부터 확인해보는 것도 좋은 출발점입니다.