Application Real-Time Monitoring Service：Gunakan OpenTelemetry SDK untuk Java untuk menambahkan kode instrumen kustom ke jejak

Untuk informasi mengenai komponen dan framework yang didukung oleh ARMS, lihat Komponen dan framework Java yang didukung oleh ARMS.

Tambahkan dependensi

Tambahkan dependensi Maven berikut untuk memperkenalkan OpenTelemetry SDK untuk Java. Untuk informasi lebih lanjut, lihat Instrumen.

<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>

Kompatibilitas antara ARMS dan instrumen berbasis OpenTelemetry

Istilah

Hanya beberapa istilah yang umum digunakan yang diperkenalkan di sini. Untuk informasi tentang nama lainnya, lihat Spesifikasi OpenTelemetry.

• Rentang: operasi spesifik dalam permintaan, seperti panggilan jarak jauh atau panggilan metode internal.

• SpanContext: konteks untuk jejak permintaan tunggal, yang mencakup informasi seperti traceId dan spanId.

• Atribut: bidang atribut tambahan dari rentang, yang digunakan untuk mencatat informasi penting.

• Baggage: pasangan nilai-kunci yang disebarkan di seluruh jejak lengkap.

Gunakan OpenTelemetry SDK untuk Java

Anda dapat menggunakan SDK untuk melakukan operasi berikut:

• Buat Rentang baru menggunakan kode instrumen.

• Tambahkan Atribut ke Rentang.

• Sebarkan item Baggage dalam konteks jejak.

• Akses konteks jejak dan keluarkan pengenal seperti traceId dan spanId.

Contoh kode berikut menunjukkan cara menggunakan SDK untuk melakukan operasi sebelumnya.

@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()); // Dapatkan ID jejak.
                } 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()) {
            // Gunakan Baggage untuk menyebarkan tag kustom layanan.
            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();
        }
    }
}

Detail:

1. Dalam metode init dari OpenTelemetryController, tugas terjadwal dimulai menggunakan ScheduledExecutorService. Saat tugas terjadwal dimulai, ia membuat Rentang dan menutup Rentang ini ketika tugas berakhir.

2. Dalam metode parent dari OpenTelemetryController, beberapa metode dari OpenTelemetry SDK dipanggil.

   1. Setiap kali metode ini dipanggil, ia membuat Rentang bernama parent dan menutup Rentang ini ketika metode berakhir.

   2. Metode ini juga memanggil SDK Baggage untuk menambahkan dua pasang Baggage bernama user.id dan user.name. Kedua Baggage ini akan disebarkan ke aplikasi hilir.

   3. Dua Atribut ditambahkan ke Rentang yang dibuat di Langkah 2.a.

3. Dalam metode child dari OpenTelemetryController, operasi berikut dilakukan.

   1. Setiap kali metode ini dipanggil, ia membuat Rentang bernama child dan menutup Rentang ini ketika metode berakhir. Perhatikan bahwa Rentang ini adalah anak dari Rentang yang dibuat di Langkah 2.a.

   2. Metode ini mengambil konteks Jejak dan mencetak traceId.

   3. Metode ini juga mengambil dan mencetak item Baggage (user.id dan user.name) yang ditambahkan di Langkah 2.b.

Perbandingan versi agen

Versi agen ARMS yang berbeda memberikan dukungan yang berbeda untuk langkah-langkah sebelumnya, seperti yang ditunjukkan dalam tabel berikut.

Efek instrumen

Langkah terkait

Dengan mengaitkan ID jejak dengan log bisnis aplikasi, Anda dapat dengan cepat mengaksesnya untuk mengidentifikasi, menganalisis, dan menyelesaikan kesalahan apa pun.