Java 에이전트의 문맥적 로그

이것은 가장 간단한 접근 방식이며, 로그 전달자 설정에 대한 액세스 권한이나 관심이 없는 개발자 또는 앱 컨텍스트에서 로그 및 기타 연결 메타데이터의 힘을 확인하려는 계정에 탁월한 선택입니다. 많은 오버 헤드.

이 옵션을 사용하여 에이전트는 span.id , trace.id , hostname , entity.guid 및 entity.name 를 추가합니다. 로그 전달 제한에 대해 알아보세요.

이 기능은 기본적으로 활성화되어 있습니다.

로그 전달 기능이 있는 에이전트 버전(Java 에이전트 7.6.0 이상)을 설치하기만 하면 됩니다. 전달 기능이 비활성화된 경우 다음 구성을 사용할 수 있습니다.

구성 파일(newrelic.yml), 공통 섹션 아래에 공백 2칸 들여쓰기:

application_logging:
  enabled: true
  forwarding:
    enabled: true
    max_samples_stored: 10000 
  local_decorating: 
    enabled: false

환경 변수:

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED=10000
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=false

시스템 속성:

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=true
-Dnewrelic.config.application_logging.forwarding.max_samples_stored=10000
-Dnewrelic.config.application_logging.local_decorating.enabled=false

Optional adjustments (max_samples_stored):

이 기능이 활성화되면 매분 New Relic에 전송되는 최대 로그 줄 수를 제어할 수 있습니다. 기본값은 10,000입니다. 에이전트가 60초 동안 10,000개 이상의 로그 라인을 본 경우 로그 샘플링이 시작됩니다.

더 많은 로그를 수신하려면 더 높은 숫자로 설정하십시오. 더 적은 수의 로그를 수신하려면 더 낮은 숫자로 설정하십시오. 음이 아닌 모든 정수가 유효합니다.

구성 파일( newrelic.yml ):

application_logging:
  enabled: true
  forwarding:
    enabled: true
    max_samples_stored: 10000
  local_decorating: 
    enabled: false

환경 변수:

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED=10000
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=false

시스템 속성:

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=true
-Dnewrelic.config.application_logging.forwarding.max_samples_stored=10000
-Dnewrelic.config.application_logging.local_decorating.enabled=false

이미 마음에 드는 로그 포워더가 있습니까? 우리는 당신을 덮었습니다! Java 에이전트는 자동 로그인 컨텍스트 기능에 대한 액세스를 제공하는 데 필요한 연결 메타데이터로 로그를 장식할 수 있으며 수동 로그 전달기를 사용하여 이를 New Relic으로 보낼 수 있습니다.

에이전트 구성을 업데이트하여 로그 전달을 비활성화하고 로컬 장식을 활성화한 다음 에이전트를 다시 시작하여 로그 장식을 시작하세요.

구성 파일(newrelic.yml), 공통 섹션 아래에 공백 2칸 들여쓰기:

application_logging:
  enabled: true
  local_decorating: 
    enabled: true
  forwarding:
    enabled: false

환경 변수:

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=false

시스템 속성:

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.local_decorating.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=false

우리의 데코레이터는 애플리케이션 로그 파일의 모든 로그 메시지에 entity.guid , hostname , trace.id , span.id 및 entity.name 5가지 속성을 추가합니다. 예시:

This is my log message. NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|

로그가 트랜잭션 외부에서 발생했거나 애플리케이션 컨텍스트에 적용할 수 없는 경우 일부 속성은 비어 있을 수 있습니다.

Java 에이전트와 관련된 로그용 Dropwizard 확장을 제공합니다. 시작하려면 GitHub에서 코드 와 예제 애플리케이션 을 검토하세요.

DropWizard 확장을 사용하여 Java 앱에 대한 컨텍스트에서 로그를 구성하려면:

1. Dropwizard 1.3 이상 패키지가 설치되어 있고 응용 프로그램에서 작동하는지 확인하십시오. 원래 Dropwizard 어펜더와 로깅 팩토리가 설치되어 애플리케이션에서 작동하는 것을 사용하십시오.

2. 애플리케이션에 New Relic Java 에이전트 버전 5.6.0 이상이 설치되어 있고 JVM 인수 -javaagent 가 활성화되어 있는지 확인하십시오.

3. 해당하는 경우 Dropwizard 1.3 확장을 포함하도록 프로젝트의 종속성을 업데이트합니다.

   Gradle: build.gradle 파일에 다음을 추가합니다.

   dependencies {
     implementation("com.newrelic.logging:dropwizard:2.0")
   }

   카피

   Maven: pom.xml 파일에 다음을 추가합니다.

   <dependencies>
     <dependency>
       <groupId>com.newrelic.logging</groupId>
       <artifactId>dropwizard</artifactId>
       <version>2.0</version>
     </dependency>
   </dependencies>

   카피

