Anyframe Log Manager
Submitted by heewon.jung on 금, 01/27/2012 - 17:23
 |
Anyframe Log Manager는 개발 및 유지보수 단계에서 로컬 개발 환경이 아닌 서버 개발환경(개발/스테이징/운영)의 로그데이타에 대한 접근성을 높이고, 분석을 위한 필터 및 편의기능 제공을 위한 웹 기반의 도구로써 로그 조회 기능을 제공한다. 또한, 원격에서 Legacy Application의 로그 정책을 관리하며 최근에 이슈가 되고 있는 경량의 no-sql db 중 하나인 mongo-db를 log repository로 활용하고 있다. |
특징
- Anyframe Java 기반의 오픈소스 로그관리 툴 : Anyframe Java를 기반으로 Web Application 형태로 개발된 오픈소스 로그 관리 도구(Tool)로서 자유롭게 확장 및 개선이 가능하다.
- MongoDB를 활용한 대용량 로그 데이터 저장 : 기존의 RDBMS보다 가볍고 빠른 No-SQL DB인 MongoDB를 Log Repository로 채택하여 대용량의 로그데이타를 쉽고 편리하게 저장/관리 할 수 있으며, 빠르게 조회 및 검색이 가능하다
- 간편하고 강력한 Legacy Application 적용 : Anyframe plugin 형태로 제공되는 Agent를 통해 Legacy Application의 손상 없이 간단한 설정방식과 더불어 코드레벨의 확장 없이 설정만으로 적용이 가능하도록 개발되었다.
- 웹 표준 UI 지원 : Cross Browser 를 포함한 웹 표준 UI를 지원하여 Internet Explorer 뿐만 아니라 Firefox, Chrome, Safari 등과 같은 브라우저에서도 동일하게 동작하도록 구현되어 있다.
- jQuery 컴포넌트를 이용한 Ajax 기반의 UI : Grid Style, Text Style의 로그 조회 UI를 제공하고, 화면의 Refresh 없이 실시간 로그를 확인할 수 있다.
주요 기능
로그 조회
로그 조회 기능은 Grid Type과 Text Type의 두 가지 형태의 view를 선택하여 사용할 수 있으며, 업무화면 영역 상단의 Tab을 선택하여 각 화면을 전환할 수 있다. Grid Type과 Text Type은 기본적으로 기능이 거의 같으나, Grid Type에는 Paging 기능과 상세 로그 조회기능이 제공되고, Text Type에서는 log tailing 기능이 추가로 제공된다. 또한, 두 타입 모두 Excel Export 기능을 제공한다.
Grid Type
Grid Type 화면의 경우 paging이 기본적으로 제공되며, 한 화면에 표시되는 데이타의 수는 10개이다. Grid 목록의 경우에는 Log Level, Time Stamp, Client IP, Message 만이 표시되며, 상세한 로그데이타가 필요한 경우 해당 로그를 클릭하면 아래 그림과 같은 팝업 형태로 로그 상세 정보를 제공한다.
Grid Type View
Text Type
Text Type View는 기본적으로 Grid Type View와 그 기능이 거의 동일하지만, paging 없이 마치 console 에서 tailing 하듯이 모든 로그정보를 순차적으로 표시한다. 또한 Clear 버튼을 통하여 기존에 표시된 로그가 많을 경우 초기화 할 수 있으며, 한 화면에 표시할 최대 row 수를 Line Limit를 통하여 지정할 수 있다.
Text Type View
로그 정책 변경
로그 정책 변경 기능은 Legacy Application의 log4j.xml 파일을 읽어들여 등록된 Logger들과 Appender를 조회할 수 있다.
또한, 등록되어있는 Logger들의 Level을 WAS의 재기동 없이 변경할 수 있으며 Appender 조회 권한을 Administrator와 Developer로 구분하여 설정할 수 있다.
Log Policy Mgmt.
사용자 관리
사용자 관리는 Administrator와 Developer 권한을 설정하여 사용자 계정을 관리 할 수 있다. 이 때, Developer 권한의 사용자는 로그 정책 변경, 사용자 관리 기능을 사용할 수 없다.
Quick Start
설치 환경
Anyframe Log Manager은 아래와 같은 환경에서 동작 가능하도록 개발되었다.
- JDK 1.5 이상
- Servlet Spec. 2.4 이상
본 문서에서는 기본적으로 Tomcat6.0을 기준으로 설치 가이드를 진행할 것이다. 이하 문서에서 [Tomcat Home] 이라함은 Tomcat 서버 설치 폴더를 지칭한다.
설치
Anyframe Log Manager는 별도의 웹 어플리케이션 형태로 동작하며 WAR 형태로 패키징하여 배포하고 있다. Legacy Application의 Sample로써 Anyframe Plugin 형태의 anyframe-log-manager-pi를 제공하며, 이를 함께 설치하면 보다 쉽게 Anyframe Log Manager와 연동할 수 있다.
* Anyframe 플러그인 형태의 Legacy Application이 아닐지라도 Anyframe Log Manager와 연동이 가능하며 자세한 설정 방법은 Anyframe Log Manager Plugin 매뉴얼을 참고한다.
본 가이드는 아래와 같은 가정을 전제로 진행되어야 한다.
- Log Repository로 Mongo DB가 설치되어 구동되고 있다.
- Anyframe Log Manager Plugin이 설치되어 Log Manager와 동일한 장비의 WAS에서 실행되고 있다.
다운 받은 Anyframe-log-manager-web-x.x.x-bin.zip 압축을 해제하면 anyframe-log-manager-web-x.x.x.war가 있다. 아래의 예시에서는 Tomcat의 자동 배포를 이용할 것이기 때문에 war 파일명이 web app의 context 루트가 될 것이다. 좀 더 간결한 context root 를 위해서 war 파일명 뒤쪽의 버전 명은 빼고 다음의 예제를 진행 하도록 한다.
- [Tomcat Home]\webapps 폴더 하위에 앞서 위에서 압축 해제한 anyframe-log-manager-web.war 파일을 옮겨 놓는다.
- anyframe-log-manager-web.war 파일을 압축해제한 후 mongo.properties 파일을 열어 "mongo.host" key에 대한 값을 실제 설치한 Mongo DB의 IP로 변경한다.
- [Tomcat Home]\bin 디렉토리에서 command창을 열어 catalina run 을 실행하여 Tomcat 서버를 시작시킨다.
이외의 어플리케이션 서버에 대해서는 각 어플리케이션 서버 배포 방법에 맞게 다운로드한 WAR 파일을 배포하면 된다.
실행 확인
정상적으로 실행되었는지 확인하는 방법에 대해 알아보도록 하자.
- Tomcat 서버가 정상적으로 시작되었는지 콘솔창을 통해 확인한다.
- 브라우저 주소창에 http://localhost:8080/anyframe-log-manager-web 을 입력하고, Anyframe Log Manager Web 화면이 뜨는지 확인한다.
- 최초 접속 시 사용자 계정이 존재하지 않으므로 사용자 계정 추가 버튼을 클릭한 후 Administrator 계정을 등록한다.
- 등록한 Administrator 계정으로 로그인한 후 Log Analysis, Log Application Management, Account Management 메뉴가 보이는지 확인한다.
- Log Application Management 메뉴에서 Anyframe Log Manager Plugin 설치 프로젝트의 log4j.xml 파일을 찾아 등록한 후 저장한다. 이 때, App. Name 항목은 반드시 Legacy Application(여기서는 Anyframe Log Manager Plugin 설치 프로젝트)의 context path와 같은 값이어야 이 이름을 가지고 해당 Application에서 저장한 로그를 조회할 수 있다.
- Log Analysis 메뉴를 선택한 후 위에서 등록한 Project에 대한 로그를 조회해 본다.
- Account Management 메뉴에서 Administrator 또는 Developer 권한을 갖는 사용자 계정을 추가해본다.
이외, Anyframe Log Manager 에 대한 자세한 사용법은 Anyframe Log Manager 매뉴얼을 참고하도록 한다.
리소스
Log Manager에서 사용하고 있는 주요 오픈소스는 다음과 같다.
매뉴얼
Log Manager 1.0.0
- Reference Manual (HTML-Single | HTML | PDF)
