Apache Tomcat

Apache Tomcat 통합은 활성 세션 수 또는 네트워크 처리량과 같은 트래픽 관련 측정항목을 수집합니다. 통합은 또한 액세스 및 Catalina 로그를 수집합니다. 액세스 로그는 요청 세부정보에 집중된 JSON 페이로드로 파싱되고 Catalina 로그는 일반적인 세부정보에 대해 파싱됩니다. tomcat 수신자는 JMX를 통해 Tomcat 서버의 Java 가상 머신(JVM)에서 원격 분석을 수집합니다.

Tomcat에 대한 자세한 내용은 Apache Tomcat 문서를 참조하세요.

기본 요건

Tomcat 원격 분석을 수집하려면 운영 에이전트를 설치해야 합니다.

  • 측정항목의 경우 버전 2.9.0 이상을 설치합니다.
  • 로그의 경우 버전 2.9.0 이상을 설치합니다.

이 통합에서는 Tomcat 버전 10.x 및 9.0.x를 지원합니다.

Tomcat 인스턴스 구성

JMX 엔드포인트를 노출하려면 JVM을 시작할 때 com.sun.management.jmxremote.port 시스템 속성을 설정해야 합니다. 또한 com.sun.management.jmxremote.rmi.port 시스템 속성을 동일한 포트로 설정하는 것이 좋습니다. JMX 엔드포인트를 원격으로 노출하려면 java.rmi.server.hostname 시스템 속성도 설정해야 합니다.

기본적으로 이러한 속성은 Tomcat 배포의 tomcat-env.sh 파일에 설정합니다.

명령줄 인수를 사용하여 시스템 속성을 설정하려면 JVM을 시작할 때 속성 이름 앞에 -D를 붙입니다. 예를 들어 com.sun.management.jmxremote.port를 포트 8050로 설정하려면 JVM을 시작할 때 다음을 지정합니다.

-Dcom.sun.management.jmxremote.port=8050

Tomcat용 운영 에이전트 구성

운영 에이전트 구성 가이드를 수행하여 Tomcat 인스턴스에서 원격 분석을 수집하는 데 필요한 요소를 추가하고 에이전트를 다시 시작합니다.

구성 예시

다음 명령어는 Tomcat용 원격 분석을 수집하고 운영 에이전트를 다시 시작하는 구성을 만듭니다.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    tomcat:
      type: tomcat
      endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:8050/jmxrmi
  service:
    pipelines:
      tomcat:
        receivers:
          - tomcat

logging:
  receivers:
    tomcat_access:
      type: tomcat_access
    tomcat_system:
      type: tomcat_system
  service:
    pipelines:
      tomcat:
        receivers:
          - tomcat_access
          - tomcat_system
EOF

sudo service google-cloud-ops-agent restart
sleep 60

로그 수집 구성

Tomcat에서 로그를 수집하려면 Tomcat에서 생성하는 로그의 수신자를 만든 후 새 수신자의 파이프라인을 만들어야 합니다.

tomcat_system 로그의 수신자를 구성하려면 다음 필드를 지정합니다.

필드 기본값 설명
exclude_paths include_paths 중에서 일치하는 집합에서 제외할 파일 시스템 경로 패턴의 목록입니다.
include_paths [/opt/tomcat/logs/catalina.out] 각 파일을 테일링하여 읽을 파일 시스템 경로의 목록입니다. 와일드 카드(*)를 경로에 사용할 수 있습니다.
record_log_file_path false true로 설정된 경우 로그 레코드를 가져온 특정 파일의 경로가 출력 로그 항목에 agent.googleapis.com/log_file_path 라벨 값으로 표시됩니다. 와일드 카드를 사용할 경우 레코드를 가져온 파일의 경로만 기록됩니다.
type 값은 tomcat_system여야 합니다.
wildcard_refresh_interval 60s include_path의 와일드 카드 파일 경로가 새로고침되는 간격입니다. time.ParseDuration으로 구문 분석할 수 있는 기간으로 제공됩니다(예: 30s 또는 2m). 이 속성은 로그 파일이 기본 간격보다 빠르게 순환되는 높은 로깅 처리량에서 유용할 수 있습니다.

tomcat_access 로그의 수신자를 구성하려면 다음 필드를 지정합니다.