4. Dropwizard .yaml 구성 파일을 newrelic-json 레이아웃으로 업데이트하여 현재 사용 중인 type: console 또는 type: file 를 type: newrelic-console 또는 type: newrelic-file 로 적절하게 바꾸십시오. 예를 들어:

   logging:
     appenders:
       - type: newrelic-console
         # Add the two lines below if you don't have a layout specified on the appender.
         # If you have a layout, remove all parameters to the layout and set the type.
         layout:
           type: newrelic-json

   카피

   New Relic Dropwizard 확장은 표준 Dropwizard 로깅을 사용하는 log-format 레이아웃 유형도 지원합니다. 테스트 목적으로 한 줄 변경으로 레이아웃 유형을 변경할 수 있습니다.

   logging:
     appenders:
       - type: newrelic-file
         # This format will be ignored by the newrelic-json layout, but used by the log-format layout.
         logFormat: "%date{ISO8601} %c %-5p: %m trace.id=%mdc{trace.id} span.id=%mdc{span.id}%n"
         layout:
           # type: newrelic-json
           type: log-format

   카피

Java 에이전트 컨텍스트에서 로그에 대한 java.util.logging 확장을 제공합니다. 시작하려면 GitHub에서 코드 와 예제 애플리케이션 을 검토하세요.

java.util.logging 확장자를 사용하여 자바 앱의 컨텍스트에서 로그를 구성하려면 다음을 수행합니다.

1. java.util.logging 패키지가 설치되어 있고 애플리케이션에서 작동하는지 확인하세요.

2. 애플리케이션에 New Relic Java 에이전트 버전 5.6.0 이상이 설치되어 있고 JVM 인수 -javaagent 가 활성화되어 있는지 확인하십시오.

3. 해당하는 경우 java.util.logging 확장을 포함하도록 프로젝트의 종속성을 업데이트합니다. 이러한 파일을 편집할 수 없는 경우 대신 jar를 애플리케이션 classpath 에 직접 추가 할 수 있습니다.

   Gradle: build.gradle 파일에 다음을 추가합니다.

   dependencies {
     implementation("com.newrelic.logging:jul:2.0")
   }

   카피

   Maven: pom.xml 파일에 다음을 추가합니다.

   <dependencies>
     <dependency>
       <groupId>com.newrelic.logging</groupId>
       <artifactId>jul</artifactId>
       <version>2.0</version>
     </dependency>
   </dependencies>

   카피

4. 로깅 파일의 handlers 속성이 NewRelicMemoryHandler 이외의 것으로 설정되어 있는지 확인하십시오. 다음과 같이 루트 로거의 핸들러를 나열하는 행을 찾으십시오.

   handlers = java.util.logging.FileHandler

   카피

5. 루트 로거의 핸들러를 NewRelicMemoryHandler 으로 설정하도록 로깅 속성 파일을 업데이트하여 다른 핸들러로 향하는 메시지를 가로챕니다.

   handlers = com.newrelic.logging.jul.NewRelicMemoryHandler

   카피

6. 대상을 이전에 루트 로거에 할당된 핸들러로 설정하여 NewRelicMemoryHandler 을 구성하여 로그 메시지가 나오는 스레드에서 New Relic이 필요로 하는 데이터를 캡처합니다.

   com.newrelic.logging.jul.NewRelicMemoryHandler.target = java.util.logging.FileHandler

   카피

7. 최종 핸들러에 NewRelicFormatter 을 사용합니다. 다음 예와 같이 formatter 속성을 설정하도록 로깅 속성 파일을 업데이트합니다. 포맷터를 설정한 핸들러가 이전 단계의 target 핸들러인지 확인하십시오(이 예에서는 java.util.logging.FileHandler ).

   java.util.logging.FileHandler.formatter = com.newrelic.logging.jul. NewRelicFormatter

   카피

   New Relic 로그 형식은 트랜잭션과 로그를 함께 연관시키는 데 사용하는 원격 측정 메타데이터가 포함된 JSON입니다. 현재 우리는 해당 형식의 사용자 정의를 지원하지 않습니다.

   완료되면 텍스트 대신 JSON이 기록됩니다. JSON은 한 줄에 하나씩 단일 개체로 형식이 지정되어야 하며 log.level 및 thread.name 같은 필드를 포함해야 합니다. 컨텍스트의 로그에 필요한 trace.id 에는 트랜잭션 내에서 발생하는 로그 메시지에 대한 값만 있어야 합니다.

