Skip to main content
Proyek adalah batas akses untuk telemetri. Setiap sinyal yang diterima termasuk dalam satu proyek, dan setiap perintah baca dapat memfilter berdasarkan proyek. Gunakan proyek terpisah jika telemetri butuh batas kepemilikan atau batas akses tersendiri. Bagi sebagian besar tim, itu berarti satu aplikasi, layanan, atau area produk. Satu repositori tidak harus sama dengan satu proyek. Sebuah monorepo dapat mengirim beberapa layanan ke satu proyek. Gunakan nama layanan untuk membedakannya.

Proyek, layanan, lingkungan

Siapkan proyek

Instal CLI. Jalankan logbrew status --json untuk membaca akses akun Anda. Jika akses tidak valid, manusia menjalankan logbrew login. Kunci ingest proyek tidak bisa dipakai untuk masuk.
1

Buat atau pilih proyek

Tampilkan daftar proyek Anda terlebih dahulu. Buat proyek hanya jika proyek itu belum ada.
CLI menulis kunci ingest ke file baru yang hanya bisa diakses pemiliknya. CLI tidak pernah menampilkan kunci itu atau path file-nya. Jika hasilnya tidak jelas, jalankan lagi perintah yang sama persis. Jangan ubah nama proyek atau file kunci. CLI memakai ulang identitas permintaannya yang tertunda. Mulai cepat menunjukkan cara membaca ID proyek dari hasilnya.Untuk proyek yang sudah ada, catat status penyiapannya:
Untuk membuat kunci ingest lain bagi proyek yang sudah ada, gunakan logbrew projects keys create. Panduan Rotasikan kunci ingest menunjukkan perintahnya.logbrew setup --create-project hanya menampilkan bantuan. Perintah itu tidak membuat proyek.
2

Tetapkan nama layanan di SDK

Gunakan nama dari repositori dan deployment Anda, seperti api, worker, web, ios, atau checkout-api. Nama layanan adalah label, bukan pemilih proyek. Kunci ingest yang memilih proyek. Mengganti nama layanan tidak memindahkan peristiwa yang tersimpan. Jika Anda tidak menemukan sebuah peristiwa, periksa proyek dan kunci ingest yang dipakai aplikasi sebelum Anda membuat proyek lain.
3

Gunakan lingkungan standar

Gunakan production, staging, preview, dan local. Jika deployment Anda memakai nama lain, gunakan nama itu secara konsisten. Nama lingkungan tidak boleh berisi spasi, /, atau garis miring terbalik.
4

Kirim peristiwa uji dan baca

Konfigurasikan SDK dengan kunci ingest proyek, seperti yang dijelaskan panduan Integrasi SDK. Membuat proyek tidak menginstal SDK di aplikasi Anda. Jangan simpan kunci di source control. Tetapkan layanan, lingkungan, dan rilis di aplikasi. Kirim satu peristiwa yang aman, lalu baca:
Setiap sinyal punya daftarnya sendiri. Daftar log yang kosong tidak berarti proyek tidak punya masalah atau trace.Di dasbor, pilih proyek yang sama dan rentang waktu yang mencakup peristiwa uji. Pastikan filter layanan, lingkungan, dan rilis cocok dengan peristiwa itu.

Diagnosis penyiapan proyek

Baca status penyiapan dengan doctor proyek. Jangan menyimpulkan status penyiapan dari file lokal atau kueri log yang kosong.
CLI mengembalikan laporan dengan status, checks, dan next. Kode keluar 0 tidak menunjukkan bahwa semua pemeriksaan lolos. Baca setiap item di checks. Lihat Baca laporan doctor proyek.

Respons API langsung

Klien API memanggil GET /api/projects/{project_id}/doctor dengan autentikasi akun. Endpoint ini tidak punya parameter kueri atau body permintaan. Jangan pernah memakai kunci ingest proyek untuk pembacaan ini. Respons 200 berisi kolom berikut: project_id, state, setup_status, setup_acknowledged, has_active_ingest_key, first_telemetry_seen_at, last_seen_at, last_signal, next, dan next_action. Stempel waktu berformat RFC3339 atau null. last_signal adalah ringkasan yang aman untuk ditampilkan, bukan sinyal mentah. Doctor memeriksa kunci ingest terlebih dahulu. Proyek tanpa kunci ingest yang aktif berstatus needs_ingest_key, apa pun status penyiapannya. setup_status bernilai created, setup_started, sdk_seen, first_telemetry_seen, atau active. setup_acknowledged bernilai true hanya untuk tiga nilai terakhir. created menghasilkan needs_setup. setup_started dan sdk_seen menghasilkan needs_telemetry. first_telemetry_seen dan active menghasilkan ready. Jika pembacaan tetap gagal, laporkan masalah. Jangan sertakan kredensial, header, body sinyal, data pelanggan, path lokal, atau kode sumber.

Arsipkan atau hapus proyek

Arsipkan proyek untuk menghapusnya dari daftar proyek aktif:
Perintah ini butuh --yes. Setelah diarsipkan, kunci ingest proyek berhenti menerima telemetri baru. Rute API-nya adalah DELETE /api/projects/{project_id}. Rute ini mengembalikan 204 tanpa body. Tampilkan daftar proyek yang diarsipkan dengan GET /api/projects/archived. Pulihkan proyek dengan POST /api/projects/{project_id}/restore, yang juga mengembalikan 204. Hapus proyek secara permanen hanya jika Anda yakin:
Ulangi ID proyek yang sama persis setelah --confirm. Permintaan yang diterima langsung membuat proyek tidak aktif dan menjadwalkan penghapusan permanen. Setelah itu, Anda tidak bisa memulihkan proyek.

Rotasikan kunci ingest

Panduan Rotasikan kunci ingest berisi prosedur penggantian, deployment, pengujian, dan pencabutan.