Java XML 계측 예제

New Relic에서 모니터링하는 Java 애플리케이션의 경우 한 가지 사용자 정의 계측 방법은 계측하려는 메서드와 클래스를 나열하는 XML 파일을 사용하는 것입니다. 이 문서는 예제 XML 계측 파일을 보여줍니다. 자세한 내용 은 XML을 통한 Java 계측을 참조하세요.

UI에서 XML 파일 편집

뉴렐릭 UI 에서 직접 XML 파일을 편집하려면: one.newrelic.com > All capabilities > APM & services > (select an app) > Settings > Instrumentation로 이동하세요. 여기에서 다음을 수행할 수 있습니다.

샘플 XML 파일을 다운로드합니다.
기존 XML 파일 편집을 선택합니다.
계측 기록을 검색합니다.

XML 파일 형식

XML 파일 형식에는 루트 및 자식 노드가 포함됩니다.

주의

측정항목 그룹화 문제 가 발생할 수 있으므로 모든 방법을 계측하지 마십시오.

XML 파일의 루트 노드는 extension 입니다. 세 가지 다른 속성을 가질 수 있습니다.

값	정의
`name`	XML 확장을 식별하는 고유하지만 설명적인 이름입니다.
`enabled`	Java 에이전트에서 확장을 읽을지 여부를 식별합니다. 기본값은 `true` 입니다. `false` 인 경우 New Relic은 확장을 무시합니다.
`version`	확장의 버전입니다. 두 확장의 이름이 같은 경우 가장 높은 버전의 확장만 사용됩니다.

pointcut 은 instrumentation 의 하위 노드이며 여러 속성을 가질 수 있습니다. 또한 pointcut 에는 여러 다른 하위 노드 가 있을 수 있습니다.

값	정의
`transactionStartPoint`	이 포인트컷에 도달했을 때 트랜잭션이 아직 진행 중이 아니면 트랜잭션이 시작됩니다. 트랜잭션이 이미 진행 중이면 해당 트랜잭션이 계속됩니다. 새 트랜잭션이 생성되지 않습니다.
`metricNameFormat`	메트릭에 사용할 이름 형식입니다. 존재하지 않으면 기본적으로 클래스 이름 뒤에 메소드 이름이 옵니다. `transactionStartPoint` 이 `false` 로 설정된 포인트컷에서만 `metricNameFormat` 을 설정할 수 있습니다.
`excludeFromTransactionTrace`	이 pointcut이 트랜잭션을 시작하는 경우 `true` 트랜잭션 추적이 제공되지 않습니다. 트랜잭션 중간에 pointcut에 도달하면 트랜잭션 추적은 계속 존재하지만 이 메서드는 호출 그래프에서 제외됩니다.
`ignoreTransaction`	`true` 이면 전체 트랜잭션이 무시됩니다.
`transactionType`	트랜잭션의 유형을 설정합니다. 가능한 값은 `background` (기본값, 웹이 아닌 트랜잭션 으로 보고됨) 및 `web` ( 웹 트랜잭션 으로 보고됨)입니다.

pointcut 에는 여러 하위 노드가 있을 수 있습니다.