필드 기본값 설명
exclude_paths include_paths 중에서 일치하는 집합에서 제외할 파일 시스템 경로 패턴의 목록입니다.
include_paths [/opt/tomcat/logs/localhost_access_log.*.txt] 각 파일을 테일링하여 읽을 파일 시스템 경로의 목록입니다. 와일드 카드(*)를 경로에 사용할 수 있습니다.
record_log_file_path false true로 설정된 경우 로그 레코드를 가져온 특정 파일의 경로가 출력 로그 항목에 agent.googleapis.com/log_file_path 라벨 값으로 표시됩니다. 와일드 카드를 사용할 경우 레코드를 가져온 파일의 경로만 기록됩니다.
type 값은 tomcat_access여야 합니다.
wildcard_refresh_interval 60s include_path의 와일드 카드 파일 경로가 새로고침되는 간격입니다. time.ParseDuration으로 구문 분석할 수 있는 기간으로 제공됩니다(예: 30s 또는 2m). 이 속성은 로그 파일이 기본 간격보다 빠르게 순환되는 높은 로깅 처리량에서 유용할 수 있습니다.

로깅되는 내용

logName은 구성에 지정된 수신자 ID에서 파생됩니다. LogEntry 내의 자세한 필드는 다음과 같습니다.

tomcat_system 로그에는 LogEntry의 다음 필드가 포함됩니다.

필드 유형 설명
jsonPayload.level 문자열 로그 항목 수준
jsonPayload.message 문자열 로그 메시지(제공되는 경우 상세 스택 추적 포함)
jsonPayload.module 문자열 로그가 시작된 tomcat 모듈
jsonPayload.source 문자열 로그가 시작된 소스입니다.
severity 문자열(LogSeverity) 로그 항목 수준입니다(번역됨).

tomcat_access 로그에는 LogEntry의 다음 필드가 포함됩니다.

필드 유형 설명
httpRequest 객체 HttpRequest 참조
jsonPayload.host 문자열 호스트 헤더의 콘텐츠
jsonPayload.user 문자열 요청의 인증된 사용자 이름
severity 문자열(LogSeverity) 로그 항목 수준입니다(번역됨).

측정항목 수집 구성

Tomcat에서 측정항목을 수집하려면 Tomcat에서 생성하는 측정항목의 수신자를 만든 후 새 수신자의 파이프라인을 만들어야 합니다.

이 수신자는 구성에서 여러 인스턴스 모니터링과 같은 여러 인스턴스의 사용을 지원하지 않습니다. 이러한 모든 인스턴스는 동일한 시계열에 기록되며, Cloud Monitoring은 이를 구분할 수 있는 방법이 없습니다.

tomcat 측정항목의 수신자를 구성하려면 다음 필드를 지정합니다.

필드 기본값 설명
collect_jvm_metrics true 지원되는 JVM 측정항목도 수집하도록 수신자를 구성합니다.
collection_interval 60s 기간(예: 30s 또는 5m)입니다.
endpoint localhost:8050 서비스 URL을 구성하는 데 사용되는 JMX 서비스 URL 또는 호스트 및 포트입니다. 이 값은 service:jmx:<protocol>:<sap> 또는 host:port 형식이어야 합니다. host:port 형식의 값은 service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi의 서비스 URL을 만들기 위해 사용됩니다.
password JMX가 인증을 요구하도록 구성된 경우 구성된 비밀번호입니다.
type 값은 tomcat여야 합니다.
username JMX가 인증을 요구하도록 구성된 경우 구성된 사용자 이름입니다.

모니터링 대상

다음 표에서는 운영 에이전트가 Tomcat 인스턴스에서 수집하는 측정항목의 목록을 보여줍니다.

측정항목 유형 
종류, 유형
모니터링 리소스		 라벨
workload.googleapis.com/tomcat.errors
CUMULATIVE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.max_time
GAUGE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.processing_time
CUMULATIVE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.request_count
CUMULATIVE, INT64
gce_instance 		proto_handler
workload.googleapis.com/tomcat.sessions
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/tomcat.threads
GAUGE, INT64
gce_instance 		proto_handler
state
workload.googleapis.com/tomcat.traffic
CUMULATIVE, INT64
gce_instance 		direction
proto_handler

구성 확인

이 섹션에서는 Tomcat 수신자를 올바르게 구성했는지 확인하는 방법을 설명합니다. 운영 에이전트에서 원격 분석 수집을 시작하려면 1~2분 정도 걸릴 수 있습니다.

Tomcat 로그가 Cloud Logging으로 전송되는지 확인하려면 다음을 수행합니다.

  1. Google Cloud 콘솔에서 로그 탐색기 페이지로 이동합니다.

    로그 탐색기로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Logging인 결과를 선택합니다.

  2. 편집기에 다음 쿼리를 입력한 후 쿼리 실행을 클릭합니다. 
    resource.type="gce_instance"
(log_id("tomcat_system") OR log_id("tomcat_access"))

