AWS SDK for Java 호출 로깅 - AWS SDK for Java 1.x

다음 버전 AWS SDK for Java (v1) end-of-support 을 발표했습니다. AWS SDK for Java V2로 마이그레이션하실 것을 권장합니다. 마이그레이션 날짜, 추가 세부 정보 및 방법에 대한 자세한 내용은 링크된 공지 사항을 참조하세요.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

AWS SDK for Java 호출 로깅

AWS SDK for Java는 런타임 시 여러 로깅 시스템 중 하나를 활성화하는 추상 계층인 Apache Commons Logging을 사용하여 계측됩니다.

지원되는 로깅 시스템에는 Java Logging Framework와 Apache Log4j 등이 있습니다. 이 주제에서는 Log4j 사용법을 보여줍니다. 애플리케이션 코드를 변경하지 않고 SDK의 로깅 기능을 사용할 수 있습니다.

Log4j에 대해 자세히 알아보려면 Apache 웹 사이트를 참조하십시오.

참고

이 항목에서는 Log4j 1.x에 초점을 맞춰 설명합니다. Log4j2는 Apache Commons Logging을 직접 지원하지 않지만, Apache Commons Logging 인터페이스를 사용하는 Log4j2에 로깅 호출을 자동으로 전달하는 어댑터를 제공합니다. 자세한 내용은 Log4j2 설명서의 Commons Logging Bridge을 참조하십시오.

Log4J JAR 다운로드

SDK에서 Log4j를 사용하려면 Apache 웹 사이트에서 Log4j JAR를 다운로드해야 합니다. SDK에는 이 JAR이 포함되지 않습니다. JAR 파일을 classpath의 위치 중 하나로 복사합니다.

Log4j는 구성 파일인 log4j.properties를 사용합니다. 아래에는 예제 구성 파일이 나와 있습니다. 이 구성 파일을 classpath의 디렉터리 중 하나로 복사합니다. Log4j JAR과 log4j.properties 파일이 동일한 디렉터리 안에 있지 않아도 됩니다.

log4j.properties 구성 파일은 로깅 수준, 로깅 출력이 전송될 대상(예를 들면, 파일 또는 콘솔), 출력 형식 같은 속성을 지정합니다. 로깅 수준은 로거가 생성되는 출력의 세부 수준입니다. Log4j는 여러 로깅 계층의 개념을 지원합니다. 로깅 수준은 각 계층마다 독립적으로 설정됩니다. AWS SDK for Java에서는 다음과 같은 두 가지 로깅 계층을 사용할 수 있습니다.

  • log4j.logger.com.amazonaws

  • log4j.logger.org.apache.http.wire

Classpath 설정

Log4j JAR 및 log4j.properties 파일 둘 다 classpath에 있어야 합니다. Apache Ant를 사용 중인 경우 Ant 파일의 path 요소에서 classpath를 설정합니다. 다음 예제에서는 SDK에 포함된 Amazon S3 예제에 대한 Ant 파일의 경로 요소를 보여줍니다.

<path id="aws.java.sdk.classpath"> <fileset dir="../../third-party" includes="**/*.jar"/> <fileset dir="../../lib" includes="**/*.jar"/> <pathelement location="."/> </path>

Eclipse IDE를 사용 중인 경우 메뉴를 열고 프로젝트 | 속성 | Java Build 경로로 이동하여 classpath를 설정할 수 있습니다.

서비스 관련 오류 및 경고

클라이언트 라이브러리의 중요 메시지를 수집할 수 있도록 항상 "com.amazonaws" 로거 계층을 "WARN"로 설정된 상태로 유지하는 것이 좋습니다. 예를 들어 Amazon S3 클라이언트가 애플리케이션이 InputStream을 올바르게 닫지 않아서 리소스가 누출 중일 수 있음을 감지하는 경우 S3 클라이언트는 경고 메시지를 통해 로그에 보고합니다. 또한 클라이언트에 요청 또는 응답 처리 문제가 발생하는 경우에도 메시지가 기록됩니다.

다음 log4j.properties 파일에서는 rootLogger를 WARN으로 설정하므로 "com.amazonaws"에 있는 모든 로거의 경고 및 오류가 포함됩니다. 또는 com.amazonaws 로거를 WARN으로 명시적으로 설정할 수도 있습니다.

log4j.rootLogger=WARN, A1 log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n # Or you can explicitly enable WARN and ERROR messages for the {AWS} Java clients log4j.logger.com.amazonaws=WARN

요청/응답 요약 로깅

AWS 서비스를 요청할 때마다 고유한 AWS 요청 ID가 생성되는데, 이는 AWS 서비스가 요청을 처리하는 방식에 문제가 발생할 경우 유용합니다. AWS 요청 ID는 실패한 서비스 호출에 대해 SDK의 Exception 객체를 통해 프로그래밍 방식으로 액세스할 수 있으며, “com.amazonaws.request” 로거의 DEBUG 로그 수준을 통해 보고할 수도 있습니다.

