제니퍼 에이전트를 일반적으로 설치하는 방법을 설명한다. 제니퍼 에이전트 설치는 웹 애플리케이션 서버 혹은 독립 실행형 자바 데몬에 설치가 가능하다.

에이전트 디렉토리 설명

제니퍼 패키지 압축을 해제하면 agent.java 디렉토리가 생성된다. agent.java 내의 디렉토리에 대한 설명이다.

에이전트 파일 설명

agent.java 디렉토리에는 두개의 jar파일이 버전별로 존재한다. jennifer.jar 파일은 interface만 존재하며, 에이전트가 기동되면서 가장 최신 버전의 파일을 로딩한다. 아래는 해당 파일들에 대한 설명이다.

에이전트 지원 범위

에이전트 구성 및 설정

제니퍼 에이전트 설치는 정확한 의미로는 모니터링 대상의 자바 옵션 설정을 변경하는 작업을 말한다.

제니퍼 에이전트 설정을 위한 자바 옵션

웹애플리케이션에 제니퍼 에이전트 구성을 위해서는 아래에 있는 두개의 옵션을 넣으면 된다.

에이전트의 홈이 /home/jennifer5/agent.java 라고 가정할때, 아래와 같이 옵션을 추가하면 된다.

에이전트 필수 옵션

에이전트를 초기화 하기 위해서는 필수적으로 들어가야 하는 옵션이 있다. 아래에 필수적으로 필요한 옵션들을 설명한다.

inst_id (Instance ID) 수동설정

설정파일(jennifer.conf)에 inst_id 를 임의로 추가하여 설정할 수 있다.

inst_id = 999

제니퍼 에이전트 설치

이 장에서는 Web Application Server 별로 설치하는 방법을 설명한다. 설치라고 하면 자바 옵션에 두가지 옵션만 추가하면 된다.

제니퍼 에이전트 설정을 모니터링 대상 자바기동옵션에 추가한다.

-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
-javaagent:/home/jennifer5/agent.java/jennifer.jar

다음은 각 Web Application Server별로 기본적으로 설치하는 방법을 간략하게 설명한다.

WebSphere 에 제니퍼 에이전트 설치

WebSphere 관리콘솔에서 [ 애플리케이션 서버 선택 | 프로세스정의 | 자바 가상 시스템 ] 메뉴를 선택한다.

1. 일반 JVM 인수에 아래의 값을 입력한다.

-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
-javaagent:/home/jennifer5/agent.java/jennifer.jar

2. 해당 설정값을 저장한다.

3. 설치한 애플리케이션 서버를 재시작한다.

4. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

WebLogic 에 제니퍼 에이전트 설치

WebLogic 의 기본적인 자바 옵션을 설정하는 파일은 $DOMAIN_HOME/bin/startWebLogic.sh(bat) 이다.

1. 웹로직의 $DOMAIN_HOME/bin/startWebLogic.sh(bat) 파일에서 JAVA_OPTIONS 항목에 아래의 두 옵션을 넣는다.

-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
-javaagent:/home/jennifer5/agent.java/jennifer.jar

2. 설치한 애플리케이션 서버를 재시작한다.

3. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

Tomcat 에 제니퍼 에이전트 설치

Tomcat 의 기본적인 설정파일은 $CATALINA_HOME/bin/catalina.sh(bat) 이다.

1. Tomcat 의 $CATALINA_HOME/bin/catalina.sh(bat) 파일에서 JAVA_OPTS 항목에 아래의 두 옵션을 넣는다.

-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
-javaagent:/home/jennifer5/agent.java/jennifer.jar

2. 설치한 애플리케이션 서버를 재시작한다.

3. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

Resin 에 제니퍼 에이전트 설치

Resin 의 경우에 기본적인 설정파일은 버전별로 다르다.

1. Resin 의 $RESIN_HOME/conf/resin.conf 혹은 $RESIN_HOME/conf/resin.xml 파일에서 아래와 같이 <jvm-arg> 항목에 두 옵션을 넣는다.

<jvm-arg>-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf</jvm-arg> 
<jvm-arg>-javaagent:/home/jennifer5/agent.java/jennifer.jar</jvm-arg>

2. 설치한 애플리케이션 서버를 재시작한다.

3. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

JEUS 에 제니퍼 에이전트 설치

JEUS 의 기본적인 자바 옵션을 설정하는 파일은 $JEUS_HOME/config/$hostname/JEUSMain.xml 이다.

1. JEUS 의 $JEUS_HOME/config/$hostname/JEUSMain.xml 파일에서 <command-option></command-option> 항목에 두 옵션을 추가한다.

<command-option>
  -Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
  -javaagent:/home/jennifer5/agent.java/jennifer.jar 
</command-option>

2. 설치한 애플리케이션 서버를 재시작한다.

3. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

JBoss 에 제니퍼 에이전트 설치

JBoss 는 community 버전과 EAP 버전 두가지의 종류가 존재한다. 여기서는 EAP버전을 기준으로 설명한다. JBoss 의 경우에 기본적인 설정파일은 버전별로 다르다.

1. JBoss 의 설정파일에서 JAVA_OPTS 옵션에 아래의 두 옵션을 추가한다.

-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
-javaagent:/home/jennifer5/agent.java/jennifer.jar

if [ "x$JBOSS_MODULES_SYSTEM_PKGS" = "x" ]; then
   JBOSS_MODULES_SYSTEM_PKGS="org.jboss.byteman,aries"
fi

2. 설치한 애플리케이션 서버를 재시작한다.

3. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

GlassFish 에 제니퍼 에이전트 설치

GlassFish 의 자바 옵션 설정은 관리화면에서 [ Configurations | JVM Settings | JVM Options ] 메뉴이다

