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

Agen ARMS

Agen ARMS Application Monitoring memiliki dukungan bawaan untuk protokol OpenTelemetry, sehingga tidak diperlukan konfigurasi tambahan untuk mengorelasikan dengan jejak RUM. Namun, pastikan hal berikut:

• Versi agen ARMS Application Monitoring yang didukung: 2.x, 3.x, dan 4.x. Untuk pengalaman yang lebih baik, kami merekomendasikan peningkatan ke versi 4.x.

• Agen mendukung kontainer web utama seperti Tomcat, Jetty, WebLogic, dan Undertow, serta framework seperti Spring Boot dan Spring MVC. Untuk daftar lengkap komponen dan framework yang didukung, lihat Java Components and Frameworks Supported by Application Monitoring.

Untuk petunjuk cara mengintegrasikan agen ARMS Application Monitoring, lihat Start Monitoring a Java Application.

OpenTelemetry

Anda dapat mengintegrasikan aplikasi Anda dengan ARMS (Managed Service for OpenTelemetry) menggunakan OpenTelemetry. Tersedia dua metode: auto instrumentation dan manual instrumentation.

• Untuk auto instrumentation, OpenTelemetry sudah mendukung sebagian besar framework utama. Tidak diperlukan konfigurasi tambahan untuk mengorelasikan dengan jejak RUM.

  Catatan

  Untuk daftar framework Java yang didukung oleh OpenTelemetry, lihat Report Java Application Data by Using OpenTelemetry.

• Untuk manual instrumentation, Anda harus menggunakan mekanisme ekstensi yang disediakan oleh SDK OpenTelemetry untuk mengorelasikan dengan jejak RUM. Ini melibatkan penguraian konteks jejak dari header permintaan antarmuka depan (traceparent, tracestate). Berikut adalah contoh kode untuk skenario Spring Boot:

  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 W3C Propagator 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 W3C Propagator di sini.
             .setPropagators(ContextPropagators.create(
                     TextMapPropagator.composite(W3CTraceContextPropagator.getInstance(), W3CBaggagePropagator.getInstance()))
              ).buildAndRegisterGlobal();
     // Gunakan Tracer yang diperluas di sini.
     tracer = ExtendedTracer.create(openTelemetry.getTracer("com.example.tracer", "1.0.0"));

  3. Dalam metode controller Anda, tambahkan parameter headers dan uraikan konteks jejak dari header permintaan untuk mengatur parent.

     // Tambahkan parameter header permintaan ke 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 headers.
                 .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";
     }

Jaeger

Jaeger menyediakan dua metode untuk skenario web: manual instrumentation dan instrumentation dengan komponen Spring Cloud. Untuk petunjuk integrasi lengkap, lihat Report Java Application Data by Using Jaeger.

• Jika Anda menggunakan instrumentation dengan komponen Spring Cloud, tidak diperlukan konfigurasi tambahan untuk mengorelasikan dengan jejak RUM.

• Untuk manual instrumentation, Anda perlu mengurai konteks jejak dari header permintaan antarmuka depan. Lihat kode di bawah ini.

  1. Tambahkan dependensi.

     <dependency>
       <groupId>io.jaegertracing</groupId>
       <artifactId>jaeger-client</artifactId>
       <version>Latest Version</version> <!-- Pastikan menggunakan versi Jaeger terbaru. -->
     </dependency>

  2. Inisialisasi Tracer.

     Ganti <endpoint> dengan endpoint untuk klien dan wilayah yang sesuai dari halaman Cluster Configurations > Endpoint Information di konsol Managed Service for OpenTelemetry.

     // Ganti manualDemo dengan nama aplikasi Anda.
     io.jaegertracing.Configuration config = new io.jaegertracing.Configuration("manualDemo");
     io.jaegertracing.Configuration.SenderConfiguration sender = new io.jaegertracing.Configuration.SenderConfiguration();
     // Ganti <endpoint> dengan endpoint untuk klien dan wilayah yang sesuai dari halaman ikhtisar konsol.
     sender.withEndpoint("<endpoint>");
     config.withSampler(new io.jaegertracing.Configuration.SamplerConfiguration().withType("const").withParam(1));
     config.withReporter(new io.jaegertracing.Configuration.ReporterConfiguration().withSender(sender).withMaxQueueSize(10000));
     GlobalTracer.register(config.getTracer());

  3. Buat span di antarmuka bisnis Anda. Anda dapat merujuk pada kode berikut untuk mengorelasikan jejak.

     // Tambahkan parameter header permintaan ke Controller untuk mengurai konteks jejak.
     @RequestMapping("/test")
     public String test(@RequestHeader Map<String, String> headers) {
         Tracer tracer = GlobalTracer.get();
         SpanContext parentCtx = tracer.extract(Format.Builtin.HTTP_HEADERS, new TextMapAdapter(headers));
         Span span;
         if (parentCtx != null) {
             span = tracer.buildSpan("/test").asChildOf(parentCtx).start();
         } else {
             span = tracer.buildSpan("/test").start();
         }
         try (Scope ignored = tracer.activateSpan(span)) {
             tracer.activeSpan().setTag("methodName", "test");
             // lakukan sesuatu
         } catch (Throwable t) {
             TracingHelper.onError(e, span);
             throw e
         } finally {
             span.finish();
         }
         return "success";
     }

Zipkin

Untuk petunjuk integrasi lengkap, lihat Report Java Application Data by Using Zipkin.

Ikuti petunjuk integrasi dalam dokumen tersebut, lalu uraikan konteks dari header permintaan di kode sisi server untuk mengorelasikan dengan jejak RUM.

// Ekstrak konteks dari header permintaan.
extractor = tracing.propagation().extractor(Request::getHeader);

