Application Real-Time Monitoring Service:Menghubungkan jejak antarmuka depan dan backend

Agen Pemantauan Aplikasi

Agen ARMS Application Monitoring memiliki dukungan bawaan untuk protokol OpenTelemetry. Oleh karena itu, Anda dapat mengorelasikan jejak dengan RUM tanpa konfigurasi tambahan. Namun, pastikan hal berikut:

• Agen Pemantauan Aplikasi harus versi 2.x, 3.x, atau 4.x. Untuk pengalaman terbaik, kami merekomendasikan peningkatan ke versi 4.x.

• Harus menggunakan container web utama, seperti Tomcat, Jetty, WebLogic, atau Undertow, serta framework yang didukung, seperti SpringBoot atau SpringMVC. Untuk daftar lengkap komponen dan framework yang didukung, lihat Komponen dan framework Java yang didukung oleh Pemantauan Aplikasi.

Untuk petunjuk cara menginstal agen Pemantauan Aplikasi, lihat Monitor aplikasi Java.

OpenTelemetry

Anda dapat menginstrumentasi aplikasi Anda dengan OpenTelemetry dan melaporkan data ke ARMS (Managed Service for OpenTelemetry). Tersedia dua metode: auto-instrumentation dan manual instrumentation.

• Auto-instrumentation tidak memerlukan konfigurasi tambahan untuk mengorelasikan jejak dengan RUM karena OpenTelemetry mendukung sebagian besar framework utama.

  Catatan

  Untuk informasi tentang framework Java yang didukung OpenTelemetry, lihat Laporkan data aplikasi Java menggunakan OpenTelemetry.

• Dengan manual instrumentation, Anda harus menggunakan mekanisme ekstensi SDK OpenTelemetry untuk mengorelasikan jejak. Proses ini melibatkan penguraian konteks jejak dari header traceparent dan tracestate permintaan antarmuka depan. Kode berikut memberikan contoh untuk aplikasi SpringBoot:

  1. Tambahkan dependensi OpenTelemetry.

     <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-extension-annotations</artifactId>
       <version>1.18.0</version>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-exporter-otlp</artifactId>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-sdk</artifactId>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-semconv</artifactId>
       <version>1.30.1-alpha</version>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-sdk-extension-autoconfigure</artifactId>
       <version>1.34.1</version>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-extension-incubator</artifactId>
       <version>1.35.0-alpha</version>
     </dependency>

  2. Tambahkan propagator W3C selama inisialisasi OpenTelemetry.

     Resource resource = Resource.getDefault()
             .merge(Resource.create(Attributes.of(
                     ResourceAttributes.SERVICE_NAME, "otel-demo",
                     ResourceAttributes.HOST_NAME, "xxxx"
     )));
     
     SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
             .addSpanProcessor(BatchSpanProcessor.builder(OtlpHttpSpanExporter.builder()
                     .setEndpoint("Your Endpoint")
                     .addHeader("Authentication", "Your Token")
                     .build()).build())
             .setResource(resource)
             .build();
     
     openTelemetry = OpenTelemetrySdk.builder()
             .setTracerProvider(sdkTracerProvider)
             // Tambahkan propagator W3C di sini.
             .setPropagators(ContextPropagators.create(
                     TextMapPropagator.composite(W3CTraceContextPropagator.getInstance(), W3CBaggagePropagator.getInstance()))
              ).buildAndRegisterGlobal();
     // Diperlukan Tracer yang diperluas di sini.
     tracer = ExtendedTracer.create(openTelemetry.getTracer("com.example.tracer", "1.0.0"));

  3. Di antarmuka bisnis, tambahkan parameter header, uraikan konteks jejak dari header permintaan, dan atur parent.

     // Tambahkan parameter header permintaan di Controller untuk mengurai konteks jejak.
     @RequestMapping("/test")
     public String test(@RequestHeader Map<String, String> headers) {
         Span span = OpenTelemetrySupport.getTracer()
                 .spanBuilder("/test")
                 // Uraikan span parent dari header.
                 .setParentFrom(OpenTelemetrySupport.getContextPropagators(), headers)
                 .setSpanKind(SpanKind.SERVER)
                 .startSpan();
         try (Scope scope = span.makeCurrent()) {
             // lakukan sesuatu
         } catch (Throwable t) {
             span.setStatus(StatusCode.ERROR, "handle parent span error");
         } finally {
             span.end();
         }
         return "success";
     }

SkyWalking

Untuk prosedur instrumentasi lengkap, lihat Plugin Java Agent.

SkyWalking saat ini hanya menyediakan Java Agent untuk instrumentasi. Anda hanya perlu mengikuti petunjuk dalam dokumen tertaut untuk mengorelasikan RUM dan jejak backend.

