Application Real-Time Monitoring Service:Java için OpenTelemetry ile özel enstrümantasyon ekleme

<dependencies>
    <dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-api</artifactId>
    </dependency>
    <dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-sdk-trace</artifactId>
    </dependency>
    <dependency>
    <groupId>io.opentelemetry</groupId>
    <artifactId>opentelemetry-sdk</artifactId>
    </dependency>
</dependencies>
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>io.opentelemetry</groupId>
      <artifactId>opentelemetry-bom</artifactId>
      <version>1.23.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

Temel kavramlar

Bu bölümde yalnızca yaygın terimler açıklanmaktadır. Diğer terimler hakkında daha fazla bilgi için OpenTelemetry Spesifikasyonuna bakın.

• span: Bir istekteki belirli bir işlem; örneğin, uzak çağrı giriş noktası veya dahili bir yöntem çağrısı.

• SpanContext: İzleme bağlamıdır; izleme kimliği ve span kimliği gibi bilgileri içerir.

• attribute (nitelik): Span üzerinde anahtar bilgileri kaydeden ek bir alandır.

• Baggage: Tüm izleme boyunca yayılan anahtar-değer çiftleridir.

Java için OpenTelemetry SDK'yı kullanma

OpenTelemetry SDK'yı aşağıdaki işlemleri gerçekleştirmek için kullanabilirsiniz:

• Span'lar oluşturmak için enstrümantasyon ekleyin.

• Span'lara nitelikler ekleyin.

• İzleme bağlamında Baggage'i yayınlayın.

• Mevcut izleme bağlamını alın ve izleme kimliği ile span kimliği gibi bilgileri yazdırın.

Aşağıdaki örnek kod, bu işlemlerin OpenTelemetry SDK kullanılarak nasıl gerçekleştirileceğini göstermektedir.

@RestController
@RequestMapping("/ot")
public class OpenTelemetryController {
    private Tracer tracer;
    private ScheduledExecutorService ses = Executors.newSingleThreadScheduledExecutor();
    @PostConstruct
    public void init() {
	    OpenTelemetrySdk.builder()
			.setPropagators(ContextPropagators.create(W3CTraceContextPropagator.getInstance()))
			.buildAndRegisterGlobal();
		tracer = GlobalOpenTelemetry.get().getTracer("manual-sdk", "1.0.0");
        ses.scheduleAtFixedRate(new Runnable() {
            @Override
            public void run() {
                Span span = tracer.spanBuilder("schedule")
                        .setAttribute("schedule.time", System.currentTimeMillis())
                        .startSpan();
                try (Scope scope = span.makeCurrent()) {
                    System.out.println("scheduled!");
                    Thread.sleep(500L);
                    span.setAttribute("schedule.success", true);
                    System.out.println(Span.current().getSpanContext().getTraceId()); // Get the trace ID
                } catch (Throwable t) {
                    span.setStatus(StatusCode.ERROR, t.getMessage());
                } finally {
                    span.end();
                }
            }
        }, 10, 30, TimeUnit.SECONDS);
    }
    @ResponseBody
    @RequestMapping("/parent")
    public String parent() {
        Span span = tracer.spanBuilder("parent").setSpanKind(SpanKind.SERVER).startSpan();
        try (Scope scope = span.makeCurrent()) {
            // Use Baggage to propagate custom business tags.
            Baggage baggage =  Baggage.current().toBuilder()
                    .put("user.id", "1")
                    .put("user.name", "name")
                    .build();
            try (Scope baggageScope = baggage.storeInContext(Context.current()).makeCurrent()) {
                child();
            }
            span.setAttribute("http.method", "GET");
            span.setAttribute("http.uri", "/parent");
        } finally {
            span.end();
        }
        return "parent";
    }
    private void child() {
        Span span = tracer.spanBuilder("child").startSpan();
        try (Scope scope = span.makeCurrent()) {
            System.out.println("current traceId = " + Span.current().getSpanContext().getTraceId());
            System.out.println("userId in baggage = " + Baggage.current().getEntryValue("user.id"));
            Thread.sleep(1000);
        } catch (Throwable e) {
            span.setStatus(StatusCode.ERROR, e.getMessage());
        } finally {
            span.end();
        }
    }
}

Örnek adım adım açıklama:

1. OpenTelemetryController sınıfının init yönteminde zamanlanmış bir görev başlatılır. Her çalıştırmanın başında bir span oluşturulur ve işlem tamamlandığında sonlandırılır.

2. OpenTelemetryController sınıfının parent yönteminde birkaç OpenTelemetry SDK yöntemi çağrılır.

   1. Yöntem her çağrıldığında parent adlı bir span oluşturulur ve yöntem tamamlandığında sonlandırılır.

   2. Baggage SDK'sı kullanılarak user.id ve user.name olmak üzere iki Baggage öğesi eklenir. Bu öğeler aşağı akış uygulamalarına yayılır.

   3. Adım 2.a içinde oluşturulan span'a iki nitelik eklenir.

3. OpenTelemetryController sınıfının child yöntemi aşağıdaki işlemleri gerçekleştirir:

   1. Yöntem her çağrıldığında child adlı bir span oluşturulur ve yöntem tamamlandığında sonlandırılır. Bu span, adım 2.a içinde oluşturulan span'ın alt öğesidir.

   2. İzleme bağlamından izleme kimliği alınır ve yazdırılır.

   3. Adım 2.b içinde eklenen Baggage alınır ve değeri yazdırılır.

ARMS aracı sürümleri arasındaki farklar

Önceki kodda yer alan işlemlere yönelik destek, ARMS aracı sürümlerine göre farklılık gösterir.

Enstrümantasyon sonuçları