Skip to main content
Projekt to granica dostępu do telemetrii. Każdy przyjęty sygnał należy do jednego projektu, a każde polecenie odczytu może filtrować według projektu. Utwórz osobny projekt, gdy telemetria wymaga osobnej granicy własności lub dostępu. W większości zespołów to jedna aplikacja, usługa lub obszar produktu. Repozytorium nie musi odpowiadać jednemu projektowi. Monorepo może wysyłać kilka usług do jednego projektu. Rozróżniaj je nazwami usług.

​
Projekt, usługa, środowisko

​
Skonfiguruj projekt

Zainstaluj CLI. Uruchom logbrew status --json, aby sprawdzić dostęp do konta. Jeśli dostęp jest nieważny, polecenie logbrew login musi uruchomić człowiek. Klucz wysyłania projektu nie pozwala się zalogować.
1

Utwórz lub wybierz projekt

Najpierw wyświetl listę projektów. Utwórz projekt tylko wtedy, gdy jeszcze nie istnieje.
CLI zapisuje klucz wysyłania do nowego pliku, który może czytać tylko właściciel. Nigdy nie wypisuje klucza ani ścieżki pliku. Jeśli wynik jest niejasny, uruchom ponownie dokładnie to samo polecenie. Nie zmieniaj nazwy projektu ani pliku klucza. CLI użyje ponownie tożsamości oczekującego żądania. Szybki start pokazuje, jak odczytać ID projektu z wyniku.Dla istniejącego projektu zapisz stan konfiguracji:
Aby utworzyć kolejny klucz wysyłania dla istniejącego projektu, użyj logbrew projects keys create. Przewodnik po wymianie klucza wysyłania pokazuje to polecenie.logbrew setup --create-project tylko wyświetla pomoc. Nie tworzy projektu.
2

Ustaw nazwy usług w SDK

Używaj nazw z repozytorium i wdrożenia, takich jak api, worker, web, ios lub checkout-api. Nazwa usługi to etykieta, a nie selektor projektu. To klucz wysyłania wybiera projekt. Zmiana nazwy usługi nie przenosi zapisanych zdarzeń. Jeśli nie możesz znaleźć zdarzenia, zanim utworzysz kolejny projekt, sprawdź projekt i klucz wysyłania, których używa aplikacja.
3

Używaj standardowych środowisk

Używaj production, staging, preview i local. Jeśli twoje wdrożenie używa innych nazw, stosuj je konsekwentnie. Nazwa środowiska nie może zawierać spacji, / ani ukośnika odwrotnego.
4

Wyślij zdarzenie testowe i odczytaj je

Skonfiguruj SDK z kluczem wysyłania projektu, jak opisuje przewodnik po integracji SDK. Utworzenie projektu nie instaluje SDK w aplikacji. Nie umieszczaj klucza w systemie kontroli wersji. Ustaw usługę, środowisko i wydanie w aplikacji. Wyślij jedno bezpieczne zdarzenie, a potem je odczytaj:
Każdy sygnał ma własną listę. Pusta lista logów nie oznacza, że projekt nie ma problemów ani śladów.Na pulpicie wybierz ten sam projekt i zakres czasu, który obejmuje zdarzenie testowe. Upewnij się, że filtry usługi, środowiska i wydania pasują do zdarzenia.

​
Zdiagnozuj konfigurację projektu

Odczytaj stan konfiguracji za pomocą diagnostyki projektu. Nie wnioskuj o stanie konfiguracji z plików lokalnych ani z pustego zapytania o logi.
CLI zwraca raport z polami status, checks i next. Kod wyjścia 0 nie oznacza, że wszystkie sprawdzenia zakończyły się powodzeniem. Przeczytaj każdy element w checks. Zobacz Odczytaj raport diagnostyki projektu.

​
Bezpośrednia odpowiedź API

Klient API wywołuje GET /api/projects/{project_id}/doctor z uwierzytelnieniem konta. Endpoint nie ma parametrów zapytania ani treści żądania. Do tego odczytu nigdy nie używaj klucza wysyłania projektu. Odpowiedź 200 ma te klucze: project_id, state, setup_status, setup_acknowledged, has_active_ingest_key, first_telemetry_seen_at, last_seen_at, last_signal, next i next_action. Znaczniki czasu mają format RFC3339 lub wartość null. last_signal to podsumowanie bezpieczne do wyświetlenia, a nie surowy sygnał. Diagnostyka najpierw sprawdza klucz wysyłania. Projekt bez aktywnego klucza wysyłania ma stan needs_ingest_key niezależnie od statusu konfiguracji. setup_status przyjmuje wartość created, setup_started, sdk_seen, first_telemetry_seen lub active. setup_acknowledged ma wartość true tylko dla 3 ostatnich wartości. created daje needs_setup. setup_started i sdk_seen dają needs_telemetry. first_telemetry_seen i active dają ready. Jeśli odczyt nadal się nie udaje, zgłoś problem. Nie dołączaj poświadczeń, nagłówków, treści sygnałów, danych klientów, ścieżek lokalnych ani kodu źródłowego.

​
Zarchiwizuj lub usuń projekt

Zarchiwizuj projekt, aby usunąć go z listy aktywnych projektów:
Polecenie wymaga --yes. Po archiwizacji klucze wysyłania projektu przestają przyjmować nową telemetrię. Trasa API to DELETE /api/projects/{project_id}. Zwraca 204 bez treści. Zarchiwizowane projekty wyświetlisz przez GET /api/projects/archived. Projekt przywrócisz przez POST /api/projects/{project_id}/restore. Ta trasa też zwraca 204. Usuń projekt na stałe tylko wtedy, gdy masz pewność:
Po --confirm powtórz dokładne ID projektu. Przyjęte żądanie od razu dezaktywuje projekt i planuje jego trwałe usunięcie. Potem nie można już przywrócić projektu.

​
Wymień klucz wysyłania

Przewodnik po wymianie klucza wysyłania opisuje procedurę zastąpienia, wdrożenia, testu i unieważnienia klucza.