OpenTelemetry Java로 마이그레이션

X-Ray Java 에이전트를 활성화하려면 애플리케이션의 JVM 인수를 수정해야 했습니다.

-javaagent:/path-to-disco/disco-java-agent.jar=pluginPath=/path-to-disco/disco-plugins

OpenTelemetry 기반 Java 에이전트를 사용합니다.

Java용 X-Ray SDK를 사용하여 코드를 계측하려면 먼저 AWSXRay 클래스를 서비스 플러그인 및 로컬 샘플링 규칙으로 구성한 다음 제공된 레코더를 사용해야 했습니다.

static { AWS XRayRecorderBuilder builder = AWS XRayRecorderBuilder.standard().withPlugin(new EC2Plugin()).withPlugin(new ECSPlugin()); AWS XRay.setGlobalRecorder(builder.build());
}

다음 종속성이 필요합니다.

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>io.opentelemetry</groupId>
                <artifactId>opentelemetry-bom</artifactId>
                <version>1.49.0</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>io.opentelemetry.instrumentation</groupId>
                <artifactId>opentelemetry-instrumentation-bom</artifactId>
                <version>2.15.0</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.opentelemetry</groupId>
            <artifactId>opentelemetry-sdk</artifactId>
        </dependency>
        <dependency>
            <groupId>io.opentelemetry</groupId>
            <artifactId>opentelemetry-api</artifactId>
        </dependency>
        <dependency>
            <groupId>io.opentelemetry.semconv</groupId>
            <artifactId>opentelemetry-semconv</artifactId>
        </dependency>
        <dependency>
            <groupId>io.opentelemetry</groupId>
            <artifactId>opentelemetry-exporter-otlp</artifactId>
        </dependency>
        <dependency>
            <groupId>io.opentelemetry.contrib</groupId>
            <artifactId>opentelemetry-aws-xray</artifactId>
            <version>1.46.0</version>
        </dependency>
        <dependency>
            <groupId>io.opentelemetry.contrib</groupId>
            <artifactId>opentelemetry-aws-xray-propagator</artifactId>
            <version>1.46.0-alpha</version>
        </dependency>
        <dependency>
            <groupId>io.opentelemetry.contrib</groupId>
            <artifactId>opentelemetry-aws-resources</artifactId>
            <version>1.46.0-alpha</version>
        </dependency>
    </dependencies>

를 인스턴스화TracerProvider하고 OpenTelemetrySdk 객체를 전역적으로 등록하여 OpenTelemetry SDK를 구성합니다. 다음 구성 요소를 구성합니다.

스프링 프레임워크와 함께 X-Ray SDK를 사용하여 애플리케이션을 계측하는 방법에 대한 자세한 내용은 Spring을 사용하는 AOP 및 Java용 X-Ray SDK를 참조하세요. Spring에서 AOP를 활성화하려면 다음 단계를 완료하세요.

OpenTelemetry는 Spring Boot 애플리케이션에 대한 수신 요청에 대한 추적을 수집하는 계측 라이브러리를 제공합니다. 최소한의 구성으로 Spring Boot 계측을 활성화하려면 다음 종속성을 포함합니다.

<dependency>
           <groupId>io.opentelemetry.instrumentation</groupId>
            <artifactId>opentelemetry-spring-boot-starter</artifactId>
        </dependency>

OpenTelemetry 설정에 대해 Spring Boot 계측을 활성화하고 구성하는 방법에 대한 자세한 내용은 OpenTelemetry의 시작하기를 참조하세요.

Spring Boot 애플리케이션을 계측하는 데 권장되는 기본 방법은 바이트코드 계측과 함께 OpenTelemetry Java 에이전트를 사용하는 것입니다.이 에이전트는 SDK를 직접 사용하는 경우와 비교할 때 더 많은 out-of-the-box 계측 및 구성을 제공합니다. 시작하기는 단원을 참조하십시오제로 코드 자동 계측 솔루션.

빌드에 aws-xray-recorder-sdk-aws-sdk-v2-instrumentor 하위 모듈을 추가하면 Java용 X-Ray SDK가 모든 AWS SDK v2 클라이언트를 자동으로 계측할 수 있습니다.

Java 2.2 이상용 AWS SDK를 사용하여 AWS 서비스에 대한 개별 클라이언트 다운스트림 클라이언트 호출을 계측하기 위해 빌드 구성의 aws-xray-recorder-sdk-aws-sdk-v2-instrumentor 모듈이 제외되고 aws-xray-recorder-sdk-aws-sdk-v2 모듈이 포함되었습니다. 개별 클라이언트는 로 구성하여 구성되었습니다TracingInterceptor.