다음 log4j.properties 파일에서는 AWS 요청 ID를 포함하여 요청 및 응답 요약을 활성화합니다.

log4j.rootLogger=WARN, A1 log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n # Turn on DEBUG logging in com.amazonaws.request to log # a summary of requests/responses with {AWS} request IDs log4j.logger.com.amazonaws.request=DEBUG

다음은 로그 출력의 예입니다.

2009-12-17 09:53:04,269 [main] DEBUG com.amazonaws.request - Sending Request: POST https://rds.amazonaws.com / Parameters: (MaxRecords: 20, Action: DescribeEngineDefaultParameters, SignatureMethod: HmacSHA256, AWSAccessKeyId: ACCESSKEYID, Version: 2009-10-16, SignatureVersion: 2, Engine: mysql5.1, Timestamp: 2009-12-17T17:53:04.267Z, Signature: q963XH63Lcovl5Rr71APlzlye99rmWwT9DfuQaNznkD, ) 2009-12-17 09:53:04,464 [main] DEBUG com.amazonaws.request - Received successful response: 200, {AWS} Request ID: 694d1242-cee0-c85e-f31f-5dab1ea18bc6 2009-12-17 09:53:04,469 [main] DEBUG com.amazonaws.request - Sending Request: POST https://rds.amazonaws.com / Parameters: (ResetAllParameters: true, Action: ResetDBParameterGroup, SignatureMethod: HmacSHA256, DBParameterGroupName: java-integ-test-param-group-0000000000000, AWSAccessKeyId: ACCESSKEYID, Version: 2009-10-16, SignatureVersion: 2, Timestamp: 2009-12-17T17:53:04.467Z, Signature: 9WcgfPwTobvLVcpyhbrdN7P7l3uH0oviYQ4yZ+TQjsQ=, ) 2009-12-17 09:53:04,646 [main] DEBUG com.amazonaws.request - Received successful response: 200, {AWS} Request ID: 694d1242-cee0-c85e-f31f-5dab1ea18bc6

상세 표시 유선 로깅

경우에 따라 AWS SDK for Java에서 송/수신하는 정확한 요청 및 응답을 확인하는 것이 유용할 수 있습니다. 대량 요청(예: Amazon S3으로 업로드되는 파일)이나 응답을 작성할 때는 애플리케이션이 크게 느려질 수 있으므로 프로덕션 시스템에서는 이 로깅을 활성화하지 않아야 합니다. 이 정보에 정말 액세스해야 하는 경우 Apache 4 로거를 통해 일시적으로 활성화할 수 있습니다. HttpClient org.apache.http.wire 로거에서 DEBUG 수준을 활성화하면 모든 요청 및 응답 데이터에 대한 로깅이 활성화됩니다.

다음 log4j.properties 파일은 Apache HttpClient 4에서 풀 와이어 로깅을 활성화합니다. 이 파일은 애플리케이션 성능에 상당한 영향을 미칠 수 있으므로 일시적으로만 켜야 합니다.

log4j.rootLogger=WARN, A1 log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n # Log all HTTP content (headers, parameters, content, etc) for # all requests and responses. Use caution with this since it can # be very expensive to log such verbose data! log4j.logger.org.apache.http.wire=DEBUG

지연 시간 지표 로깅

문제를 해결하고 어떤 프로세스가 가장 많은 시간이 걸리는지 또는 서버 또는 클라이언트 측에서 더 긴 지연 시간을 가지는지와 같은 지표를 확인하려면 지연 시간 로거가 유용할 수 있습니다. 이 로거를 활성화하려면 com.amazonaws.latency 로거를 DEBUG로 설정합니다.

참고

이 로거는 SDK 지표가 활성화된 경우에만 사용할 수 있습니다. SDK 지표 패키지에 대한 자세한 내용은 AWS SDK for Java를 위한 지표 활성화를 참조하세요.

log4j.rootLogger=WARN, A1 log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n log4j.logger.com.amazonaws.latency=DEBUG

다음은 로그 출력의 예입니다.

com.amazonaws.latency - ServiceName=[{S3}], StatusCode=[200], ServiceEndpoint=[https://list-objects-integ-test-test.s3.amazonaws.com], RequestType=[ListObjectsV2Request], AWSRequestID=[REQUESTID], HttpClientPoolPendingCount=0, RetryCapacityConsumed=0, HttpClientPoolAvailableCount=0, RequestCount=1, HttpClientPoolLeasedCount=0, ResponseProcessingTime=[52.154], ClientExecuteTime=[487.041], HttpClientSendRequestTime=[192.931], HttpRequestTime=[431.652], RequestSigningTime=[0.357], CredentialsRequestTime=[0.011, 0.001], HttpClientReceiveResponseTime=[146.272]