Skip to main content
Interfejs wiersza poleceń (CLI) LogBrew odczytuje w terminalu logi, problemy, ślady i akcje. Może też zmieniać status problemów. Użyj --json, aby przekazać skryptom i agentom AI ustrukturyzowany wynik. Zanim uruchomisz polecenie, zastąp każdy symbol zastępczy w nawiasach ostrych. Używaj ID projektów, problemów i śladów zwróconych przez LogBrew.

​
Zainstaluj CLI

Wybierz jedną metodę instalacji. macOS lub Linux:
Windows (PowerShell):
Homebrew:
npm:
Cargo:
W systemie Windows możesz też zainstalować pakiet MSI z najnowszego wydania.
Cargo wymaga Rusta 1.87 lub nowszego. Pozostałe metody instalują natywny plik binarny i nie wymagają Rusta.

​
Zaktualizuj CLI

CLI nie aktualizuje się automatycznie. Użyj tej samej metody co przy instalacji. Homebrew:
npm:
Cargo:
Jeśli używasz instalatora dla powłoki lub dla PowerShella, uruchom go ponownie. Następnie odczytaj wersję. Porównaj ją z najnowszym wydaniem:
JSON zawiera pola ok, name, version, binary, os i arch.

​
Zaloguj się i sprawdź sesję

Sprawdź konto używane w bieżącym terminalu:
Jeśli whoami pokazuje oczekiwane konto, przejdź dalej. Jeśli nie, zaloguj się. Logowanie u dostawcy kończy człowiek w przeglądarce. Agent kodujący musi poprosić człowieka o ten krok.
Dostawca to github (domyślnie), gitlab lub bitbucket. Użyj --no-open, aby wypisać adres URL logowania bez otwierania przeglądarki. --json też wypisuje dane do przekazania logowania i nie otwiera przeglądarki. Po zalogowaniu uruchom ponownie status i whoami. Nie umieszczaj poświadczeń konta w prompcie, raporcie ani pliku źródłowym.

​
Zaplanuj konfigurację SDK

Przejdź do katalogu z manifestem pakietu lub builda aplikacji. W monorepo wybierz jedną aplikację lub usługę. Następnie uruchom:
Odczytaj detected, install_ready, install_plan i next. Plan podaje środowisko uruchomieniowe, framework, menedżer pakietów i polecenie instalacji. CLI nie instaluje pakietów i nie zmienia plików. logbrew init, install, configure i sdk zwracają ten sam plan.
W konfiguracji SDK umieść klucz wysyłania projektu. Nigdy nie używaj poświadczenia konta jako klucza SDK. Nie przechowuj kluczy wysyłania w systemie kontroli wersji.
Kroki dla poszczególnych środowisk uruchomieniowych opisuje strona Integracja SDK. Uruchom logbrew examples, aby zobaczyć krótką listę typowych poleceń.

​
Odczytuj, twórz i konfiguruj projekty

Wyświetl aktywne projekty na swoim koncie:
Wybierz ID projektu z wyniku. Używaj go przy kluczach i odczytach. Aby utworzyć klucz wysyłania dla istniejącego projektu, wskaż nowy plik poza systemem kontroli wersji. CLI zapisuje klucz w tym pliku z dostępem tylko dla właściciela. Nie wypisuje klucza ani ścieżki pliku.
Wynik JSON zawiera status, project_id, ingest_key, checks i next. ingest_key zawiera pola klucza: id, label, kind, created_at i expires_at. Wymianę klucza opisuje strona Wymień klucz wysyłania. To polecenie tworzy poświadczenie. Zanim je uruchomisz, upewnij się, że projekt jest właściwy. Jeśli wynik jest niepewny, uruchom to samo polecenie ponownie. CLI wznowi wtedy oczekującą próbę. Użyj --abandon-retry tylko wtedy, gdy chcesz zacząć nową próbę. Aby utworzyć nowy projekt, wykonaj kroki z szybkiego startu. Ten przewodnik używa polecenia logbrew projects create "<name>" --ingest-key-file "<private_key_file>", które zapisuje pierwszy klucz w ten sam sposób. Uruchom logbrew setup --create-project, aby przeczytać pomoc dotyczącą tworzenia projektu. To polecenie nie tworzy projektu. Po kroku konfiguracji możesz go zapisać w projekcie. Wartość --source to api, cli lub sdk:
Następnie sprawdź gotowość projektu:
Kod wyjścia 0 nie oznacza, że wszystkie sprawdzenia się powiodły. Odczytaj status raportu i każde sprawdzenie. Zobacz opis raportu diagnostyki projektu.

​
Sprawdź wykorzystanie konta

Odczytaj wykorzystanie i limity. To nie zmienia stanu konta ani rozliczeń.
logbrew account usage --json zwraca ten sam wynik. Odpowiedź podaje plan, stan limitu, datę odnowienia, łączne wykorzystanie według projektu i rodzaju telemetrii oraz następny krok. Pola to między innymi plan, state, reset_at, by_project, by_stream i next.

​
Typowe analizy

Filtruj każdy odczyt według projektu. Dodaj filtry wydania, środowiska, czasu lub ważności, jeśli polecenie je obsługuje. Zobacz Filtry.

Problemy w wydaniu

Jedno nieudane żądanie

Logi wydania

Problemy przypisane do ciebie

​
Obserwuj zdarzenia na żywo

Użyj polecenia watch, aby widzieć nowe zdarzenia podczas testowania zmiany. Naciśnij Ctrl+C, aby zakończyć.
Watch przesyła strumieniowo tylko JSON. Bez --json polecenie kończy się błędem. Dodaj logs, issues lub actions, aby obserwować jeden typ, na przykład logbrew watch logs --json. Watch nie obsługuje śladów ani spanów. Watch nie ma filtra projektu, wydania ani środowiska. Dla jednego projektu użyj odczytów opisanych wyżej. Obsługiwane zasoby i filtry opisuje sekcja Obserwowanie na żywo.

​
Poznaj kontekst, zanim zmienisz kod

Zanim zaproponujesz poprawkę, odczytaj kontekst.
1

Odczytaj problem

2

Odczytaj ślad

Wykonaj ten krok tylko wtedy, gdy problem ma ID śladu. Problem bez śladu też jest poprawny.
3

Odczytaj wyjaśnienie

Dla logu użyj logbrew explain log "<log_id>" --json. Dla akcji użyj logbrew explain action "<action_id>" --json.
4

Rozwiąż po weryfikacji

Aby zmienić status, priorytet lub przypisanie w wielu problemach, zobacz Zmień status i priorytet problemu i przewodnik Zarządzanie problemami.

​
Wynik JSON

  • Umieść --json przed poleceniem lub po nim, na przykład logbrew --json status lub logbrew status --json.
  • Zanim użyjesz wyniku, sprawdź kod wyjścia.
  • Błędy w formacie JSON zawierają ok, error, message i next. Przekroczenie limitu czasu nie dowodzi, że zapis się nie powiódł. Zanim powtórzysz zapis, przeczytaj jego zasady ponawiania.
  • Nie automatyzuj na podstawie wyniku bez --json. Jego format może się zmienić.
Kody wyjścia i przykłady błędów opisuje sekcja Odczytaj wyniki i błędy.