1. 관리콘솔 화면 [ Configurations | JVM Settings | JVM Options ] 에서 Add JVM Option 을 클릭하여 각각 아래의 두 옵션을 추가하고 설정값을 저장한다.

-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
-javaagent:/home/jennifer5/agent.java/jennifer.jar

2. $GLASSFISH_HOME/config 디렉토리에 osgi.properties 파일에서 org.osgi.framework.bootdelegation 옵션에 아래와 같이 추가한다.

org.osgi.framework.bootdelegation=${eclipselink.bootdelegation}, \
                                  com.sun.btrace, com.sun.btrace.*, \
                                  aries, aries.*, \
                                  org.netbeans.lib.profiler, org.netbeans.lib.profiler.*

3. 설치한 애플리케이션 서버를 재시작한다.

4. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

Jetty 에 제니퍼 에이전트 설치

Jetty 의 기본 자바 옵션 설정파일은 jetty.sh 이다.

1. $JETTY_HOME/bin 디렉토리에 jetty.sh 파일에서 두개의 옵션 설정값을 추가한다.

-Djennifer.config=/home/jennifer5/agent.java/conf/jennifer.conf
-javaagent:/home/jennifer5/agent.java/jennifer.jar

#####################################################

# Add jetty properties to Java VM options.
#####################################################
JAVA_OPTIONS+=("-Djetty.home=$JETTY_HOME" "-Djava.io.tmpdir=$TMPDIR" "-Djennifer.config=/home/j5/jennifer5/agent.java/conf/jennifer.conf" "-javaagent:/home/j5/jennifer5/agent.java/jennifer.jar" )

2. 설치한 애플리케이션 서버를 재시작한다.

3. 제니퍼 에이전트가 정상적으로 적용이 되면 에이전트 로그에 아래와 같은 로그를 확인할 수 있다.

2020-09-01/16:35:05 [I023] Agent own advanced option is found : domain_id = [1000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : inst_id = [10000]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_encoding = [UTF-8]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_rotation = [true]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : log_level = [1]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_address = [192.168.0.31]
2020-09-01/16:35:05 [I023] Agent own advanced option is found : server_port = [5000]
2020-09-01/16:35:05 [I001] Agent initialized
2020-09-01/16:35:05 [I001] loading control module : /Users/nomin/jennifer5/agent/agent.java/jennifer.impl-5.5.2.2.jar
2020-09-01/16:35:05 [I001] Agent Enable : true
2020-09-01/16:35:05 [I001] Agent Base Version 5.5.2
2020-09-01/16:35:05 [I001] Agent Implementation Version 5.5.2.2
...
2020-09-01/16:35:09 [I001] Runtime Module initialized

Azure App Service에 제니퍼 에이전트 설치

Azure에 올릴 수 있는 JAVA Web App Service는 크게 다음의 유형으로 나눌 수 있다.

• JAVA Web App Service for Windows

• JAVA Web App Service for Linux

우선, Windows 호스팅 환경에 설치된 Java Web App의 경우 아래의 화면과 같이 "Extensions" 설정으로 들어가 "Add" 버튼을 누르면 나오는 확장 목록에서,

"JENNIFER Java Agent" 항목을 선택해 설치를 진행한다.

설치가 완료된 후 다시 "App Services" 관리 화면의 "Application Settings" 화면에서,

위의 환경처럼 4개의 환경 변수를 각각 아래와 같은 설정으로 등록한다.

설정 후 App Services를 재시작하면 설정이 반영되어 모니터링이 시작된다.

변면 리눅스 환경의 호스팅이라면 해당 App Service에 다음과 같이 메뉴를 이용해 SSH 접속을 하고,

/home/site/wwwroot/apm 디렉터리를 만들어 Java Agent ZIP 파일을 다운로드한다.

/home# cd site
/home/site# cd wwwroot
/home/site/wwwroot# mkdir apm
/home/site/wwwroot# cd apm
/home/site/wwwroot/apm# wget https://.../jennifer-agent-java-5.5.3.8.zip

동일한 디렉터리에 zip 파일을 압축 해제하면,

/home/site/wwwroot/apm# unzip jennifer-agent-java-5.5.3.8.zip

/home/site/wwwroot/apm/agent.java 디렉터리가 생성된다. 마지막으로 Azure App Service 관리 화면에서 CATALINA_OPTS 또는 JAVA_OPTS를 포함한 환경 변수 4개를 다음과 같이 추가하고 변경 사항을 반영하기 위해 Web App을 재시작하면 에이전트의 모니터링 기능이 작동한다.

시스템 리소스(CPU, Memory) 사용량 수집을 위한 JNI 모듈 등록

JNI 모듈을 통해 CPU, Memory 데이터를 수집하기 위한 방법은 다음과 같다.

1. 에이전트 설치 디렉토리의 libs 디렉토리에서 에이전트 운영체제에 맞는 공유 라이브러리 파일을 찾는다. (ex : aix-7.1/libjennifer5-0.1.0-aix7.1_32.so)

2. 찾은 공유 라이브러리 파일을 에이전트 설치 디렉토리의 libs 디렉토리로 복사 한다.

3. enable_jmx_for_system_resource 고급옵션 값을 false로 변경한다.

4. 에이전트를 재시작한다.

5. JNI 모듈이 정상적으로 로드 되었는지 로그를 확인한다.

2014-03-19/15:35:29 native lib libjennifer5-0.1.0-aix7.1_32.so loaded

제니퍼 에이전트 제거

제니퍼 에이전트를 제거하기 위해서는 설치 구성시에 적용한 두개의 옵션을 삭제하고 WAS를 재기동 한다.

제니퍼 에이전트 업그레이드

제니퍼 에이전트 업그레이드는 제니퍼 화면의 관리화면에서 업그레이드를 진행한다.