Application Real-Time Monitoring Service:Laporkan data jejak dari aplikasi Python menggunakan OpenTelemetry

Langkah 1: Instal dependensi

pip install django
pip install requests
pip install opentelemetry-distro \
	opentelemetry-exporter-otlp

opentelemetry-bootstrap -a install

opentelemetry-bootstrap mendeteksi library yang terinstal dan secara otomatis menginstal plug-in instrumentasi yang sesuai.

Langkah 2: Buat proyek dan aplikasi Django

1. Buat proyek AutoAndManualDemo:

      django-admin startproject AutoAndManualDemo

2. Buat aplikasi HelloWorld dalam proyek tersebut:

      cd AutoAndManualDemo
   
      # Buat aplikasi HelloWorld dalam proyek.
      python manage.py startapp helloworld

Langkah 3: Tambahkan kode aplikasi

1. Tambahkan kode berikut ke file AutoAndManualDemo/helloworld/views.py:

      from django.http import HttpResponse
      from datetime import datetime
   
      # Create your views here.
      def hello_world_view(request):
          result = "Hello World!  Current Time =" + str(get_time())
          return HttpResponse(result)
   
      def get_time():
          now = datetime.now()
          return now.strftime("%H:%M:%S")

2. Buat file AutoAndManualDemo/helloworld/urls.py dan tambahkan kode berikut:

      from django.urls import path
   
      from . import views
   
      urlpatterns = [
          path('', views.hello_world_view, name='helloworld')
      ]

3. Tambahkan pola URL ke file AutoAndManualDemo/AutoAndManualDemo/urls.py:

      from django.contrib import admin
      from django.urls import path, include
   
      urlpatterns = [
       path('admin/', admin.site.urls),
       path('helloworld/', include('helloworld.urls')),
      ]

Langkah 4: Jalankan aplikasi Anda

Tambahkan awalan perintah start Anda dengan opentelemetry-instrument dan sertakan konfigurasi eksporter.

Laporkan melalui HTTP

opentelemetry-instrument \
    --traces_exporter console,otlp_proto_http \
    --metrics_exporter none \
    --service_name <your-service-name> \
    --exporter_otlp_traces_endpoint <endpoint> \
    python manage.py runserver --noreload

Jika Anda tidak ingin konsol menampilkan data jejak, atur parameter --traces_exporter menjadi otlp_proto_http.

  export DJANGO_SETTINGS_MODULE=AutoAndManualDemo.settings

Langkah 5: Verifikasi pelaporan jejak

1. Buka http://127.0.0.1:8000/helloworld/ di browser. Konsol akan menampilkan data jejak dan melaporkan data tersebut ke Managed Service for OpenTelemetry.

2. Masuk ke Konsol ARMS.

3. Di panel navigasi kiri, pilih Application Monitoring > Applications.

4. Di halaman Applications, temukan aplikasi Anda berdasarkan nama layanan yang telah Anda konfigurasi, lalu klik aplikasi tersebut.

5. Di halaman detail aplikasi, verifikasi bahwa jejak muncul. Anda akan melihat data rentang yang sesuai dengan permintaan yang telah Anda kirim.

Catatan Jika ikon muncul di kolom Language, berarti aplikasi terhubung ke Application Monitoring. Tanda hubung (-) menunjukkan koneksi ke Managed Service for OpenTelemetry.

Langkah 1: Instal dependensi

pip install opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp

Langkah 2: Inisialisasi OpenTelemetry

Buat modul inisialisasi (misalnya, manual.py) yang mengonfigurasi penyedia tracer dan eksporter.

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
    OTLPSpanExporter as OTLPSpanGrpcExporter,
)
from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
    OTLPSpanExporter as OTLPSpanHttpExporter,
)
from opentelemetry.sdk.resources import SERVICE_NAME, HOST_NAME, Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor


def init_opentelemetry():
    resource = Resource(attributes={
        SERVICE_NAME: "<your-service-name>",
        HOST_NAME: "<host-name>",
    })

    # Opsi A: Ekspor melalui gRPC
    span_processor = BatchSpanProcessor(OTLPSpanGrpcExporter(
        endpoint="<endpoint>",
        headers=("Authentication=<token>"),
    ))

    # Opsi B: Ekspor melalui HTTP (hapus komentar untuk menggunakan)
    # span_processor = BatchSpanProcessor(OTLPSpanHttpExporter(
    #     endpoint="<endpoint>",
    # ))

    trace_provider = TracerProvider(
        resource=resource,
        active_span_processor=span_processor,
    )
    trace.set_tracer_provider(trace_provider)

Langkah 3: Buat rentang

Setelah inisialisasi, ambil tracer dan buat rentang untuk melacak operasi.

tracer = trace.get_tracer(__name__)

# Pola context manager
with tracer.start_as_current_span("child_span") as child_span:
    print("hello world")

Sarangkan rentang untuk merepresentasikan hubungan induk-anak:

def outer_method():
    tracer = trace.get_tracer(__name__)
    with tracer.start_as_current_span("parent_span") as parent_span:
        inner_method()

def inner_method():
    tracer = trace.get_tracer(__name__)
    with tracer.start_as_current_span("child_span") as child_span:
        print("hello world")

Langkah 4: Ambil ID jejak dan ID rentang

Ambil ID jejak dan ID rentang dari konteks rentang saat ini. ID ini berguna untuk mengorelasikan log dengan jejak.