Logs-in-context 확장을 가져오는 가장 직접적인 방법은 이러한 종속성을 Maven의 pom.xml 또는 Gradle의 build.gradle 에 추가하는 것입니다. 이를 통해 패키징 도구가 올바른 종속성을 선택할 수 있습니다.

이러한 파일을 편집할 수 없는 경우 대신 로깅 프레임워크의 구성을 위해 애플리케이션 classpath 에 jar를 직접 추가할 수 있습니다.

클래스 경로를 수정하기 전에:

1. 앱의 Java 에이전트에서 JVM 인수 -javaagent 를 활성화합니다.
2. 애플리케이션이 사용 중인 로깅 프레임워크를 확인하십시오.
3. 로깅 프레임워크의 구성을 변경할 수 있는지 확인하십시오.
4. 다음 세 개의 jar가 아직 없는 경우 클래스 경로에 추가하십시오. 일반적으로 Maven Central에 게시된 최신 버전을 사용하는 것이 좋습니다.

• 그룹 ID com.newrelic.logging 및 아티팩트 ID: Maven에서 애플리케이션의 로깅 프레임워크 이름을 따서 명명된 아티팩트를 선택합니다.
• 그룹 ID com.fasterxml.jackson.core 및 아티팩트 ID: jackson-core 사용
• 그룹 ID com.newrelic.agent.java 및 아티팩트 ID: newrelic-api 사용

Java 에이전트와 관련된 수동 로그용 Log4j 1.x 확장을 제공합니다. 시작하려면 GitHub에서 코드 와 예제 애플리케이션 을 검토하세요.

Log4j 1.x 확장을 사용하여 Java 앱의 컨텍스트에서 수동 로그를 구성하려면 코드에서 또는 XML을 통해 Log4j 확장을 구성해야 합니다. AsyncAppender 인스턴스는 XML을 통해서만 자동으로 구성할 수 있으므로 속성 파일은 지원되지 않습니다.

1. Log4j 1.x 패키지가 설치되어 있고 애플리케이션에서 작동하는지 확인하십시오.

2. 애플리케이션에 New Relic Java 에이전트 버전 5.6.0 이상이 설치되어 있고 JVM 인수 -javaagent 가 활성화되어 있는지 확인하십시오.

3. 해당하는 경우 Log4j 1.x 확장을 포함하도록 프로젝트의 종속성을 업데이트합니다.

   Gradle: build.gradle 파일에 다음을 추가합니다.

   dependencies {
     implementation("com.newrelic.logging:log4j1:2.0")
   }

   카피

   Maven: pom.xml 파일에 다음을 추가합니다.

   <dependencies>
     <dependency>
       <groupId>com.newrelic.logging</groupId>
       <artifactId>log4j1</artifactId>
       <version>2.0</version>
     </dependency>
   </dependencies>

   카피

4. 로깅 구성 XML 파일에서 <appender> 요소를 NewRelicLayout 로 업데이트하고 <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/> 를 추가합니다.

   <appender name="TypicalFile" class="org.apache.log4j.FileAppender">
     <param name="file" value="logs/log4j1-app.log"/>
     <param name="append" value="false"/>
     <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/> <!-- only this line needs to be added -->
   </appender>

   카피

5. NewRelicAsyncAppender 을 사용하여 New Relic의 로그 전달자를 대상으로 하는 모든 어펜더를 래핑합니다. 예를 들어:

   <appender name="NewRelicFile" 
             class="com.newrelic.logging.log4j1.NewRelicAsyncAppender">
     <appender-ref ref="TypicalFile" />
   </appender>

   카피

6. 루트 로거에서 async appender를 사용하십시오. 예를 들어:

   <root>
     <appender-ref ref="NewRelicFile" />
   </root>

   카피

   Example configuration file for the Log4j 1.x extension:

   <?xml version="1.0" encoding="UTF-8" ?>
   <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
   <log4j:configuration debug="false">
     <appender name="TypicalFile" class="org.apache.log4j.FileAppender">
       <param name="file" value="logs/log4j1-app.log"/>
       <param name="append" value="false"/>
       <!-- layout has been replaced -->
       <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/>
     </appender>
   
       <!-- this appender was added -->
     <appender name="NewRelicFile" 
               class="com.newrelic.logging.log4j1.NewRelicAsyncAppender">
       <appender-ref ref="TypicalFile" />
     </appender>
   
     <appender name="TypicalConsole" class="org.apache.log4j.ConsoleAppender">
       <layout class="org.apache.log4j.PatternLayout"> 
         <param name="ConversionPattern" value="%-5p %c{1} - %m%n"/> 
       </layout> 
     </appender>
   
     <root>        ​
       <!-- the new appender was used here -->​​
       <appender-ref ref="NewRelicFile" />
       <appender-ref ref="TypicalConsole" />
     </root>
   
   </log4j:configuration>

   카피