Pencocokan protokol: Protokol sw8 (v3) yang dikonfigurasi di sisi RUM sesuai dengan agen SkyWalking 8.x.

OpenTelemetry

Untuk prosedur instrumentasi lengkap, lihat Laporkan data aplikasi Go menggunakan OpenTelemetry.

Ikuti dokumentasi untuk menginstrumentasi aplikasi Anda. Kemudian, hasilkan rentang dari konteks permintaan di penanganan permintaan HTTP untuk mengorelasikannya dengan jejak RUM.

// Inisialisasi tracer.
tracer := otel.Tracer(common.TraceInstrumentationName)
// Hasilkan rentang dari konteks permintaan.
handler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
    ctx := req.Context()
    span := trace.SpanFromContext(ctx)
    // lakukan sesuatu
    w.Write([]byte("Hello World"))
})

SkyWalking

Untuk prosedur instrumentasi lengkap, lihat Laporkan data aplikasi Go menggunakan SkyWalking.

Ikuti dokumentasi untuk menginstrumentasi aplikasi Anda. Kami merekomendasikan menggunakan metode skywalking-go, yang mendukung framework web utama seperti Gin, go-restful, http, go-kratos v2, go-micro, dan go-resty. Hal ini memungkinkan Anda mengorelasikan jejak RUM tanpa modifikasi kode.

Untuk mengurai konteks jejak secara manual dari header permintaan HTTP, gunakan kode berikut:

// Ekstrak konteks dari header permintaan HTTP 'sw8'.
span, ctx, err := tracer.CreateEntrySpan(r.Context(), "/api/test", func(key string) (string, error) {
		return r.Header.Get(key), nil
})

OpenTelemetry

Untuk prosedur instrumentasi lengkap, lihat Laporkan data aplikasi Python menggunakan OpenTelemetry.

Ikuti dokumentasi untuk menginstrumentasi aplikasi Anda. Kemudian, uraikan konteks rentang dari header permintaan HTTP untuk mengorelasikan dengan jejak RUM. Berikut adalah contoh kodenya:

# Inisialisasi tracer.
trace.set_tracer_provider(TracerProvider())
trace.get_tracer_provider().add_span_processor(BatchSpanProcessor(ConsoleSpanExporter()))

tracer = trace.get_tracer(__name__)

@app.route('/test')
def test():
    headers = dict(request.headers)

    # Uraikan konteks jejak dari header.
    carrier ={'traceparent': headers['Traceparent'], 'tracestate': headers['Tracestate']}
    ctx = TraceContextTextMapPropagator().extract(carrier=carrier)

    with tracer.start_span("test", context=ctx):
        # lakukan sesuatu
        return "success"

SkyWalking

Untuk prosedur instrumentasi lengkap, lihat Laporkan data aplikasi Python menggunakan SkyWalking.

Ikuti dokumentasi untuk menginstrumentasi aplikasi Anda. Kemudian, uraikan konteks rentang dari header permintaan HTTP untuk mengorelasikan dengan jejak RUM. Berikut adalah contoh kodenya:

from skywalking import config, agent
from skywalking.trace.context import SpanContext, get_context
from skywalking.trace.carrier import CarrierItem

# Konfigurasi SkyWalking. Sesuaikan parameter sesuai kebutuhan.
config.init(agent_collector_backend_services='<endpoint>',
            agent_authentication='<auth-token>')

agent.start()

# Contoh penanganan permintaan HTTP yang memerlukan header permintaan HTTP.
def handle_request(headers):
    # Ekstrak informasi jejak dari header permintaan.
    carrier_items = []
    for item in SpanContext.make_carrier():
        carrier_header = headers.get(item.key.lower())
        if carrier_header:
            carrier_items.append(CarrierItem(item.key, carrier_header))

    carrier = SpanContext.make_carrier(carrier_items)

    # Ekstrak konteks jejak dari carrier.
    context = get_context().extract(carrier)
    
    # Buat rentang baru untuk memproses permintaan.
    with get_context().new_entry_span(op='operation_name') as span:
        # Proses permintaan di sini. Rentang secara otomatis dikirimkan saat selesai.
        ...

# Simulasikan header permintaan HTTP yang diterima yang mencakup sw8.
incoming_headers = {
    'sw8': '1-My40LjU=-MTY1MTcwNDI5OTk5OA==-xxxx-xx-x-x==',  # Nilai contoh. Gunakan nilai aktual dari permintaan.
    # Header lainnya...
}

# Panggil fungsi untuk memproses permintaan.
handle_request(incoming_headers)