Instalacja - PHP

Zanim zaczniesz, utwórz projekt w panelu DockRay. W jego ustawieniach znajdziesz token projektu - publiczny identyfikator, który wchodzi do adresu endpointu - a w zakładce Klucze API wygenerujesz klucz prywatny. Klucz jest pokazywany tylko raz, w momencie generowania: w bazie DockRay leży wyłącznie jego skrót. Jeżeli nie masz jeszcze projektu, zacznij od zakładania konta i pierwszego projektu.

Wymagania

• PHP 8.2 lub nowszy,
• Composer 2,
• możliwość wykonywania połączeń wychodzących HTTPS.

SDK jest niezależne od frameworka i stanowi podstawę wszystkich pozostałych integracji PHP: Laravela, Symfony, Drupala, Joomli, PrestaShopu i wtyczki WordPressa. Jeśli używasz któregokolwiek z nich, sięgnij po dedykowaną paczkę - ten artykuł dotyczy aplikacji bez takiego pomostu.

Instalacja

composer require dockcodes/dock-ray

Inicjalizacja

Wywołaj init() tak wcześnie, jak framework albo Twój bootstrap na to pozwala - wtedy błędy z samego uruchamiania aplikacji też trafią do panelu.

use function Dock\Ray\init;

init([
    'token' => 'TOKEN_PROJEKTU',
    'private_key' => 'KLUCZ_PRYWATNY_PROJEKTU',
    'environment' => 'production',
    'release' => '1.4.0',
]);

token i private_key domyślnie czytane są ze zmiennych serwerowych RAY_TOKEN i RAY_PRIVATE_KEY, więc wdrożenie może skonfigurować SDK bez dotykania kodu:

init([
    'environment' => getenv('APP_ENV') ?: 'production',
    'release' => getenv('APP_VERSION') ?: null,
]);

Gdy brakuje któregokolwiek poświadczenia, SDK zostaje załadowane i nie wysyła niczego. Nigdy nie rzuca wyjątku z powodu braku konfiguracji - dlatego init() można wywołać bezwarunkowo, także lokalnie.

Co jest przechwytywane automatycznie

Domyślne integracje przechwytują nieobsłużone wyjątki i błędy krytyczne. Jeżeli Twoja aplikacja ma własny handler i chcesz nim zarządzać samodzielnie, przekaż 'default_integrations' => false i raportuj ręcznie.

Pierwszy test

use Dock\Ray\Severity;
use function Dock\Ray\captureMessage;

captureMessage('Kontrolny komunikat DockRay', Severity::info());

Komunikat powinien pojawić się w panelu w sekcji Błędy projektu wskazanego przez token.