Skip to main content
API konta służy do odczytu wykorzystania, stanu limitu, historii wykorzystania i gotowości subskrypcji oraz do wylogowania. Odczyty konta używają tokena bearer konta albo sesji przeglądarki. Nigdy nie używaj klucza wysyłania projektu w żądaniu konta. Nigdy nie używaj poświadczenia konta jako konfiguracji SDK ani wysyłania. Błędy używają standardowej koperty błędu API opisanej na stronie Błędy API. Odczyt bez poprawnego uwierzytelnienia konta zwraca 401 z code: "unauthorized". Nie pokazuj takiego błędu jako zerowego wykorzystania, pustego wykresu ani darmowego planu. Nieobsługiwana metoda zwraca 405 z code: "method_not_allowed", a next wskazuje obsługiwane żądanie. API konta podaje wykorzystanie telemetrii, a nie kwoty pieniędzy. Nie podaje opłat, faktur ani stanu płatności.

Wykorzystanie konta

GET /api/account/usage to podstawowy endpoint wykorzystania i limitów. Używaj go do sum wykorzystania, czasu resetu, stanu limitu oraz podziału według projektu i strumienia telemetrii. Nie obliczaj wykorzystania z plików SDK, plików CLI ani liczników klienta. Polecenie CLI logbrew usage odczytuje ten endpoint. Zobacz dokumentację referencyjną CLI.
Przykładowa odpowiedź z syntetycznymi wartościami. To darmowe konto ma 1 projekt i w bieżącym okresie wysłało tylko logi:

Zdarzenia odrzucone przez SDK

Wyślij response_version=2, aby otrzymać także sdk_dropped_events. Bez tego parametru albo z response_version=1 odpowiedź nie zawiera tego pola.
sdk_dropped_events zawiera zdarzenia, które SDK zgłosiły jako odrzucone przed wysłaniem w bieżącym okresie, na przykład dlatego, że kolejka klienta była pełna. Dla każdego projektu i powodu jest 1 wiersz:
Odrzucone zdarzenia nigdy nie dotarły do LogBrew. Nie są rozliczane i nie wliczają się do usage, by_project ani by_stream. Tablica jest pusta, gdy żadne SDK nie zgłosiło odrzuceń.

Stany limitu

Główną decyzję podejmuj na podstawie state. limit ma wartość null tylko wtedy, gdy state ma wartość ok. next_action.state, next_action.limit i next_action.reset_at powtarzają wartości z najwyższego poziomu. Wartości next_action.code obejmują też check_usage_limits z celem account_usage. Jeśli klient dostanie tę parę, odczytaj wykorzystanie ponownie i pokaż next. LogBrew mierzy każdy rodzaj telemetrii względem jego własnego przydziału. limit je grupuje:
  • events obejmuje zdarzenia problemów i spany śladów.
  • bytes obejmuje bajty logów i bajty metryk.
Jeśli jeden przydział jest zablokowany, a inny jest w stanie ostrzeżenia, limit wskazuje zablokowany przydział. Stan warning zaczyna się, gdy wykorzystanie osiągnie warning_threshold przydziału. Stan blocked zaczyna się, gdy wykorzystanie osiągnie przydział. Tekst next może się zmieniać, na przykład gdy plany nie są w sprzedaży. Wartości next_action się nie zmieniają. Lokalizuj na podstawie next_action. Nie parsuj next. Limit wykorzystania konta to nie limit żądań API. Gdy przyjmowanie danych przekroczy przydział, żądanie wysyłania zwraca 429 z usage_limit_exceeded, a treść zawiera dodatkowo limit i reset_at. W tym błędzie limit wskazuje dokładny przydział: issue_events, log_bytes, metric_bytes lub trace_spans. LogBrew odrzuca całe żądanie. Nie wysyłaj ponownie tego rodzaju telemetrii aż do reset_at albo do zmiany planu. Gdy klient wysyła zbyt wiele żądań, API zwraca rate_limited. Zobacz Błędy API. Odpowiedź to migawka. Odczytaj ją ponownie po zmianie na koncie.
GET /api/logs/usage to starsza odpowiedź zgodności dla aplikacji mobilnej z bytes_used, limit_bytes i month. W nowych integracjach używaj GET /api/account/usage.

Historia wykorzystania