값	정의
`nameTransaction`	이 요소가 있으면 에이전트는 이 포인트컷에 의해 계측된 클래스 이름과 메서드를 사용하여 트랜잭션의 이름을 지정합니다.
`methodAnnotation`	패키지 이름을 포함하는 주석 클래스의 대소문자를 구분하는 전체 이름입니다. 이 주석으로 표시된 모든 메서드가 일치합니다.
`className`	패키지 이름을 포함하여 일치시킬 클래스의 대소문자를 구분하는 이름입니다. 이 노드를 메서드 노드와 페어링합니다. 이 노드가 pointcut에 있는 경우 `interfaceName` 노드는 동일한 pointcut 노드에 있을 수 없습니다. `className` 노드에는 `includeSubclasses` 속성이 있습니다. `true` 인 경우 일치하는 이름을 가진 클래스의 메소드는 이 클래스의 모든 하위 클래스에 대한 일치하는 메소드와 함께 계측됩니다. `false` (기본값)인 경우 지정된 정확한 클래스의 메서드만 계측됩니다. `className` 은 다음 규칙을 따라야 합니다. 내부 클래스를 계측할 수 있습니다. 패키지 사이에 점이 있는 전체 패키지 구조를 사용해야 합니다. 지정된 클래스의 하위 클래스를 일치시키려면 `includeSubclasses` 속성을 `true` 로 설정하십시오.
`interfaceName`	구현 클래스가 일치할 패키지 이름을 포함하여 인터페이스의 대소문자 구분 이름입니다. 이 노드를 메서드 노드와 페어링합니다. 이 노드가 pointcut에 있는 경우 `className` 노드는 동일한 pointcut 노드에 있을 수 없습니다. `interfaceName` 은 다음 규칙을 따라야 합니다. 패키지 사이에 점이 있는 전체 패키지 구조를 사용해야 합니다.
`method`	계측할 클래스의 메서드입니다. 이 노드를 `className` 노드와 페어링합니다. 또한 `method` 노드에는 하위 항목이 있을 수 있습니다.
`traceByReturnType`	패키지를 포함한 클래스 이름은 바이트코드에 사용되는 형식(예: `Ljava/lang/String;` 입니다. 해당 클래스의 개체를 반환하는 모든 메서드가 일치합니다.
`traceLambda`	람다와 일치할지 여부를 나타내는 부울입니다. `traceLambda` 노드에는 다음과 같은 속성이 있습니다. `includeNonstatic` - 비 정적 메서드와 일치할지 여부를 나타내는 부울 값(기본값은 false) `pattern` - 람다 메서드를 검색하기 위한 패턴이 있는 문자열.

method 노드에는 여러 하위 항목이 있을 수 있습니다. 자세한 정보 및 예제는 Java 사용자 정의 계측 문제 해결 을 참조하십시오.

값	정의
`name`	일치시킬 메소드의 정확한 대소문자를 구분하는 이름입니다. 메서드 `name` 노드는 다음 규칙을 따라야 합니다. 공개, 보호, 비공개 및 패키지 메서드를 모두 계측할 수 있습니다. 정적 및 인스턴스 메서드를 계측할 수 있습니다. 생성자는 계측할 수 없습니다.
`parameters`	순서대로 지정된 메소드의 매개변수 유형입니다. `parameters` 요소가 없으면 이름과 일치하는 모든 메서드가 일치합니다. 여기에는 private 및 protected 선언이 포함됩니다. 메서드 `parameters` 노드에는 `type` 요소로 지정된 메서드 매개변수 목록이 포함되어 있습니다. 다음은 `type` 요소에 대한 주요 규칙입니다. 프리미티브는 int, float, double, long, byte, short, boolean, char 등의 일반 이름을 사용하여 지정됩니다. 개체에는 전체 패키지 구조가 필요합니다. 예를 들어, XML에서 `String` 을 사용하지 마십시오. 대신 `java.lang.String` 을(를) 사용하십시오. 컬렉션 개체와 함께 제네릭을 사용하지 마십시오. 예를 들어, `java.util.List<String>` } 대신 `java.util.List` 을 작성합니다. 배열에 대괄호를 포함합니다. 예를 들어 정수 배열은 `int[ ]` 이고 문자열 배열은 `java.lang.String[ ]` 입니다. 배열 배열에 대괄호 두 세트를 포함합니다. 예를 들어, long 배열의 배열은 `long[ ][ ]` 입니다. 매개변수를 분석 이벤트로 New Relic에 보내려면 `attributeName` 이라는 유형 요소에 XML 속성을 추가합니다. 매개변수가 없는 메서드를 사용하려면 "인수 없음" 메서드와 일치하도록 `parameters` 노드가 있어야 합니다.
`returnType`	일치시킬 반환 유형을 나타내는 클래스의 대소문자를 구분하는 이름입니다. 이 클래스 유형을 반환하는 모든 메서드가 일치합니다.

값

정의

name

일치시킬 메소드의 정확한 대소문자를 구분하는 이름입니다.

메서드 name 노드는 다음 규칙을 따라야 합니다.

공개, 보호, 비공개 및 패키지 메서드를 모두 계측할 수 있습니다.
정적 및 인스턴스 메서드를 계측할 수 있습니다.
생성자는 계측할 수 없습니다.

parameters

순서대로 지정된 메소드의 매개변수 유형입니다. parameters 요소가 없으면 이름과 일치하는 모든 메서드가 일치합니다. 여기에는 private 및 protected 선언이 포함됩니다.

메서드 parameters 노드에는 type 요소로 지정된 메서드 매개변수 목록이 포함되어 있습니다. 다음은 type 요소에 대한 주요 규칙입니다.

프리미티브는 int, float, double, long, byte, short, boolean, char 등의 일반 이름을 사용하여 지정됩니다.
개체에는 전체 패키지 구조가 필요합니다. 예를 들어, XML에서 String 을 사용하지 마십시오. 대신 java.lang.String 을(를) 사용하십시오.
컬렉션 개체와 함께 제네릭을 사용하지 마십시오. 예를 들어, java.util.List<String> } 대신 java.util.List 을 작성합니다.
배열에 대괄호를 포함합니다. 예를 들어 정수 배열은 int[ ] 이고 문자열 배열은 java.lang.String[ ] 입니다.
배열 배열에 대괄호 두 세트를 포함합니다. 예를 들어, long 배열의 배열은 long[ ][ ] 입니다.
매개변수를 분석 이벤트로 New Relic에 보내려면 attributeName 이라는 유형 요소에 XML 속성을 추가합니다.
매개변수가 없는 메서드를 사용하려면 "인수 없음" 메서드와 일치하도록 parameters 노드가 있어야 합니다.