우리는 현재 에이전트와 관련하여 로그를 위한 Log4j 2.x 확장을 제공합니다. 시작하려면 GitHub에서 코드 와 예제 애플리케이션을 검토하세요.

Log4j 2.x 확장을 사용하여 Java 앱의 컨텍스트에서 로그를 구성하려면:

1. Log4j 2.13.2 이상 또는 Logs4j 2 바인딩 패키지가 설치되어 있고 애플리케이션에서 작동하는지 확인하십시오.

2. 애플리케이션에 New Relic Java 에이전트 버전 5.6.0 이상이 설치되어 있고 JVM 인수 -javaagent 가 활성화되어 있는지 확인하십시오.

3. 해당하는 경우 Log4j 2.x 확장을 포함하도록 프로젝트의 종속성을 업데이트합니다.

   Gradle: 강조표시된 섹션을 build.gradle 파일에 추가합니다.

   dependencies {
     implementation("com.newrelic.logging:log4j2:2.0")
   }

   카피

   Maven: 강조표시된 섹션을 pom.xml 파일에 추가합니다.

   <dependencies>
     <dependency>
       <groupId>com.newrelic.logging</groupId>
       <artifactId>log4j2</artifactId>
       <version>2.0</version>
     </dependency>
   </dependencies>

   카피

4. 로깅 구성 XML 파일에서 강조 표시된 섹션을 추가하여 <configuration> 요소를 업데이트합니다.

   <Configuration xmlns="http://logging.apache.org/log4j/2.0/config"
         packages="com.newrelic.logging.log4j2"
   >

   카피

   속성 파일을 사용하는 경우 packages=com.newrelic.logging.log4j2 을 추가합니다.

5. 어펜더 중 하나 내에서 NewRelicLayout 요소를 사용하려면 <NewRelicLayout/> 을 추가합니다. 예를 들어:

   <File name="MyFile" fileName="logs/app-log-file.log">
     <NewRelicLayout/>
   </File>

   카피

   속성 파일을 사용하는 경우 layout.type 만 변경합니다.

   appender.console.type = Console
   appender.console.name = STDOUT
   appender.console.layout.type = NewRelicLayout

   카피

6. 기존 어펜더만 수정한 경우 이 단계를 건너뜁니다. 새 appender를 추가한 경우 이 appender를 사용하려면 <Root> <AppenderRef/> 를 추가하세요. ref 속성을 사용하여 이전 단계에서 생성한 appender name 를 참조하십시오. 예를 들어:

   <Root level="info">
     <AppenderRef ref="MyFile"/>
   </Root>

   카피

   속성 파일을 사용 중이고 새 appender를 추가한 경우 다음을 추가하세요.

   rootLogger.level = info
   rootLogger.appenderRef.stdout.ref = STDOUT

   카피

Java 에이전트와 관련된 로그에 대한 Logback 확장을 제공합니다. 시작하려면 GitHub에서 코드 와 예제 애플리케이션 을 검토하세요.

Logback을 사용하여 Java 앱의 컨텍스트에서 로그를 구성하려면:

1. Logback 버전 1.2.0 이상 과 New Relic Java 에이전트 버전 5.6.0 이상이 설치되어 있고 애플리케이션에서 작동하는지 확인하십시오.

2. 애플리케이션에 New Relic Java 에이전트 버전 5.6.0 이상이 설치되어 있고 JVM 인수 -javaagent 가 활성화되어 있는지 확인하십시오.

3. 해당하는 경우 Logback 확장을 포함하도록 프로젝트의 종속성을 업데이트합니다.

   Gradle: 강조표시된 섹션을 build.gradle 파일에 추가합니다.

   dependencies {
     implementation("com.newrelic.logging:logback:2.0")
   }

   카피

   Maven: 강조표시된 섹션을 pom.xml 파일에 추가합니다.

   <dependencies>
     <dependency>
       <groupId>com.newrelic.logging</groupId>
       <artifactId>logback</artifactId>
       <version>2.0</version>
     </dependency>
   </dependencies>

   카피