GET /api/account/usage/history zwraca ograniczoną liczbę przedziałów czasu z wykorzystaniem, uzupełnionych zerami, do wykresów i raportów. Ustaw interval na jedną obsługiwaną wartość. Jeśli pominiesz interval, API używa monthly. Trasa nie przyjmuje innych parametrów zapytania.
Ta odpowiedź yearly używa syntetycznych danych dla żądania z czerwca 2026. Całe wykorzystanie przypadło na czerwiec:
Czas resetu przydziału odczytuj z current.reset_at. Nie używaj końca okna historii. current nie jest sumą przedziałów, a jego daty mogą się różnić od dat okna. Ostatni przedział zawiera bieżący okres kalendarzowy, który jeszcze się nie zakończył. Jego przyszły czas końca nie oznacza, że LogBrew zmierzył przyszłe wykorzystanie. Przedział z zerami oznacza, że LogBrew nie naliczył w nim żadnego wykorzystania. W przedziale usage.projects liczy projekty, które mają wykorzystanie w tym przedziale. Nie sumuj tych liczb, aby uzyskać liczbę projektów. Liczbę posiadanych projektów odczytuj z current.usage.projects. Rysuj zdarzenia i bajty jako osobne serie, bo mają różne jednostki. Przedziały zawierają wykorzystanie, a nie koszt. Nie podpisuj wykresu jako wydatków, faktur ani żądań API. Nieobsługiwany interwał zwraca 422:
Nieznany parametr zapytania też zwraca 422 z validation_failed.

Gotowość subskrypcji

GET /api/account/subscription służy tylko do odczytu. Na jego podstawie zdecyduj, czy włączyć elementy sterujące płatnego planu lub organizacji. Stan limitu odczytuj z endpointu wykorzystania.
Darmowe konto zwraca taką odpowiedź. account_id jest syntetyczne:
next to tekst do wyświetlenia. Zmienia się w zależności od tego, czy płatne plany są w sprzedaży. Pokaż zwrócony tekst albo lokalizuj na podstawie next_action. Nie wpisuj na sztywno nazwy planu z next. Wartości wyliczeniowe: Każda blokada ma jedną parę next_action: Wartości planu (tier) to identyfikatory, a nie nazwy do wyświetlenia. W zlokalizowanym kliencie zostaw je bez zmian. Płatne konto nadal może być zablokowane. Zanim włączysz tworzenie organizacji, sprawdź organization_creation_allowed. Ten endpoint nie tworzy organizacji, nie wysyła zaproszeń, nie zmienia ról ani rozliczeń.

Wylogowanie

Wybierz najmniejszy zakres, który pasuje do zadania. Te endpointy nie usuwają konta ani jego projektów, nie wymieniają kluczy wysyłania i nie unieważniają zgody udzielonej zewnętrznemu dostawcy logowania.

Jedno logowanie aplikacji lub CLI

Wyślij żądanie z klienta, który ma token odświeżania. Ustaw Content-Type: application/json:
Nigdy nie proś człowieka ani agenta o wypisanie lub wklejenie tokena odświeżania. Udana odpowiedź ma status 200:
To unieważnia jedną rodzinę tokenów odświeżania. LogBrew odrzuca późniejsze odświeżenia dla tego logowania. Inne logowania na koncie się nie zmieniają. Token dostępu, który klient już ma, pozostaje ważny do wygaśnięcia. Jeśli poświadczenia konta mogą być ujawnione, użyj sekcji Każde logowanie do LogBrew. Po odpowiedzi klient usuwa swoje lokalne poświadczenia. Jeśli ponownie wyślesz ten sam ważny token odświeżania, odpowiedź to znowu 200. Jeśli token jest nieprawidłowy, wygasł albo jest tokenem dostępu, odpowiedź to 401 z code: "unauthorized" i next_action.code: "authorize_request". W takim przypadku też usuń lokalne poświadczenia. logbrew logout używa tego endpointu.

Każde logowanie do LogBrew

To żądanie wylogowuje każdego klienta na koncie. Zanim agent je wyśle, uzyskaj zgodę właściciela konta.
Udana odpowiedź ma status 200:
revoked_before obejmuje podany moment i ma dokładność do milisekund. LogBrew odrzuca tokeny dostępu, sesje przeglądarki i tokeny odświeżania z logowania w tym momencie lub wcześniej. Token odświeżony później z takiego logowania też jest odrzucany. Bieżące sesje podglądu na żywo się kończą, a odpowiedź czyści plik cookie sesji przeglądarki. Logowanie po tym momencie pozostaje ważne. Każdy klient musi usunąć swoje lokalne poświadczenia LogBrew i zalogować się ponownie. Nie loguj się ponownie i nie powtarzaj tego żądania automatycznie. Nowe żądanie unieważni też nowe logowanie. Jeśli odpowiedź zaginie, nie zgłaszaj, że wszystkie logowania zostały unieważnione. Późniejsze 401 dla starego poświadczenia nie zastępuje odpowiedzi o sukcesie. Więcej kroków naprawczych opisuje sekcja Zabezpiecz przejęte konto.

Sesja przeglądarki

POST /api/auth/web/logout czyści plik cookie przeglądarki logbrew_session i zwraca 204 No Content bez treści. Wywołuj go z przeglądarki. Nie kopiuj pliku cookie sesji do polecenia. To żądanie nie wylogowuje innych klientów i nie unieważnia kopii wartości pliku cookie. Aby unieważnić każdą sesję, użyj sekcji Każde logowanie do LogBrew.

Napraw błąd wylogowania

Trasy telemetrii, filtry i paginację opisuje strona API telemetrii.