Docs Menu
Docs Home
/ / /
Java 동기화
/

모니터링

이 페이지의 내용

  • 개요
  • 이벤트를 모니터링합니다.
  • 명령 이벤트
  • 서버 검색 및 이벤트 모니터링하기
  • 연결 풀 이벤트
  • JMX로 연결 풀 이벤트를 모니터링합니다.
  • JMX 지원
  • JMX 및 JConsole 예시
  • 분산 추적 시스템에 드라이버를 포함합니다.

이 가이드에서는 MongoDB Java 드라이버에서 모니터링을 설정하고 구성하는 방법을 배울 수 있습니다.

모니터링이란 실행 중인 프로그램이 애플리케이션 혹은 애플리케이션 성능 관리 라이브러리에서 사용하는 데 수행하는 작업에 대한 정보를 가져오는 프로세스입니다.

MongoDB Java 드라이버를 모니터링하면 드라이버의 리소스 사용량과 성능을 파악할 수 있으며, 애플리케이션을 설계하고 디버깅할 때 정보에 입각한 결정을 내리는 데 도움이 될 수 있습니다.

이 가이드에서는 이와 같은 작업을 수행하는 방법애 대해 학습합니다.

이 가이드 는 코드에서 운전자 의 활동에 대한 정보를 사용하는 방법을 보여줍니다. 운전자 에서 이벤트를 기록 하는 방법을 학습 보려면 로깅에 대한 가이드 를 읽어보세요.

이벤트를 모니터링하려면 MongoClient 인스턴스에 리스너를 등록해야 합니다.

이벤트란 실행 중인 프로그램에서 발생하는 작업 모두를 지칭합니다. 드라이버에는 드라이버가 실행 중일 때 발생하는 이벤트의 하위 집합을 수신하는 기능 등이 있습니다.

리스너란 특정 이벤트가 발생했을 때 어떤 작업을 수행하는 클래스를 말합니다. 리스너의 API는 응답할 수 있는 이벤트를 정의합니다.

리스너 클래스의 각 메서드는 특정 이벤트에 대한 응답을 나타냅니다. 각 메서드는 하나의 인수, 즉 메서드가 응답하는 이벤트를 나타내는 객체를 수신합니다.

MongoDB Java 드라이버는 이벤트를 세 가지 카테고리로 정의합니다.

  • 명령 이벤트

  • 서버 검색 및 이벤트 모니터링하기

  • 연결 풀 이벤트

다음 섹션에서는 각 이벤트 카테고리를 모니터링하는 방법에 대해 설명합니다.

모니터링할 수 있는 이벤트의 전체목록 은 MongoDB Java 드라이버의 이벤트 패키지를 참조하세요.

명령 이벤트는 MongoDB 데이터베이스 명령어와 관련된 이벤트입니다. 명령 이벤트를 생성하는 데이터베이스 명령어의 몇 가지 예에는 find, insert, delete, count 등이 있습니다.

명령 이벤트를 모니터링하려면 CommandListener 인터페이스를 구현하는 클래스를 작성하고 해당 클래스의 인스턴스를 MongoClient 인스턴스에 등록합니다.

MongoDB database 명령에 대한 자세한 내용은 데이터베이스 명령에 대한 MongoDB 매뉴얼 항목을 참조하세요.

참고

내부 명령어

드라이버는 내부적으로 호출하는 명령어에 대한 이벤트를 게시하지 않습니다. 여기에는 드라이버가 클러스터를 모니터링하는 데 사용하는 데이터베이스 명령어와 연결 설정과 관련된 명령(예: 초기 hello 명령) 등이 있습니다.

중요

수정된 출력

보안 조치로 드라이버는 일부 명령 이벤트의 내용을 수정합니다. 이렇게 하면 이러한 명령 이벤트에 포함된 민감한 정보를 보호할 수 있습니다. 수정된 명령 이벤트의 전체 목록은 MongoDB 명령 로깅 및 모니터링 사양을 참조하세요.

이러한 예는 데이터베이스 명령어에 대한 카운터를 생성하는 방법을 보여줍니다. 카운터는 드라이버가 각 데이터베이스 명령어를 성공적으로 실행한 횟수를 추적하고 데이터베이스 명령어가 완료될 때마다 이러한 정보를 인쇄합니다.

카운터를 생성하려면 다음과 같이 실행합니다.

  1. 인터페이스를 구현하는 카운터 기능이 있는 클래스를 생성합니다.CommandListener

  2. CommandListener 구현하는 새로운 클래스의 인스턴스를 MongoClientSettings 객체에 추가합니다.

  3. MongoClientSettings 객체를 사용하여 MongoClient 인스턴스를 구성합니다.

