4장. 환경 설정 및 실행

서비스 프레임워크의 설정 파일에 대한 설명과 설정 후, 서비스 프레임워크 실행 방법에 대해 설명한다.

1. 설정

서비스 프레임워크의 설정 정보는 WEB-INF/default.properties 파일에 저장된다.

초기 설치 시에는 이 파일이 존재하지 않으므로 http://localhost:7612/ksf 와 같이 연결 하면, 초기 설정 페이지가 표시된다.

그림 4.1. 초기 설정 페이지

참고

Konan Search 패키지 설치를 통해 서비스 프레임워크를 사용하면 포트 기본값이 7614이고, 서비스 프레임워크 단독 설치 시에는 기본값 7612를 사용한다. 또한, 설치 서버에서 다른 포트로 실행되고 있을 수도 있다. 이 경우, 서블릿 컨테이너가 실행된 포르로 연결한다.
서비스 프레임워크를 Konan Search 패키지를 통해 설치 하지 않고, 단독으로 설치했을 경우는 위 설정 페이지에 라이선스 키를 입력해야 한다. 라이선스 키 발급은 코난테크놀로지의 담당자를 통해 발급 받는다.

1.1. default.properties

WEB-INF/default.properties 파일에 설정하는 정보는 다음과 같다.

프로퍼티 명	의미
dictionary.home	사전 파일 디렉터리의 위치 사전 파일들이 이미 존재할 경우에는 사전 파일 디렉터리의 절대 경로를 기입한다. 기본으로 설정된 WEB-INF/data를 기입하면 예제로 제공되는 기본 사전 파일들이 사용된다. 기본값) dictionary.home = WEB-INF/data 예) dictionary.home = C:\ProgramData\Konan
modules	실행할 서비스 목록 (akc,csw,kre,ppk,spc,rpk,hnj) akc : 검색어 자동 완성 서비스 csw : 금칙어 서비스 kre : 추천 검색어 서비스 ppk : 인기 검색어 서비스 spc : 오타 교정 서비스 rpk : 실시간 인기 검색어 서비스 hnj : 한자 독음 서비스 drk : 문서 랭킹 서비스
crz.host	데모 페이지에서 연결할 검색엔진 서버의 주소
crz.port	데모 페이지에서 연결할 검색엔진의 서비스 포트
crz.charset	데모 페이지에서 연결할 검색엔진의 문자셋 기본값) crz.charset = UTF-8

default.properties 예시

$ cat default.properties

#bootstrap properties for the services startup servlet.
#Fri Nov 08 18:18:33 KST 2013
dictionary.home=WEB-INF/data
modules=akc,csw,kre,ppk,spc,rpk,hnj,drk

default.properties 파일을 직접 수정할 경우에는 수정 후에 서블릿 컨테이너를 재시작해야 한다. crz.* 프로퍼티의 경우는 재시작이 필요없다.

참고

기본으로 설정된 WEB-INF/data를 사전 디렉터리로 사용할 경우, 서비스 프레임워크 업그레이드 후 WEB-INF/data 디렉터리는 다시 초기화된다. 업그레이드 후 환경 설정 시 백업한 디렉터리를 사전 디렉터리로 설정해야 한다.

인덱스 재구성을 위해 백업한 디렉터리의 하위 index 디렉터리는 삭제한다. WAS 재기동 시 index 디렉터리는 자동으로 재생성된다.

1.2. log4j.properties

로그 파일 생성 위치, 로깅 레벨 및 포맷 등 로깅 관련 정보를 설정하는 파일이다.

로그 파일은 기본적으로 서블릿 컨테이너의 logs/ksf.log 라는 파일로 생성된다.

1.3. 메모리 설정

자동 완성 서비스의 경우 빠른 응답을 위해 사전 전체를 메모리에 올려 서비스한다. 이에 따라 사전 파일의 용량에 따라 적절한 메모리 설정이 필요하다.

참고

자동 완성 서비스를 사용하지 않을 경우에는 JVM의 기본 메모리 설정으로 서비스가 충분히 가능하다. 기본 최대 힙 크기(-Xms)는 32비트 JVM의 경우 설치 메모리(physical memory)의 1/4과 1GB 중 적은 값을 사용한다. 64비트 JVM의 경우 설치 메모리의 1/4과 32GB 중 적은 값을 사용한다.

자동 완성 서비스의 경우 사전 파일의 크기 및 지원 서비스 모드에 따라 대략 아래와 같이 추가적인 메모리가 필요하다.

지원 서비스 모드	추가 메모리 필요량
첫 단어 자동 완성	사전 파일 크기의 4배
첫 단어, 끝 단어 자동 완성	사전 파일 크기의 6배
첫 단어, 중간 단어, 끝 단어 자동 완성	사전 파일 크기의 10배

기본 서비스를 위한 메모리(512MB)와 자동 완성 서비스를 위한 추가 메모리량을 더하여 JVM의 초기 힙 메모리를 설정한다. 최대 힙 메모리는 초기 힙 메모리의 2배 혹은 초기 메모리 + 1024MB 중 적은 값을 택한다.

예시

사전 파일의 크기 : 50MB
첫, 중간, 끝 단어 자동 완성 지원
필요한 초기 메모리 : 약 512 + 50 * 10 = 1012MB

대략 1GB로 초기 힙 메모리를 설정한다.

-Xms1024m -Xmx2048m

Apache Tomcat의 경우 catalina.bat 파일에

set JAVA_OPTS=-Xms1024m -Xmx2048m

를 추가, 혹은 catalina.sh에

JAVA_OPTS="-Xms1024m -Xmx2048m"

를 추가한다.

2. 실행

설치 과정이 끝나면 서비스 프레임워크는 WAS에 설치된 웹 애플리케이션으로 실행된다.

웹 브라우저에 아래 URL을 입력하여 서비스가 정상적으로 실행되고 있는지 확인할 수 있다.

주소 : http://localhost:7612/ksf

그림 4.2. 서비스 프레임워크 실행

3. 사전

서비스 프레임워크는 default.properties 파일의 dictionary.home 프로퍼티 값이 가리키는 디렉터리의 사전 파일을 참조한다.

경고

기존 검색엔진 모듈의 경우에는 서비스 종류에 따라 시스템 사전 파일 형식이 달랐다. 하지만, 서비스 프레임워크는 동일한 시스템 사전 형식을 사용한다. 이에 따라 기존 시스템 사전 파일은 서비스에 따라 지원하지 않을 수 있다. 기존 사전 파일들을 사용할 경우 WEB-INF/data 디렉터리에 기본으로 배포되는 시스템 사전으로 해당 시스템 사전을 교체한다. 텍스트 형식의 사전 파일은 호환성을 보장한다.

사전과 관련된 좀더 자세한 사항은 사전 편집 가이드를 참고한다.

서비스 프레임워크 설명서