Halaman ini diterjemahkan oleh Cloud Translation API.

Membuat trace dan metrik dengan Python

Dokumen ini menjelaskan cara memodifikasi aplikasi Python untuk mengumpulkan data pelacakan dan metrik menggunakan framework OpenTelemetry open source, dan cara menulis log JSON terstruktur ke standard out. Dokumen ini juga memberikan informasi tentang contoh aplikasi Python yang dapat Anda instal dan jalankan. Aplikasi ini menggunakan framework web Flask dan dikonfigurasi untuk menghasilkan metrik, trace, dan log.

Tentang instrumentasi manual dan otomatis

Untuk bahasa ini, OpenTelemetry menetapkan instrumentasi otomatis sebagai praktik pengumpulan telemetri dari library dan framework tanpa membuat perubahan kode. Namun, Anda memiliki modul penginstalan dan menetapkan variabel lingkungan.

Dokumen ini tidak menjelaskan instrumentasi otomatis. Untuk mengetahui informasi tentang topik tersebut, lihat Instrumentasi Otomatis untuk Python.

Untuk mengetahui informasi umum, lihat Instrumentasi OpenTelemetry untuk Python.

Sebelum memulai

Enable the Cloud Logging, Cloud Monitoring, and Cloud Trace APIs.

Enable the APIs

Melengkapi aplikasi untuk mengumpulkan trace, metrik, dan log

Untuk melengkapi aplikasi Anda guna mengumpulkan data pelacakan dan metrik serta menulis JSON terstruktur ke standard out, lakukan langkah-langkah berikut seperti yang dijelaskan di bagian selanjutnya dari dokumen ini:

Mengonfigurasi OpenTelemetry
Mengonfigurasi logging terstruktur

Konfigurasi OpenTelemetry

Aplikasi contoh ini dikonfigurasi untuk menggunakan OpenTelemetry Python SDK untuk mengekspor rekaman aktivitas dan metrik dengan menggunakan protokol OTLP. Secara default, OpenTelemetry Python SDK menggunakan format Konteks Rekaman Aktivitas W3C untuk menyebarkan konteks rekaman aktivitas, yang memastikan bahwa span memiliki hubungan induk-turunan yang benar dalam rekaman aktivitas.

Contoh kode berikut mengilustrasikan modul Python untuk menyiapkan OpenTelemetry. Untuk melihat contoh lengkap, klik Lainnya, lalu pilih Lihat di GitHub.

resource = Resource.create(attributes={
    # Use the PID as the service.instance.id to avoid duplicate timeseries
    # from different Gunicorn worker processes.
    SERVICE_INSTANCE_ID: f"worker-{os.getpid()}",
})

traceProvider = TracerProvider(resource=resource)
processor = BatchSpanProcessor(OTLPSpanExporter())
traceProvider.add_span_processor(processor)
trace.set_tracer_provider(traceProvider)

reader = PeriodicExportingMetricReader(
    OTLPMetricExporter()
)
meterProvider = MeterProvider(metric_readers=[reader], resource=resource)
metrics.set_meter_provider(meterProvider)

Aplikasi Flask mengandalkan Gunicorn untuk melayani permintaan HTTP dengan mengikuti rekomendasi dalam panduan Deploying to Production oleh Flask. Gunicorn memulai beberapa salinan aplikasi yang berjalan dalam proses pekerja independen untuk meningkatkan throughput. Untuk memastikan metrik dari proses pekerja tidak saling bertentangan, sebaiknya setiap proses pekerja menetapkan nilai unik untuk atribut resource service.instance.id. Salah satu cara untuk melakukannya adalah dengan menyertakan ID proses di service.instance.id. Untuk informasi selengkapnya, lihat Konflik deret waktu.

Untuk mengetahui informasi selengkapnya dan opsi konfigurasi, lihat instrumentasi OpenTelemetry Python.

Mengonfigurasi logging terstruktur

Untuk menulis log terstruktur yang ditautkan ke trace, konfigurasi aplikasi Anda agar menghasilkan log berformat JSON untuk standard out dengan kunci yang berisi informasi trace. Contoh kode berikut menggambarkan cara mengonfigurasi library logging standar untuk menghasilkan log terstruktur JSON menggunakan library python-json-logger, dan cara menggunakan paket opentelemetry-instrumentation-logging untuk menyertakan informasi rekaman aktivitas.