4. 기존 <encoder> 요소를 교체하려면 로깅 구성 xml 을 업데이트하십시오.

   콘솔( stdout/stderr )에 로그인하는 경우 ConsoleAppender 을 찾아 다음으로 바꿉니다.

   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
     <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   </appender>

   카피

   파일에 로깅하는 경우 FileAppender 을 찾아 <encoder> 로 바꿉니다.

   <appender name="LOG_FILE" class="ch.qos.logback.core.FileAppender">
     <file>logs/app-log-file.log</file>
     <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   </appender>

   카피

5. NewRelicAsyncAppender 로 로깅 구성 xml 을 업데이트합니다. NewRelicAsyncAppender 가 New Relic의 로그 전달자를 대상으로 하는 모든 어펜더를 래핑하도록 하려면 다음 섹션을 추가하세요. "LOG_FILE" 을 이전 단계에서 업데이트한 어펜더의 이름으로 변경합니다.

   <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
     <appender-ref ref="LOG_FILE" />
   </appender>

   카피

6. NewRelicAsyncAppender 이 로거에서 사용되는 첫 번째 어펜더인지 확인하세요. 루트 로거의 어펜더를 이전 단계에서 생성한 ASYNC 어펜더로 바꾸세요. 그런 다음 <root> 목록의 NewRelicAsyncAppender 뒤에 다른 어펜더를 나열합니다.

   <root>
     <appender-ref ref="ASYNC" />
   </root>

   카피

   다음은 Logback 확장에 대한 업데이트된 로깅 .xml 파일의 예입니다. GitHub 에서 작업 예제를 볼 수도 있습니다.

   Single console appender example

   로깅 확장 정보를 추가한 후 구성 파일의 예:

   <configuration>
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
   
       <!-- changed the encoder -->
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   
     </appender>
   
     <!-- added the ASYNC appender -->
     <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="STDOUT" />
     </appender>
   
     <root level="debug">
   
       <!-- changed the root logger -->
       <appender-ref ref="ASYNC" /> 
   
     </root>
   </configuration>

   카피

   Two console appenders example

   이 예는 New Relic 로깅을 파일로 보내지만 여전히 표준 로깅을 콘솔로 보냅니다.

   <configuration>
     <appender name="FILE" class="ch.qos.logback.core.FileAppender">
       <file>myApp.log</file>
       <!-- encoder changed -->
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
     </appender>
   
     <!-- this appender does normal console logging -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <encoder>
         <pattern>%msg%n</pattern>
       </encoder>
     </appender>
   
     <!-- The required New Relic ASYNC appender wraps the FILE appender -->
     <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="FILE" /> 
     </appender>
   
     <root level="debug">
       <!-- ASYNC is one of the main appenders -->
       <appender-ref ref="ASYNC" /> 
   
       <!-- Send every message to normal console logging, as well. -->
       <appender-ref ref="STDOUT" />
     </root>
   </configuration>

   카피

현재 버전의 Spring 및 Spring Boot 에 대한 확장을 제공합니다. 로깅 라이브러리를 이미 알고 있다면 해당 문서로 바로 건너뛸 수 있습니다.

• java.util.logging

• 로그4j 1

• log4j 2

• 로그백

  확장은 Spring Boot 2.0 이상에서만 기본 구성을 지원합니다.

  With Spring Boot:

  다음은 보유하고 있는 로깅 라이브러리를 결정하는 팁입니다.

• 의존성/종속성에 spring-boot-starter-log4j2 있으면 log4j 2.x 사용하고 있는 것입니다. 기본 설정은 Spring Boot log4j 2.x 문서를 참조하고, 설정 사용자 정의는 뉴렐릭 log4j 2 확장을 참조하세요.

• Spring Boot를 사용하지만 starter-log4j2 을 사용 하지 않는 경우 기본적으로 logback 사용하게 됩니다. 기본 설정은 Spring Boot 로그백 문서를 참조하고, 설정 사용자 정의는 뉴렐릭 로그백 확장을 참조하세요.

  With Spring (but not Spring Boot):

  스프링 5 이상:

  Spring은 자동으로 찾을 다른 로깅 라이브러리에 대한 브리지 를 구현합니다. 그러나 이러한 개별 라이브러리를 구성하고 프로젝트 종속성에 명시적으로 포함해야 합니다.

  로깅 종속성을 식별하려면 Gradle , Maven 또는 기타 빌드 도구의 종속성 트리를 참조하세요. 그런 다음 절차에 따라 해당 확장을 사용하는 Java 앱의 컨텍스트에서 로그를 구성합니다.

  스프링 4 이하:

  Spring 버전 4 이하에서는 브리지에 Apache Commons Logging 을 사용합니다. 브리지 구성에 대한 정보는 Spring 문서 를 참조하십시오.