import com.amazonaws.xray.interceptors.TracingInterceptor;
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
//...

public class MyModel {
  private DynamoDbClient client = DynamoDbClient.builder()
    .region(Region.US_WEST_2)
    .overrideConfiguration(
      ClientOverrideConfiguration.builder()
        .addExecutionInterceptor(new TracingInterceptor())
        .build()
      )
    .build();
//...

모든 AWS SDK 클라이언트를 자동으로 계측하려면 opentelemetry-aws-sdk-2.2-autoconfigure 하위 모듈을 추가합니다.

<dependency>
            <groupId>io.opentelemetry.instrumentation</groupId>
            <artifactId>opentelemetry-aws-sdk-2.2-autoconfigure</artifactId>
            <version>2.15.0-alpha</version>
            <scope>runtime</scope>
        </dependency>

개별 AWS SDK 클라이언트를 계측하려면 opentelemetry-aws-sdk-2.2 하위 모듈을 추가합니다.

<dependency>
            <groupId>io.opentelemetry.instrumentation</groupId>
            <artifactId>opentelemetry-aws-sdk-2.2</artifactId>
            <version>2.15.0-alpha</version>
            <scope>compile</scope>
        </dependency>

그런 다음 AWS SDK 클라이언트를 생성할 때 인터셉터를 등록합니다.

import io.opentelemetry.instrumentation.awssdk.v2_2.AwsSdkTelemetry;

// ...

