LogBrew dokümantasyonu

Uygulama veya framework seçin, Add Project içinde proje oluşturun ve CLI ile dashboard referanslarına geçmeden önce ilk sinyali doğrulayın.

Platform seçAdd Project'i aç

Platform seçin

Projeye uyan uygulama veya framework ile başla. Add Project içinde de aynı seçimi kullan.

Platformları filtrele
6 / 26 gösteriliyor

Node.js

Node.js servisi

Backend servisi log, request span, action, release ve metric gönderecekse Node.js paketini kullan.

npm install @logbrew/sdk @logbrew/node
Node ilk sinyal yolunu kullan

Express

Express servisi

Node servisi requestleri Express middleware ile işliyorsa Express paketini kullan.

npm install @logbrew/sdk @logbrew/express express
Add Project’i aç

Fastify

Fastify servisi

Node servisi route’ları Fastify pluginleriyle işliyorsa Fastify paketini kullan.

npm install @logbrew/sdk @logbrew/fastify fastify
Add Project’i aç

NestJS

NestJS servisi

Node servisi Nest modülleri ve request handling etrafında kurulmuşsa NestJS paketini kullan.

npm install @logbrew/sdk @logbrew/nestjs @nestjs/common @nestjs/core @nestjs/platform-express reflect-metadata rxjs
Add Project’i aç

Python

Python servisi

Python worker ve servisleri için core paketle başla.

python3 -m pip install logbrew-sdk
Add Project’i aç

Django

Django uygulaması

Django projesinden request ve app sinyalleri göndermek için Django paketini kullan.

python3 -m pip install logbrew-sdk logbrew-django
Add Project’i aç

Kurulum komutu

İlk başarılı SDK çalıştırması

İlk oturumu net tutun: paketi kurun, projeyi oluşturun, gizli veri içermeyen bir ürün aksiyonu gönderin ve LogBrew içinde doğrulayın.

  1. 1SDK'yı kurLog, span, aksiyon, sürüm ve metrik gönderen backend servisleri için Node paketlerini kullanın.
    npm install @logbrew/sdk @logbrew/node
  2. 2Projeyi oluşturAdd Project'i açın, platformu seçin ve setup panelindeki tek seferlik ingest kimliğini kopyalayın.Add Project'i aç
  3. 3Bir ürün aksiyonu gönderProduction kodunu bağlamadan önce paketli örneği çalıştırın; ilk şekil bilinir ve token içermeyen kalır.
    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs
  4. 4LogBrew'de doğrulaDaha fazla instrumentation eklemeden önce ilk info sinyalini loglarda okuyun.
    logbrew logs info --json
AI asistan bağlamı

Uygulamanızı veya kurulum komutunu düzenlemeden önce agenta herkese açık LogBrew haritasını verin.

curl -L https://logbrew.co/llms.txt
AI kurulum promptuhttps://logbrew.co/llms.txt içeriğini oku, sonra https://logbrew.co/en/docs#docs-sdk-choice-title üzerindeki doğru SDK kartını seç. npm install @logbrew/sdk @logbrew/node komutunu yalnızca server-side Node.js servisi için kullan; Next.js, React, iOS, Android veya React Native için seçilen kartı ve Add Project promptunu kullan. Oturum açmış kullanıcıdan Add Project'i açmasını ve kimlik bilgilerini yalnızca eşleşen uygulama ortamına koymasını iste. Server-side Node.js için env değişkeni LOGBREW_SERVER_API_KEY olur. node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs komutunu yalnızca Node servislerinde çalıştır, ardından logbrew logs info --json ile doğrula. Sohbette veya commitlerde kimlik bilgisi isteme.
Agent rehberini aç
İlk Node SDK sinyalini LogBrew'e gönder

Canlı proje verisi istediğinde bu Node yolunu kullan. Dashboard projeyi oluşturur ve tek seferlik ingest kimliğini gösterir; public docs sadece paketleri ve güvenli doğrulama adımlarını verir.

  1. JavaScript SDK paketlerini ekle

    Backend servisinin log, request span, action, release ve metric göndermesi için core SDK ve Node yardımcısıyla başla.

    npm install @logbrew/sdk @logbrew/node

  2. Projeyi Add Project ile oluştur

    Giriş yap, Add Project'i aç, platformu seç ve tek seferlik ingest kimliğini o setup panelinden kopyala. Panelden çıkınca website bunu tekrar göstermez.

    Add Project'i aç

  3. İlk SDK sinyali örneğini çalıştır

    Uygulamaya eklemeden önce release, environment, request span, product action, network milestone ve metric şeklini görmek için kurulu paket örneğini çalıştır.

    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs

  4. LogBrew'de ilk sinyali oku

    SDK proje kimliğiyle bir info sinyali gönderdikten sonra, daha fazla instrumentation eklemeden önce CLI veya dashboard logs görünümünden geldiğini doğrula.

    logbrew logs info --json