// ubah konteks tersebut menjadi span yang dapat Anda beri nama dan tambahkan tag
oneWayReceive = nextSpan(tracer, extractor.extract(request))
.name("process-request")
.kind(SERVER)
... tambahkan tag dll.

// mulai sisi server dan flush alih-alih finish
oneWayReceive.start().flush();

// Anda tidak boleh lagi memodifikasi span ini karena sudah selesai. Namun,
// Anda dapat membuat child untuk merepresentasikan pekerjaan lanjutan.
next = tracer.newSpan(oneWayReceive.context()).name("step2").start();

SkyWalking

Untuk petunjuk integrasi lengkap, lihat Java Agent Plugin.

Integrasi SkyWalking ditangani oleh agen Java. Anda hanya perlu mengikuti petunjuk dalam dokumen untuk mengorelasikan jejak RUM dan backend.

Untuk memastikan kompatibilitas protokol dengan RUM, protokol sw8 (v3) sesuai dengan agen SkyWalking 8.x.

OpenTelemetry

Untuk petunjuk integrasi lengkap, lihat Report Go Application Data by Using OpenTelemetry.

Ikuti petunjuk integrasi, lalu hasilkan span dari konteks permintaan di handler permintaan HTTP untuk mengorelasikan dengan jejak RUM.

// Inisialisasi tracer.
tracer := otel.Tracer(common.TraceInstrumentationName)
// Hasilkan span 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"))
})

Jaeger

Untuk petunjuk integrasi lengkap, lihat Report Go Application Data by Using Jaeger.

Ikuti petunjuk integrasi, lalu uraikan konteks span dari header permintaan HTTP untuk mengorelasikan dengan jejak RUM. Lihat kode di bawah ini.

// Ekstrak spanCtx dari objek HTTP.
spanCtx, _ := tracer.Extract(opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(r.Header))
span := tracer.StartSpan("myspan", opentracing.ChildOf(spanCtx))
...
defer  span.Finish()

Zipkin

Untuk petunjuk integrasi lengkap, lihat Report Go Application Data by Using Zipkin.

Ikuti petunjuk integrasi, lalu uraikan konteks span dari header permintaan HTTP untuk mengorelasikan dengan jejak RUM. Lihat kode di bawah ini.

// Inisialisasi tracer.
tracer, err := exampletracer.NewTracer("go-frontend", frontendPort)
// Hasilkan span dari konteks permintaan.
router.Methods("GET").Path("/").HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    // ambil span dari konteks
	span := zipkin.SpanFromContext(r.Context())
    // tambahkan beberapa tag
    span.Tag("some_key", "some_value")
    // lakukan sesuatu...
	span.Annotate(time.Now(), "some_event")
})

SkyWalking

Untuk petunjuk integrasi lengkap, lihat Report Go Application Data by Using SkyWalking.

Ikuti petunjuk integrasi. Kami merekomendasikan menggunakan metode integrasi skywalking-go, yang mendukung framework web utama seperti gin, go-restful, http, go-kratos v2, go-micro, dan go-resty, serta mengorelasikan dengan jejak RUM tanpa memerlukan perubahan kode.

Jika Anda ingin secara manual mengurai konteks jejak dari header permintaan HTTP, Anda juga dapat menggunakan 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 petunjuk integrasi lengkap, lihat Report Python Application Data by Using OpenTelemetry.

Ikuti petunjuk integrasi, lalu uraikan konteks span dari header permintaan HTTP untuk mengorelasikan dengan jejak RUM. Lihat kode di bawah ini.

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

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

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

Jaeger

Untuk petunjuk integrasi lengkap, lihat Report Python Application Data by Using Jaeger.

Ikuti petunjuk integrasi, lalu uraikan konteks span dari header permintaan HTTP untuk mengorelasikan dengan jejak RUM. Lihat kode di bawah ini.

import logging
from flask import Flask
from jaeger_client import Config
from opentracing.ext import tags
from opentracing.propagation import Format

# Inisialisasi tracer.
def init_tracer(service, scope_manager=None):
    logging.getLogger('').handlers = []
    logging.basicConfig(format='%(message)s', level=logging.DEBUG)

    config = Config(
        config={
            'sampler': {
                'type': 'const',
                'param': 1,
            },
            'logging': True,
            'reporter_batch_size': 1,
        },
        service_name=service,
        scope_manager=scope_manager
    )
    return config.initialize_tracer()

# Dekorator trace.
def trace(tracer, span_name):
    def decorator(f):
        @functools.wraps(f)
        def wrapped(*args, **kwargs):
            # Ekstrak konteks jejak dari headers.
            span_ctx = tracer.extract(Format.HTTP_HEADERS, request.headers)
            span_tags = {tags.SPAN_KIND: tags.SPAN_KIND_RPC_SERVER}

            with tracer.start_active_span(span_name, child_of=span_ctx, tags=span_tags) as scope:
                rv = f(*args, **kwargs)

            return rv
        return wrapped
    return decorator

# Contoh uji API.
@app.route('/test')
@trace(tracer, 'test')
def test():
    return "success"

SkyWalking

Untuk petunjuk integrasi lengkap, lihat Report Python Application Data by Using SkyWalking.

Ikuti petunjuk integrasi, lalu uraikan konteks span dari header permintaan HTTP untuk mengorelasikan dengan jejak RUM. Lihat kode di bawah ini.

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

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

agent.start()

# Contoh handler permintaan HTTP. Teruskan 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 span baru untuk menangani permintaan.
    with get_context().new_entry_span(op='operation_name') as span:
        # Tangani permintaan di sini. Span dikirimkan secara otomatis saat selesai.
        ...

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

# Panggil fungsi untuk menangani permintaan.
handle_request(incoming_headers)