LoggingInstrumentor().instrument()

logHandler = logging.StreamHandler()
formatter = jsonlogger.JsonFormatter(
    "%(asctime)s %(levelname)s %(message)s %(otelTraceID)s %(otelSpanID)s %(otelTraceSampled)s",
    rename_fields={
        "levelname": "severity",
        "asctime": "timestamp",
        "otelTraceID": "logging.googleapis.com/trace",
        "otelSpanID": "logging.googleapis.com/spanId",
        "otelTraceSampled": "logging.googleapis.com/trace_sampled",
        },
    datefmt="%Y-%m-%dT%H:%M:%SZ",
)
logHandler.setFormatter(formatter)
logging.basicConfig(
    level=logging.INFO,
    handlers=[logHandler],
)

Konfigurasi sebelumnya mengekstrak informasi tentang span aktif dari pesan log, lalu menambahkan informasi tersebut sebagai atribut ke log terstruktur JSON. Atribut ini kemudian dapat digunakan untuk mengkorelasikan log dengan trace:

logging.googleapis.com/trace: Nama resource trace yang terkait dengan entri log.
logging.googleapis.com/spanId: ID span dengan pelacakan yang dikaitkan dengan entri log.
logging.googleapis.com/trace_sampled: Nilai kolom ini harus true atau false.

Untuk mengetahui informasi selengkapnya tentang kolom ini, lihat struktur LogEntry.

Menjalankan aplikasi contoh yang dikonfigurasi untuk mengumpulkan telemetri

Aplikasi contoh menggunakan format yang tidak bergantung pada vendor, termasuk JSON untuk log dan OTLP untuk metrik dan trace. Telemetri dari aplikasi dirutekan ke Google Cloud menggunakan Collector OpenTelemetry yang dikonfigurasi dengan pengekspor Google. Library ini menggunakan Flask untuk menyalurkan permintaan HTTP, dan library requests untuk membuat permintaan HTTP. Untuk membuat metrik dan trace untuk klien dan server HTTP, aplikasi contoh menginstal library instrumentasi opentelemetry-instrumentation-flask dan opentelemetry-instrumentation-requests:

logger = logging.getLogger(__name__)

app = Flask(__name__)
FlaskInstrumentor().instrument_app(app)
RequestsInstrumentor().instrument()

Aplikasi ini memiliki dua endpoint:

Endpoint /multi ditangani oleh fungsi multi. Generator beban di aplikasi mengeluarkan permintaan ke endpoint /multi. Saat menerima permintaan, endpoint ini akan mengirimkan antara tiga hingga tujuh permintaan ke endpoint /single di server lokal.

@app.route('/multi')
def multi():
    """Handle an http request by making 3-7 http requests to the /single endpoint."""
    subRequests = randint(3, 7)
    logger.info("handle /multi request", extra={'subRequests': subRequests})
    for _ in range(subRequests):
        requests.get(url_for('single', _external=True))
    return 'ok'

Endpoint /single ditangani oleh fungsi single. Saat menerima permintaan, endpoint ini akan tidur dalam waktu singkat, lalu merespons dengan string.

@app.route('/single')
def single():
    """Handle an http request by sleeping for 100-200 ms, and write the number of seconds slept as the response."""
    duration = uniform(0.1, 0.2)
    time.sleep(duration)
    return f'slept {duration} seconds'

Mendownload dan men-deploy aplikasi

Untuk menjalankan contoh, lakukan hal berikut:

Di konsol Google Cloud, aktifkan Cloud Shell.

Aktifkan Cloud Shell

Di bagian bawah Google Cloud Console, Cloud Shell sesi akan terbuka dan menampilkan perintah command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi sesi.

Meng-cloning repository

git clone https://github.com/GoogleCloudPlatform/opentelemetry-operations-python

Buka direktori contoh:

cd opentelemetry-operations-python/samples/instrumentation-quickstart

Buat dan jalankan contoh:

docker compose up --abort-on-container-exit