ctx = trace.get_current_span().get_span_context()
trace_id = '{trace:032x}'.format(trace=ctx.trace_id)
span_id = '{span:016x}'.format(span=ctx.span_id)
print(trace_id)
print(span_id)

Langkah 5: Propagasikan metadata kustom dengan API Baggage

API Baggage OpenTelemetry mempropagasikan pasangan kunci-nilai di seluruh rentang dalam satu jejak. Gunakan baggage untuk meneruskan metadata—seperti ID pengguna, ID penyewa, atau konteks permintaan—antar layanan.

from opentelemetry import trace, baggage

def baggage_and_attribute_usage():
    tracer = trace.get_tracer(__name__)

    # Atur baggage di tingkat global
    global_ctx = baggage.set_baggage("key", "value_from_global_ctx")

    # Buat rentang dengan atribut kustom
    with tracer.start_as_current_span(
        name='baggage_parent_span',
        attributes={'attribute_key': 'value'},
    ) as baggage_parent_span:

        # Atur baggage dalam konteks induk
        parent_ctx = baggage.set_baggage("key", "value_from_parent_ctx")

        with tracer.start_as_current_span(
            name='baggage_child_span',
            context=parent_ctx,
        ) as baggage_child_span:

            # Atur baggage dalam konteks anak
            child_ctx = baggage.set_baggage("key", "value_from_child_ctx")

    # Baca nilai baggage dari setiap konteks
    print(baggage.get_baggage("key", global_ctx))   # value_from_global_ctx
    print(baggage.get_baggage("key", parent_ctx))    # value_from_parent_ctx
    print(baggage.get_baggage("key", child_ctx))     # value_from_child_ctx

Langkah 6: Jalankan dan verifikasi

python manual.py

Setelah aplikasi dijalankan, verifikasi data jejak di konsol ARMS. Ikuti langkah-langkah pada bagian Verifikasi pelaporan jejak di bawah Instrumentasi Otomatis.

Langkah 1: Instal dependensi

pip install django
pip install requests
pip install opentelemetry-sdk
pip install opentelemetry-instrumentation-django
pip install opentelemetry-exporter-otlp

Langkah 2: Buat proyek dan aplikasi Django

1. Buat proyek AutoAndManualDemo:

      django-admin startproject AutoAndManualDemo

2. Buat aplikasi HelloWorld dalam proyek tersebut:

      cd AutoAndManualDemo
   
      # Buat aplikasi HelloWorld dalam proyek.
      python manage.py startapp helloworld

Langkah 3: Tambahkan rentang kustom ke kode Anda

Impor API trace OpenTelemetry dan buat rentang di sekitar operasi yang ingin Anda lacak.

Contoh view Django berikut menambahkan dua rentang kustom (hello_world_span dan time_span) di atas rentang yang dibuat secara otomatis oleh plug-in instrumentasi Django. Modifikasi file helloworld/views.py:

from django.http import HttpResponse
from opentelemetry import trace
from datetime import datetime


def hello_world_view(request):
    tracer = trace.get_tracer(__name__)

    with tracer.start_as_current_span("hello_world_span") as hello_world_span:
        result = "Hello World!  Current Time =" + str(get_time())
        return HttpResponse(result)


def get_time():
    now = datetime.now()
    tracer = trace.get_tracer(__name__)
    with tracer.start_as_current_span("time_span") as time_span:
        return now.strftime("%H:%M:%S")

Langkah 4: Modifikasi file urls.py

1. Buat file helloworld/urls.py dan tambahkan kode berikut:

      from django.urls import path
   
      from . import views
   
      urlpatterns = [
          path('', views.hello_world_view, name='helloworld')
      ]

2. Tambahkan pola URL ke file AutoAndManualDemo/AutoAndManualDemo/urls.py:

      from django.contrib import admin
      from django.urls import path, include
   
      urlpatterns = [
       path('admin/', admin.site.urls),
       path('helloworld/', include('helloworld.urls')),
      ]

Langkah 5: Konfigurasikan penyedia tracer

Buat modul inisialisasi yang menyiapkan eksporter dan penyedia tracer. Tambahkan kode berikut ke kode inisialisasi OpenTelemetry dalam file manual.py. Impor modul ini di awal startup aplikasi Anda (misalnya, di manage.py atau titik masuk WSGI/ASGI Anda).

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
# Untuk menggunakan HTTP, hapus komentar baris berikut dan beri komentar pada impor gRPC:
# from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.resources import SERVICE_NAME, HOST_NAME, Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter


resource = Resource(attributes={
    SERVICE_NAME: "<your-service-name>",
    HOST_NAME: "<host-name>",
})

trace.set_tracer_provider(TracerProvider(resource=resource))

# Ekspor jejak melalui gRPC
trace.get_tracer_provider().add_span_processor(
    BatchSpanProcessor(OTLPSpanExporter(
        endpoint="<endpoint>",
        headers="Authentication=<token>",  # Hanya diperlukan untuk gRPC
    ))
)

# Juga cetak jejak ke konsol (berguna untuk debugging)
trace.get_tracer_provider().add_span_processor(
    BatchSpanProcessor(ConsoleSpanExporter())
)

Langkah 6: Jalankan dan verifikasi

python manage.py runserver --noreload

  pip install grpcio

Kirim permintaan ke http://127.0.0.1:8000/helloworld/ dan verifikasi data jejak di konsol ARMS. Ikuti langkah-langkah pada bagian Verifikasi pelaporan jejak di bawah Instrumentasi Otomatis.