다음 코드는 CommandListener 인터페이스를 구현하는 CommandCounter 클래스를 정의합니다.

class CommandCounter implements CommandListener {
private Map<String, Integer> commands = new HashMap<String, Integer>();
@Override
public synchronized void commandSucceeded(final CommandSucceededEvent event) {
String commandName = event.getCommandName();
int count = commands.containsKey(commandName) ? commands.get(commandName) : 0;
commands.put(commandName, count + 1);
System.out.println(commands.toString());
}
@Override
public void commandFailed(final CommandFailedEvent event) {
System.out.println(String.format("Failed execution of command '%s' with id %s",
event.getCommandName(),
event.getRequestId()));
}
}

다음 코드는 CommandCounter 클래스의 인스턴스를 MongoClientSettings 객체에 추가하고, MongoClientSettings 객체로 MongoClient 인스턴스를 구성합니다. 그런 다음 이 코드는 몇 가지 데이터베이스 명령어를 실행하여 카운터를 테스트합니다.

MongoClientSettings settings =
MongoClientSettings.builder()
.applyConnectionString(URI)
.addCommandListener(new CommandCounter())
.build();
MongoClient mongoClient = MongoClients.create(settings);
MongoDatabase database = mongoClient.getDatabase(DATABASE);
MongoCollection<Document> collection = database.getCollection(COLLECTION);
// Run some commands to test the timer
collection.find().first();
collection.find().first();
mongoClient.close();

앞의 코드 스니펫은 다음과 같은 출력을 생성해야 합니다.

{find=1}
{find=2}
{find=2, endSessions=1}

이 섹션에 언급된 클래스 및 메서드에 대한 자세한 내용은 다음 API 설명서를 참조하세요.

서버 검색 및 모니터링(SDAM) 이벤트란 드라이버를 연결한 MongoDB 인스턴스 혹은 클러스터의 상태 변경과 관련된 이벤트를 말합니다.

드라이버는 SDAM 이벤트 9개를 정의합니다. 드라이버는 이러한 이벤트 9개를 개별 리스너 인터페이스 3개로 나누고, 각 인터페이스는 이벤트 9개 중 이벤트 3개를 수신합니다. 다음은 인터페이스 3개와 해당 인터페이스가 수신하는 이벤트입니다.

  • ClusterListener: 토폴로지 관련 이벤트

  • ServerListenermongod 혹은 mongos 프로세스와 관련된 이벤트

  • ServerMonitorListener하트비트 관련 이벤트

SDAM 이벤트 유형을 모니터링하려면 위의 인터페이스 3개 중 하나를 구현하는 클래스를 작성하고 해당 클래스의 인스턴스를 MongoClient 인스턴스에 등록합니다.

드라이버의 각 SDAM 이벤트에 대한 자세한 설명은 MongoDB SDAM 로깅 및 모니터링 사양을 참조하세요.

참고

로드 밸런싱 모드

운전자 는 로드 밸런싱 모드 에 있을 때 하트비트 관련 이벤트를 방출하지 않습니다. 로드 밸런싱이 있는 SDAM 이벤트에 대한 자세한 내용은 MongoDB 로드 밸런서 지원 사양을 참조하세요.

이러한 예시는 드라이버가 MongoDB 인스턴스에 쓸 수 있는지 여부를 알려주는 메시지를 출력하는 리스너 클래스를 생성하는 방법을 설명합니다.

다음 코드는 ClusterListener 인터페이스를 구현하는 IsWritable 클래스를 정의합니다.

class IsWriteable implements ClusterListener {
private boolean isWritable;
@Override
public synchronized void clusterDescriptionChanged(final ClusterDescriptionChangedEvent event) {
if (!isWritable) {
if (event.getNewDescription().hasWritableServer()) {
isWritable = true;
System.out.println("Able to write to server");
}
} else {
if (!event.getNewDescription().hasWritableServer()) {
isWritable = false;
System.out.println("Unable to write to server");
}
}
}
}

다음 코드는 IsWritable 클래스의 인스턴스를 MongoClient 객체에 추가합니다. 그런 다음 이 코드는 IsWritable 클래스를 테스트하기 위해 find 작업을 실행합니다.