Jika Anda tidak menjalankan Cloud Shell, jalankan aplikasi dengan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS yang mengarah ke file kredensial. Kredensial Default Aplikasi menyediakan file kredensial di $HOME/.config/gcloud/application_default_credentials.json.

# Set environment variables
export GOOGLE_CLOUD_PROJECT="PROJECT_ID"
export GOOGLE_APPLICATION_CREDENTIALS="$HOME/.config/gcloud/application_default_credentials.json"
export USERID="$(id -u)"

# Run
docker compose -f docker-compose.yaml -f docker-compose.creds.yaml up --abort-on-container-exit

Melihat metrik Anda

Instrumentasi OpenTelemetry di aplikasi contoh menghasilkan metrik Prometheus yang dapat Anda tampilkan menggunakan Metrics Explorer:

Prometheus/http_server_duration_milliseconds/histogram mencatat durasi permintaan server dan menyimpan hasilnya dalam histogram.
Prometheus/http_client_duration_milliseconds/histogram mencatat durasi permintaan klien dan menyimpan hasilnya dalam histogram.

Untuk melihat metrik yang dihasilkan oleh aplikasi contoh, lakukan hal berikut:

Di konsol Google Cloud, buka halaman Metrics Explorer:
Buka Metrics Explorer

Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil dengan subjudulnya adalah Monitoring.
Di elemen Metric, luaskan menu Select a metric, masukkan http_server di panel filter, lalu gunakan submenu untuk memilih jenis resource dan metrik tertentu:
1. Di menu Active resources, pilih Prometheus Target.
2. Di menu Active metric criteria, pilih Http.
3. Di menu Metrik aktif, pilih metrik.
4. Klik Apply.
Konfigurasi cara data ditampilkan.
Jika pengukuran untuk metrik bersifat kumulatif, Metrics Explorer otomatis menormalisasi data yang diukur berdasarkan periode penyelarasan, sehingga diagram akan menampilkan rasio. Untuk mengetahui informasi selengkapnya, lihat Jenis, jenis, dan konversi.

Saat nilai bilangan bulat atau ganda diukur, seperti dengan dua metrik counter, Metrics Explorer otomatis menjumlahkan semua deret waktu. Untuk melihat data rute HTTP /multi dan /single, tetapkan menu pertama entri Aggregation ke None.

Untuk informasi selengkapnya tentang cara mengonfigurasi diagram, lihat Memilih metrik saat menggunakan Metrics Explorer.

Melihat trace Anda

Untuk melihat data trace, lakukan langkah berikut:

Di konsol Google Cloud, buka halaman Trace explorer:
Buka Trace explorer

Anda juga dapat menemukan halaman ini dengan menggunakan kotak penelusuran.
Di diagram sebar, pilih rekaman aktivitas dengan URI /multi.
Pada diagram Gantt di panel Trace details, pilih span yang berlabel /multi.

Sebuah panel yang menampilkan informasi tentang permintaan HTTP akan terbuka. Detail ini mencakup metode, kode status, jumlah byte, dan agen pengguna pemanggil.
Untuk melihat log yang terkait dengan rekaman aktivitas ini, pilih tab Logs & Events.

Tab ini menunjukkan log individual. Untuk melihat detail entri log, luaskan entri log. Anda juga dapat mengklik View Logs dan melihat log menggunakan Logs Explorer.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan penjelajah Cloud Trace, lihat Menemukan dan menjelajahi trace.

Melihat log

Dari Logs Explorer, Anda dapat memeriksa log, dan Anda juga dapat melihat rekaman aktivitas terkait, jika ada.

Di konsol Google Cloud, buka halaman Logs Explorer:
Buka Logs Explorer

Jika menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil dengan subjudul Logging.
Temukan log dengan deskripsi handle /multi request.

Untuk melihat detail log, luaskan entri log.
Klik Traces pada entri log dengan pesan "handle /multi request", lalu pilih View trace details.

Panel Trace details akan terbuka dan menampilkan trace yang dipilih.

Untuk mengetahui informasi selengkapnya tentang penggunaan Logs Explorer, baca Melihat log menggunakan Logs Explorer.