Dokümantasyon yüzeyleri3

docs.logbrew.co

Tam dokümantasyon sitesi

Uzun kurulum, API ayrıntıları ve ürün sayfalarını kalabalıklaştırmaması gereken örnekler için özel dokümantasyon sitesini kullanın.

Dokümantasyon sitesini aç

Düz metin

Markdown doküman aynası

Bir agent veya terminal akışı tarayıcıya özgü duruma gerek duymadan aynı dokümanları okumalıysa yerelleştirilmiş Markdown aynasını kullanın.

Markdown aç

Düz metin

Agent aynaları

Bir agent öngörülebilir public okuma yollarına ihtiyaç duyduğunda llms.txt, Markdown aynaları, robots ve sitemap kullanın.

llms.txt aç
Başlangıç yolunu seçin3

Kurulum

LogBrew hazır mı kontrol edin

Önce status çalıştırarak erişilebilirliği, oturum durumunu ve güvenli sonraki okumayı doğrulayın.

logbrew status --json

Önceliklendirme

Son hatalardan başlayın

Son error loglarını okuyun, sonra sürüm veya proje bağlamı gerekiyorsa sorunlara ya da izlere geçin.

logbrew logs error --json

Devret

Kararlı bir sorun görünümü paylaşın

Aynı hata gruplarına bir ekip arkadaşı ihtiyaç duyduğunda açık sorunları listeleyin.

logbrew issues open --json
Komut haritası6

Komut haritası

Status

Her private okumadan önce yerel auth, API erişimi ve toparlanma adımlarını kontrol edin.

logbrew status --json

Komut haritası

Loglar

Bir sürüm, proje veya trace bağlama ihtiyaç duyduğunda son hatalardan başlayın.

logbrew logs error --json

Komut haritası

Sorunlar

Çöz, kapat, yok say veya yeniden aç kararı vermeden önce açık hata gruplarını listeleyin.

logbrew issues open --json

Komut haritası

Trace detayı

Loglar veya sorunlar tek bir başarısız isteğe işaret ettiğinde bilinen trace id değerini okuyun.

logbrew trace <trace_id> --json

Komut haritası

Aksiyonlar

Önemli bağlam bir ürün aksiyonuysa kullanıcı olaylarını ada göre filtreleyin.

logbrew actions --name checkout_failed --json

Komut haritası

Sürümler

Dağıtım bağlamını log, sorun, trace span ve aksiyon sayılarıyla karşılaştırın.

logbrew releases --json
LogBrew dokümantasyonu4

Önce CLI

Yerel kimlik doğrulamasını ve API erişimini kontrol edin

İlk okuma, token bilgisini göstermeden CLI'ın LogBrew API'ye erişip erişemediğini size anlatmalıdır.

  • Bir script veya otomasyon kararlı alanlara ihtiyaç duyduğunda JSON modunu kullanın.
  • Geliştirici sonraki komuta ihtiyaç duyduğunda insan çıktısını kullanın.
  • Auth toparlanmasını login ve status komutlarına yönlendirin.

Gözlemle

Üretim sinyallerini kaynak bazında okuyun

Loglar, sorunlar, aksiyonlar, izler, sürümler ve projeler hızlı taranacak kadar ayrı, bağlamı toparlayacak kadar bağlı kalmalıdır.

  • Loglar önem düzeyi, sürüm, ortam, proje, iz ve arama filtrelerini korur.
  • Sorunlar durum, iz bağlamı ve mutasyon sözlüğünü korur.
  • İzler span adlarını, sürüm bağlamını, ortam bağlamını ve proje kapsamını korur.

Paylaş

Proje verisini açmadan faydalı bağlam gönderin

Birinin kurulum yardımına veya güvenli devre ihtiyacı olduğunda public dokümantasyonu, Markdown'u ve kopyalanabilir komutları kullanın.

  • Sonraki adım kurulum veya komut keşfi olduğunda dokümantasyon linki paylaşın.
  • Düz metin ekran görüntüsünden daha kolaysa Markdown paylaşın.
  • Panel proje verisini oturum açma ve backend auth arkasında tutun.

API haritası

Paneli backend rotalarıyla eşleştirin

Web çalışma alanı dashboard-only depolama veya ayrı kontrat icat etmek yerine belgelenmiş LogBrew API kontratlarını izlemelidir.

  • Loglar /api/logs üzerinden önem düzeyi, sürüm, ortam, proje, iz ve arama filtreleriyle okunur.
  • Sorunlar /api/telemetry/issues ve /api/telemetry/issues/{issue_id} üzerinden okunur ve güncellenir.
  • Aksiyonlar, sürümler ve iz detayı /api/telemetry/actions, /api/telemetry/releases ve /api/telemetry/traces/{trace_id} üzerinden okunur.
  • Projeler ve auth durumu /api/projects, /api/auth ve CLI status komutlarından gelir.