IsWriteable clusterListener = new IsWriteable();
MongoClientSettings settings =
MongoClientSettings.builder()
.applyConnectionString(URI)
.applyToClusterSettings(builder ->
builder.addClusterListener(clusterListener))
.build();
MongoClient mongoClient = MongoClients.create(settings);
MongoDatabase database = mongoClient.getDatabase(DATABASE);
MongoCollection<Document> collection = database.getCollection(COLLECTION);
// Run a command to trigger a ClusterDescriptionChangedEvent event
collection.find().first();

앞의 코드 스니펫은 다음과 같은 출력을 생성해야 합니다.

Able to write to server

이 섹션에 언급된 클래스 및 메서드에 대한 자세한 내용은 다음 API 설명서를 참조하세요.

연결 풀 이벤트는 드라이버의 연결 풀과 관련된 이벤트입니다. 연결 풀은 드라이버가 MongoDB 인스턴스를 사용하여 유지 관리하는 개방형 TCP 연결입니다. 연결 풀은 애플리케이션이 MongoDB 인스턴스로 수행해야 하는 네트워크 핸드셰이크 횟수를 줄이고 애플리케이션을 좀 더 빠르게 실행하는 데 유용합니다.

연결 풀 이벤트를 모니터링하려면 ConnectionPoolListener 인터페이스를 구현하는 클래스를 작성하고 해당 클래스의 인스턴스를 MongoClient 인스턴스에 등록합니다.

이 예시에서는 연결 풀에서 연결을 체크아웃할 때마다 메시지를 인쇄하는 리스너 클래스를 생성하는 방법을 설명합니다.

다음 코드는 ConnectionPoolListener 인터페이스를 구현하는 ConnectionPoolLibrarian 클래스를 정의합니다.

class ConnectionPoolLibrarian implements ConnectionPoolListener {
@Override
public void connectionCheckedOut(final ConnectionCheckedOutEvent event) {
System.out.println(String.format("Let me get you the connection with id %s...",
event.getConnectionId().getLocalValue()));
}
@Override
public void connectionCheckOutFailed(final ConnectionCheckOutFailedEvent event) {
System.out.println("Something went wrong! Failed to checkout connection.");
}
}

다음 코드는 ConnectionPoolLibrarian 클래스의 인스턴스를 MongoClient 객체에 추가합니다. 그런 다음 이 코드는 데이터베이스 명령어를 실행하여 라이브러리를 테스트합니다.

ConnectionPoolLibrarian cpListener = new ConnectionPoolLibrarian();
MongoClientSettings settings =
MongoClientSettings.builder()
.applyConnectionString(URI)
.applyToConnectionPoolSettings(builder ->
builder.addConnectionPoolListener(cpListener))
.build();
MongoClient mongoClient = MongoClients.create(settings);
MongoDatabase database = mongoClient.getDatabase(DATABASE);
MongoCollection<Document> collection = database.getCollection(COLLECTION);
// Run a command to trigger connection pool events
collection.find().first();

앞의 코드 스니펫은 다음과 같은 출력을 생성해야 합니다.

Let me get you the connection with id 21...

이 섹션에 언급된 클래스 및 메서드에 대한 자세한 내용은 다음 API 설명서를 참조하세요.

Java Management Extensions (JMX) 사용하여 연결 풀 이벤트를 모니터링할 수 있습니다. JMX는 툴을 제공하여 애플리케이션과 기기를 모니터링합니다.

JMX에 대한 자세한 내용 은 공식 Oracle JMX 설명서를 참조하세요.

JMX 연결 풀 모니터링을 활성화하려면 JMXConnectionPoolListener 클래스의 인스턴스를 MongoClient 객체에 추가합니다.

JMXConnectionPoolListener 클래스는 다음과 같은 작업을 수행합니다.

  1. 드라이버가 연결 풀을 유지 관리하는 각 mongod 혹은 mongos 프로세스에 대해 MXBean 인스턴스를 생성합니다.

  2. 이러한 MXBean 인스턴스를 플랫폼 MBean 서버에 등록합니다.

플랫폼 MBean 서버에 등록된 MXBean은 다음과 같은 속성이 있습니다.

속성
설명
clusterId
클라이언트에서 생성한 고유 식별자 식별자는 애플리케이션에 동일한 MongoDB deployment에 연결된 MongoClient 인스턴스가 여러 개 있을 경우 드라이버가 만드는 각 MXBean이 고유한 이름을 갖도록 합니다.
host
mongod 혹은 mongos 프로세스를 실행하는 컴퓨터의 호스트 이름
port
mongod 혹은 mongos 프로세스가 수신 대기 중인 포트
minSize
유휴 연결 및 사용 중인 연결 등 연결 풀의 최소 크기
maxSize
유휴 연결 및 사용 중인 연결 등 연결 풀의 최대 크기
size
유휴 연결 및 사용 중인 연결 등 연결 풀의 현재 크기
checkedOutCount
사용 중인 연결의 현재 개수