Tomcat 측정항목이 Cloud Monitoring으로 전송되는지 확인하려면 다음을 수행합니다.

  1. Google Cloud 콘솔에서  측정항목 탐색기 페이지로 이동합니다.

    측정항목 탐색기로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.

  2. 쿼리 빌더 창의 툴바에서 이름이  MQL 또는  MQL인 버튼을 선택합니다.
  3. MQL 전환 버튼에 MQL이 선택되어 있는지 확인합니다. 언어 전환 버튼은 쿼리 형식을 지정할 수 있는 동일한 툴바에 있습니다.
  4. 편집기에 다음 쿼리를 입력한 후 쿼리 실행을 클릭합니다. 
    fetch gce_instance
| metric 'workload.googleapis.com/tomcat.threads'
| every 1m

대시보드 보기

Tomcat 측정항목을 보려면 차트나 대시보드가 구성되어 있어야 합니다. Tomcat 통합에는 대시보드가 하나 이상 포함됩니다. 통합을 구성하고 운영 에이전트가 측정항목 데이터 수집을 시작한 후 모든 대시보드가 자동으로 설치됩니다.

통합을 설치하지 않고도 대시보드의 정적 미리보기를 볼 수 있습니다.

설치된 대시보드를 보려면 다음을 수행합니다.

  1. Google Cloud 콘솔에서  대시보드 페이지로 이동합니다.

    대시보드로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.

  2. 대시보드 목록 탭을 선택한 후 통합 카테고리를 선택합니다.
  3. 확인할 대시보드의 이름을 클릭합니다.

통합을 구성했지만 대시보드가 설치되지 않은 경우 운영 에이전트가 실행 중인지 확인합니다. 대시보드에 차트의 측정항목 데이터가 없으면 대시보드 설치가 실패합니다. 운영 에이전트가 측정항목 수집을 시작하면 대시보드가 자동으로 설치됩니다.

대시보드의 정적 미리보기를 보려면 다음을 수행합니다.

  1. Google Cloud 콘솔에서  통합 페이지로 이동합니다.

    통합으로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.

  2. Compute Engine 배포 플랫폼 필터를 클릭합니다.
  3. Tomcat 항목을 찾고 세부정보 보기를 클릭합니다.
  4. 정적 미리보기를 보려면 대시보드 탭을 선택합니다. 대시보드가 설치되어 있으면 대시보드 보기를 클릭하여 대시보드로 이동할 수 있습니다.

Cloud Monitoring의 대시보드에 대한 자세한 내용은 대시보드 및 차트를 참조하세요.

통합 페이지 사용에 대한 자세한 내용은 통합 관리를 참조하세요.

알림 정책 설치

알림 정책은 지정된 조건이 발생할 때 Cloud Monitoring에서 알림을 받도록 지시합니다. Tomcat 통합에는 사용할 알림 정책이 하나 이상 포함됩니다. Monitoring의 통합 페이지에서 이러한 알림 정책을 보고 설치할 수 있습니다.

사용 가능한 알림 정책에 대한 설명을 보고 설치하려면 다음을 수행합니다.

  1. Google Cloud 콘솔에서  통합 페이지로 이동합니다.

    통합으로 이동

    검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.

  2. Tomcat 항목을 찾고 세부정보 보기를 클릭합니다.
  3. 알림 탭을 선택합니다. 이 탭에는 사용 가능한 알림 정책에 대한 설명과 이를 설치하기 위한 인터페이스가 제공됩니다.
  4. 알림 정책을 설치합니다. 알림 정책은 경고가 트리거되었다는 알림을 전송할 위치를 알아야 하므로, 설치 시 사용자에게 해당 정보를 요청합니다. 알림 정책을 설치하려면 다음을 수행합니다.
    1. 사용 가능한 알림 정책 목록에서 설치할 정책을 선택합니다.

    2. 알림 구성 섹션에서 알림 채널을 하나 이상 선택합니다. 알림 채널 사용을 중지할 수 있지만 사용 중지하면 알림 정책이 자동으로 실행됩니다. Monitoring에서 상태를 확인할 수 있지만 알림이 수신되지 않습니다.

      알림 채널에 대한 자세한 내용은 알림 채널 관리를 참조하세요.

    3. 정책 만들기를 클릭합니다.

Cloud Monitoring의 알림 정책에 대한 자세한 내용은 알림 소개를 참조하세요.

통합 페이지 사용에 대한 자세한 내용은 통합 관리를 참조하세요.

다음 단계

Ansible을 사용하여 운영 에이전트를 설치하고, 서드파티 애플리케이션을 구성하고, 샘플 대시보드를 설치하는 방법은 운영 에이전트를 설치하여 서드파티 애플리케이션 문제 해결 동영상을 참조하세요.