Error memakai envelope error API standar.
Pembacaan tanpa autentikasi akun yang valid mengembalikan
401 dengan
code: "unauthorized". Jangan tampilkan kegagalan itu sebagai penggunaan
nol, grafik kosong, atau paket gratis. Metode yang tidak didukung
mengembalikan 405 dengan code: "method_not_allowed", dan next
menyebutkan permintaan yang didukung.
API akun melaporkan penggunaan telemetri, bukan uang. API ini tidak
melaporkan biaya, faktur, atau status pembayaran.
Penggunaan akun
GET /api/account/usage adalah endpoint kanonis untuk penggunaan dan kuota.
Gunakan endpoint ini untuk total penggunaan, waktu reset, status kuota, serta
rincian per proyek dan per stream telemetri. Jangan menghitung penggunaan dari
file SDK, file CLI, atau penghitung di klien. Perintah CLI logbrew usage
membaca endpoint ini. Lihat Referensi CLI.
Peristiwa yang dibuang SDK
Kirimresponse_version=2 agar juga menerima sdk_dropped_events. Tanpa parameter ini, atau dengan response_version=1, respons tidak berisi kolom ini.
sdk_dropped_events mencantumkan peristiwa yang dilaporkan SDK sebagai dibuang sebelum dikirim pada periode saat ini, misalnya karena antrean klien penuh. Ada 1 baris untuk setiap proyek dan alasan:
Peristiwa yang dibuang tidak pernah sampai ke LogBrew. Peristiwa ini tidak ditagih dan tidak dihitung dalam
usage, by_project, atau by_stream. Array kosong jika tidak ada SDK yang melaporkan peristiwa yang dibuang.
Status kuota
Gunakanstate untuk percabangan utama. limit bernilai null hanya jika
state bernilai ok.
next_action.state, next_action.limit, dan next_action.reset_at
mengulang nilai di tingkat teratas. Nilai next_action.code juga mencakup
check_usage_limits dengan target account_usage. Jika klien menerima
pasangan itu, baca penggunaan lagi dan tampilkan next.
LogBrew mengukur setiap jenis telemetri terhadap kuotanya sendiri. limit
mengelompokkannya:
eventsmencakup peristiwa masalah dan span trace.bytesmencakup byte log dan byte metrik.
limit
menyebutkan kuota yang diblokir. Status warning dimulai saat penggunaan
mencapai warning_threshold dari suatu kuota. Status blocked dimulai saat
penggunaan mencapai kuota.
Teks next bisa berubah, misalnya saat paket tidak dijual. Nilai
next_action tidak berubah. Buat teks terjemahan berdasarkan next_action.
Jangan mem-parse next.
Batas penggunaan akun bukan batas laju API. Saat ingest melebihi kuota,
permintaan ingest mengembalikan 429 dengan usage_limit_exceeded, dan body
menambahkan limit dan reset_at. Dalam error itu, limit menyebutkan kuota
yang tepat: issue_events, log_bytes, metric_bytes, atau trace_spans.
LogBrew menolak seluruh permintaan. Jangan kirim jenis telemetri itu lagi
sampai reset_at atau sampai paket berubah. Saat klien mengirim terlalu
banyak permintaan, API mengembalikan rate_limited. Lihat
Error API.
Respons ini adalah snapshot. Baca lagi setelah akun berubah.
GET /api/logs/usage adalah respons kompatibilitas lama untuk aplikasi
seluler, dengan bytes_used, limit_bytes, dan month. Gunakan
GET /api/account/usage untuk integrasi baru.Riwayat penggunaan
GET /api/account/usage/history mengembalikan interval waktu penggunaan
dalam jumlah terbatas untuk grafik dan laporan. Interval waktu tanpa
penggunaan bernilai nol. Isi interval dengan salah satu nilai yang didukung.
Jika Anda tidak mengisi interval, API memakai monthly. Rute ini tidak
menerima kunci kueri lain.
Respons
yearly ini memakai data sintetis untuk permintaan pada Juni 2026.
Semua penggunaan terjadi pada bulan Juni:
current.reset_at untuk waktu reset kuota. Jangan pakai akhir rentang
waktu riwayat. current bukan jumlah dari semua interval waktu, dan
tanggalnya bisa berbeda dari tanggal rentang waktu riwayat.
Interval waktu terakhir berisi periode kalender saat ini, yang belum lengkap.
Waktu akhirnya yang ada di masa depan tidak berarti LogBrew mengukur
penggunaan di masa depan. Interval waktu yang berisi nol berarti LogBrew tidak
mencatat penggunaan apa pun di interval itu.
Di dalam satu interval waktu, usage.projects menghitung proyek yang punya
penggunaan di interval itu. Jangan jumlahkan angka ini untuk mendapatkan
jumlah proyek. Gunakan current.usage.projects untuk jumlah proyek yang
dimiliki.
Tampilkan peristiwa dan byte sebagai deret terpisah di grafik, karena
satuannya berbeda. Interval waktu berisi penggunaan, bukan biaya. Jangan beri
grafik label pengeluaran, faktur, atau permintaan API.
Interval yang tidak didukung mengembalikan 422:
422 dengan
validation_failed.
Kesiapan langganan
GET /api/account/subscription bersifat hanya baca. Gunakan endpoint ini untuk
memutuskan apakah kontrol paket berbayar atau organisasi diaktifkan. Gunakan
endpoint penggunaan untuk status kuota.
account_id di bawah ini
sintetis:
next adalah teks tampilan. Teks ini berubah saat paket berbayar dijual atau
tidak dijual. Tampilkan teks yang dikembalikan, atau buat teks terjemahan
berdasarkan next_action. Jangan meng-hard-code nama paket dari next.
Nilai enum:
Setiap penghambat punya satu pasangan
next_action:
Nilai tier adalah pengenal, bukan nama tampilan. Jangan ubah nilai itu di
klien yang dilokalkan. Akun berbayar tetap bisa diblokir. Periksa
organization_creation_allowed sebelum Anda mengaktifkan pembuatan
organisasi.
Endpoint ini tidak membuat organisasi, mengirim undangan, mengubah peran, atau
mengubah penagihan.
Keluar
Pilih lingkup terkecil yang sesuai dengan tugas. Endpoint ini tidak menghapus akun atau proyeknya, tidak merotasi kunci ingest, dan tidak mencabut izin yang diberikan penyedia login pihak ketiga.Satu login aplikasi atau CLI
Kirim permintaan dari klien yang memegang refresh token. AturContent-Type: application/json:
200:
200 yang sama. Jika token
tidak valid, kedaluwarsa, atau berupa token akses, responsnya 401 dengan
code: "unauthorized" dan next_action.code: "authorize_request". Dalam
kasus itu, hapus juga kredensial lokal. logbrew logout memakai endpoint ini.
Semua login LogBrew
Respons yang berhasil adalah200:
revoked_before bersifat inklusif dan punya presisi milidetik. LogBrew
menolak token akses, sesi browser, dan refresh token dari login pada atau
sebelum waktu itu. Token yang kemudian di-refresh dari login seperti itu juga
ditolak. Sesi feed langsung yang sedang berjalan berakhir, dan respons
menghapus cookie sesi browser. Login setelah waktu itu tetap valid. Setiap
klien harus menghapus kredensial LogBrew lokalnya dan masuk lagi.
Jangan masuk lagi lalu mengulangi permintaan ini secara otomatis. Permintaan
baru juga mencabut login yang baru.
Jika respons hilang, jangan laporkan bahwa semua login sudah dicabut. 401
yang muncul kemudian dari kredensial lama tidak menggantikan respons sukses.
Untuk langkah pemulihan lainnya, baca
Amankan akun yang disusupi.
Sesi browser
POST /api/auth/web/logout menghapus cookie browser logbrew_session dan
mengembalikan 204 No Content tanpa body. Panggil endpoint ini dari browser.
Jangan salin cookie sesi ke dalam perintah. Permintaan ini tidak mengeluarkan
klien lain, dan tidak mencabut salinan nilai cookie. Untuk mencabut setiap
sesi, gunakan Semua login LogBrew.
Pulihkan dari error saat keluar
Untuk rute telemetri, filter, dan paginasi, baca
API Telemetri.