returnType

일치시킬 반환 유형을 나타내는 클래스의 대소문자를 구분하는 이름입니다. 이 클래스 유형을 반환하는 모든 메서드가 일치합니다.

예시

다음은 샘플 클래스와 해당 클래스를 계측하는 데 사용할 수 있는 XML 파일입니다.

package test;

import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

public class SampleTester {

    private String configName;
    private Map<String, Long> maxSampleTimes;

    public SampleTester(String pConfigName) {
        configName = pConfigName;
        maxSampleTimes = new HashMap<>();
    }

    public void checkSample(String name, long[] times) {
        if (times != null) {
            maxSampleTimes.put(name, getFirst(times));
        } else {
            maxSampleTimes.put(name, (long) getFirst());
        }
    }

    private Long getFirst(long[] times) {
        return times[0];
    }

    private int getFirst() {
        return 0;
    }

    public void printMaxRepeat(final long max) throws Exception {
        Runnable myRunnable = new Runnable() {
            public void run() {
                try {
                    printMax(max);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        };

        ScheduledExecutorService scheduledExecutor = Executors.newScheduledThreadPool(1);
        scheduledExecutor.scheduleWithFixedDelay(myRunnable, 0, 10000, TimeUnit.MILLISECONDS);
    }

    private void printMax(long max) {
        System.out.println("max is " + max);
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<extension xmlns="https://newrelic.com/docs/java/xsd/v1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="newrelic-extension extension.xsd"
  name="customExtension" version="1.0">

  <instrumentation metricPrefix="EXAMPLE">
    <pointcut transactionStartPoint="true">

      <!--class name is preceded by package name-->
      <className>test.SampleTester</className>
      <method>
        <name>checkSample</name>
        <parameters>
          <type attributeName="sampleName">java.lang.String</type>
          <type>long[]</type>
        </parameters>
      </method>
      <!--two methods with the same name but different signatures can share one node-->
      <method>
        <name>getFirst</name>
      </method>
      <method>
        <name>run</name>
      </method>
    </pointcut>

    <pointcut transactionStartPoint="false" 
      ignoreTransaction="false"
      excludeFromTransactionTrace="false"
      metricNameFormat="SampleTester/methods">

      <className>test.SampleTester</className>
      <method>
        <name>printMaxRepeat</name>
      </method>
      <method>
        <name>printMax</name>
      </method>
    </pointcut>

  </instrumentation>
</extension>

XML 파일의 첫 번째 블록은 확장의 이름과 버전을 지정합니다. XML 확장자는 기본 enabled 이므로 해당 속성은 지정되지 않습니다.

두 번째 블록은 계측해야 하는 SampleClass 의 메서드를 지정합니다. 블록의 시작 부분에서 트랜잭션이 시작됩니다. 예제 클래스에는 이름( getFirst )을 공유하지만 서명이 다른 두 가지 메서드가 있다는 점은 주목할 가치가 있습니다. 이들은 단일 메소드 노드로 계측됩니다. parameters 노드를 제거하면 동일한 이름을 가진 모든 메소드가 하나의 메소드 노드에서 일치될 수 있습니다.

세 번째 블록에서 지정된 메서드에는 트랜잭션이 시작되지 않았습니다. 트랜잭션이 이미 run 에서 시작되었기 때문입니다. 트랜잭션은 무시되지 않으며 트랜잭션 추적에 포함됩니다.

사용자의 편의를 위해 제공되는 기계 번역입니다.

UI에서 XML 파일 편집

XML 파일 형식

주의

루트 노드: 확장

계측(확장의 하위)

Pointcut(계측의 자식)

pointcut의 자식 노드

메서드의 자식 노드

예시

샘플 클래스

샘플 XML 계측 파일 및 설명

사용자의 편의를 위해 제공되는 기계 번역입니다.

Java XML 계측 예제

UI에서 XML 파일 편집 .css-21sua1{background:none;border:none;width:0;padding:0;}

XML 파일 형식

주의

계측(확장의 하위)

Pointcut(계측의 자식)

pointcut의 자식 노드

메서드의 자식 노드

예시

샘플 클래스

샘플 XML 계측 파일 및 설명

UI에서 XML 파일 편집