    AwsSdkTelemetry telemetry = AwsSdkTelemetry.create(openTelemetry);
    private final S3Client S3_CLIENT = S3Client.builder()
      .overrideConfiguration(ClientOverrideConfiguration.builder()
        .addExecutionInterceptor(telemetry.newExecutionInterceptor())
        .build())
      .build();

X-Ray를 사용하여 발신 HTTP 요청을 계측하려면 Java용 X-Ray SDK의 Apache HttpClient 버전이 필요했습니다.

import com.amazonaws.xray.proxies.apache.http.HttpClientBuilder;
...
  public String randomName() throws IOException {
    CloseableHttpClient httpclient = HttpClientBuilder.create().build();

X-Ray Java SDK와 마찬가지로 OpenTelemetry는 Apache HttpClient에 OpenTelemetry 기반 스팬 및 컨텍스트 전파를 제공하기 HttpClientBuilder 위해의 인스턴스를 생성할 수 있는 빌더 메서드가 있는 ApacheHttpClientTelemetry 클래스를 제공합니다.

<dependency>
            <groupId>io.opentelemetry.instrumentation</groupId>
            <artifactId>opentelemetry-apache-httpclient-5.2</artifactId>
            <version>2.15.0-alpha</version>
            <scope>compile</scope>
        </dependency>

다음은 opentelemetry-java-instrumentation 의 코드 예제입니다. newHttpClient()에서 제공하는 HTTP 클라이언트는 실행된 요청에 대한 추적을 생성합니다.

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.apachehttpclient.v5_2.ApacheHttpClientTelemetry;
import org.apache.hc.client5.http.classic.HttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;

public class ApacheHttpClientConfiguration {

  private OpenTelemetry openTelemetry;

  public ApacheHttpClientConfiguration(OpenTelemetry openTelemetry) {
    this.openTelemetry = openTelemetry;
  }

  // creates a new http client builder for constructing http clients with open telemetry instrumentation
  public HttpClientBuilder createBuilder() {
    return ApacheHttpClientTelemetry.builder(openTelemetry).build().newHttpClientBuilder();
  }

  // creates a new http client with open telemetry instrumentation
  public HttpClient newHttpClient() {
    return ApacheHttpClientTelemetry.builder(openTelemetry).build().newHttpClient();
  }
}

X-Ray SDK를 사용하면 X-Ray 세그먼트 및 하위 세그먼트를 수동으로 생성하는 데 beginSegment 및 beginSubsegment 메서드가 필요합니다.

  Segment segment = xrayRecorder.beginSegment("ManualSegment");
        segment.putAnnotation("annotationKey", "annotationValue");
        segment.putMetadata("metadataKey", "metadataValue");

        try {
            Subsegment subsegment = xrayRecorder.beginSubsegment("ManualSubsegment");
            subsegment.putAnnotation("key", "value");

            // Do something here

        } catch (Exception e) {
            subsegment.addException(e);
        } finally {
            xrayRecorder.endSegment();
        }

사용자 지정 스팬을 사용하여 계측 라이브러리로 캡처되지 않은 내부 활동의 성능을 모니터링할 수 있습니다. 스팬 종류 서버만 X-Ray 세그먼트로 변환되고 다른 모든 스팬은 X-Ray 하위 세그먼트로 변환됩니다.

먼저openTelemetry.getTracer, 메서드를 통해 얻을 수 있는 스팬을 생성하려면 트레이서를 생성해야 합니다. 그러면 SDK를 사용한 수동 계측 솔루션 예제에 전역적으로 TracerProvider 등록된의 Tracer 인스턴스가 제공됩니다. 필요한 만큼 Tracer 인스턴스를 생성할 수 있지만 전체 애플리케이션에 대해 하나의 Tracer를 사용하는 것이 일반적입니다.

Tracer tracer = openTelemetry.getTracer("my-app");

추적기를 사용하여 스팬을 생성할 수 있습니다.

import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Scope;

...

// SERVER span will become an X-Ray segment
Span span = tracer.spanBuilder("get-token")
  .setKind(SpanKind.SERVER)
  .setAttribute("key", "value")
  .startSpan();
try (Scope ignored = span.makeCurrent()) {

  span.setAttribute("metadataKey", "metadataValue");
  span.setAttribute("annotationKey", "annotationValue");
  
  // The following ensures that "annotationKey: annotationValue" is an annotation in X-Ray raw data.
  span.setAttribute(AttributeKey.stringArrayKey("aws.xray.annotations"), List.of("annotationKey"));

  // Do something here
}

span.end();

스팬의 기본 유형은 내부입니다.

// Default span of type INTERNAL will become an X-Ray subsegment
Span span = tracer.spanBuilder("process-header")
  .startSpan();
try (Scope ignored = span.makeCurrent()) {
  doProcessHeader();
}

OpenTelemetry SDK를 사용하여 트레이스에 주석 및 메타데이터 추가

위 예제에서 setAttribute 메서드는 각 스팬에 속성을 추가하는 데 사용됩니다. 기본적으로 모든 스팬 속성은 X-Ray 원시 데이터의 메타데이터로 변환됩니다. 속성이 메타데이터가 아닌 주석으로 변환되도록 하기 위해 위 예제에서는 해당 속성의 키를 aws.xray.annotations 속성 목록에 추가합니다. 자세한 내용은 사용자 지정 X-Ray 주석 및 주석 및 메타데이터 활성화를 참조하세요.

OpenTelemetry 기반 Java 에이전트 사용

Java 에이전트를 사용하여 애플리케이션을 자동으로 계측하는 경우 애플리케이션에서 수동 계측을 수행해야 합니다. 예를 들어 자동 계측 라이브러리에서 다루지 않는 섹션의 애플리케이션 내에서 코드를 계측하는 것입니다.

에이전트를 사용하여 수동 계측을 수행하려면 opentelemetry-api 아티팩트를 사용해야 합니다. 아티팩트 버전은 에이전트 버전보다 최신일 수 없습니다.

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.trace.Span;

// ...
  
        Span parentSpan = Span.current();
        Tracer tracer = GlobalOpenTelemetry.getTracer("my-app");
        Span span = tracer.spanBuilder("my-span-name")
            .setParent(io.opentelemetry.context.Context.current().with(parentSpan))
            .startSpan();
        span.end();

X-Ray SDK를 사용하면 Lambda가 활성 추적을 활성화한 후 X-Ray SDK를 사용하는 데 추가 구성이 필요하지 않습니다. Lambda는 Lambda 핸들러 호출을 나타내는 세그먼트를 생성하며, 추가 구성 없이 X-Ray SDK를 사용하여 하위 세그먼트 또는 계측 라이브러리를 생성할 수 있습니다.

자동 계측 Lambda 계층 - 다음 솔루션을 사용하여 AWS 벤딩된 Lambda 계층으로 Lambda를 자동으로 계측할 수 있습니다.

자동 계측 계층과 함께 수동 계측을 사용하려면 섹션을 참조하세요SDK를 사용한 수동 계측 솔루션. 콜드 스타트를 줄이려면 OpenTelemetry 수동 계측을 사용하여 Lambda 함수에 대한 OpenTelemetry 트레이스를 생성하는 것이 좋습니다.