Konfiguracja - REST API

Lokalizacja konfiguracji

Warstwa HTTP monitorowanej aplikacji lub usługi

Poświadczenia projektu

Wyjątki: wysyłaj metodą POST na /api/v1/{token}/project. Wymagane jest co najmniej pierwsze wystąpienie w exception.values z polami type i value. Możesz dołączyć stacktrace, environment, sdk, contexts.os, contexts.runtime, request i user.

Transakcje: wysyłaj na /api/v1/{token}/transaction. Pole contexts.trace.data jest wymagane i powinno zawierać co najmniej url oraz method. Nazwę operacji podaj w transaction, kod odpowiedzi w tags["http.status_code"], a czas zdarzenia jako ISO 8601 w sent_at.

Uwierzytelnianie: token projektu znajduje się w adresie, a klucz prywatny najlepiej przekazywać w nagłówku Authorization: Bearer. API zachowuje również zgodność z klientami przekazującymi klucz jako api_token w query stringu lub polu formularza. Klucza nie wolno wysyłać z kodu działającego w przeglądarce.

Środowiska

Każde środowisko powinno raportować z jednoznaczną nazwą, na przykład production albo staging. Dla produkcji i środowiska testowego warto utworzyć osobne klucze prywatne, aby można je było niezależnie odwołać. Raportowanie lokalne pozostaw wyłączone, chyba że świadomie testujesz integrację.

Zalecany zakres raportowania

Do DockRay kieruj awarie wymagające reakcji zespołu. Oczekiwane odpowiedzi aplikacji powinny pozostać poza strumieniem błędów, aby alerty i miesięczne wykorzystanie odzwierciedlały rzeczywiste problemy.

• Nie raportuj wyjątków walidacji obsługiwanych jako standardowa odpowiedź dla użytkownika.
• Odfiltruj błędy 404 generowane przez automatyczne skanery i nieprawidłowe adresy.
• Wyłącz zdarzenia tworzone celowo przez testy automatyczne i zadania kontrolne.

Ochrona klucza prywatnego

Klucz przechowuj w konfiguracji serwera, menedżerze sekretów albo prywatnych ustawieniach platformy. Nie umieszczaj go w repozytorium, logach, zrzutach ekranu ani kodzie wysyłanym do przeglądarki. Podejrzenie ujawnienia klucza jest wystarczającym powodem, aby go odwołać i wygenerować nowy.