드라이버로 생성된 MXBean 인스턴스는 모두 "org.mongodb.driver" 도메인 아래에 있습니다.

이러한 하위 섹션에서 논의된 주제에 대한 자세한 내용은 Oracle의 다음 리소스를 참조합니다.

이 예에서는 JMX 및 JConsole을 사용하여 드라이버의 연결 풀을 모니터링할 수 있는 방법을 보여줍니다. JConsole은 Java 플랫폼과 함께 제공되는 JMX 호환 GUI 모니터링 도구입니다.

공식 JMX 및 JConsole 문서를 참조하세요.

이 예시의 JMX 및 JConsole에 대한 설명은 사실에 근거한 것이 아니라 예시입니다. 최신 정보를 확인하려면 다음 공식 Oracle 리소스를 참조하세요.

다음 코드 스니펫은 MongoClient 인스턴스에 JMXConnectionPoolListener를 추가합니다. 그런 다음 코드는 실행을 일시 중지하므로 JConsole로 이동하여 연결 풀을 검사할 수 있습니다.

JMXConnectionPoolListener connectionPoolListener = new JMXConnectionPoolListener();
MongoClientSettings settings =
MongoClientSettings.builder()
.applyConnectionString(URI)
.applyToConnectionPoolSettings(builder -> builder.addConnectionPoolListener(connectionPoolListener))
.build();
// Creates a MongoClient instance that enables connection pool event monitoring with the JMX tool
MongoClient mongoClient = MongoClients.create(settings);
try {
System.out.println("Navigate to JConsole to see your connection pools...");
// Pauses the code execution so you can navigate to JConsole and inspect your connection pools
Thread.sleep(Long.MAX_VALUE);
// Prints exception details if any exceptions occur during the code execution
} catch (Exception e) {
e.printStackTrace();
}

앞의 코드 스니펫은 다음과 같은 출력을 생성해야 합니다.

Navigate to JConsole to see your connection pools...

서버를 시작한 후 다음 명령을 사용하여 터미널에서 JConsole을 엽니다.

jconsole

JConsole이 열리면 GUI에서 다음 작업을 수행합니다.

  1. 앞의 예시 코드를 실행하는 Java 프로세스를 선택합니다.

  2. 경고 대화 상자에서 Insecure Connection을 누릅니다.

  3. MBeans 탭을 클릭합니다.

  4. "org.mongodb.driver" 도메인에서 연결 풀 이벤트를 검사합니다.

JConsole에서 연결 풀을 더 이상 검사하지 않으려면 다음을 수행합니다.

  • JConsole 창을 닫아 JConsole을 종료합니다.

  • 앞의 코드 스니펫을 실행하는 Java 프로그램을 중지합니다.

JMX 및 JConsole에 대한 자세한 내용은 Oracle에서 제공하는 다음 리소스를 참조하세요.

클래스에대한 JMXConnectionPoolListener 자세한 내용은 JMXConnectionPoolListener에 대한 API 설명서를 참조하세요.

분산 추적 시스템을 사용하는 경우 드라이버의 이벤트 데이터를 포함할 수 있습니다. 분산 추적 시스템은 서비스 지향 아키텍처에서 여러 서비스에 걸쳐 전달되는 요청을 추적하는 애플리케이션입니다.

Spring Cloud 에서 드라이버를 사용하는 경우 Spring Cloud Sleuth 사용 MongoDB 이벤트 데이터를 Zipkin 에 포함합니다. 분산 추적 시스템.

Spring Cloud를 사용하지 않거나 Zipkin 이외의 분산 추적 시스템에 드라이버 이벤트 데이터를 포함해야 하는 경우, 원하는 분산 추적 시스템에 대해 범위를 관리하는 명령 이벤트 리스너를 작성해야 합니다. 이러한 리스너의 구현을 보려면 Spring Cloud Sleuth 소스 코드의 TraceMongoCommandListener 클래스를 참조하세요.

Spring Cloud Sleuth에 대해 자세히 알아보려면 Spring Cloud Sleuth 문서에서 시작하기를 참조하세요.

분산 추적 시스템에 대한 자세한 설명은 Google Research의 Dapper를 참조하세요.

돌아가기

로깅