Kontrola stavu

Konfiguráciu a spojenie overíte bez vyhodenia výnimky:

Plausible::ping();                  // bool — reachable AND the key is accepted
Plausible::ping('my-site.com');     // same, verified against this site

$health = Plausible::health();      // HealthResult — never throws
$health = Plausible::health('my-site.com');

$health->ok();                      // configured, reachable and the key accepted
$health->isConfigured();            // url and key are both set
$health->hasUrl;                    // bool
$health->hasKey;                    // bool
$health->reachable;                 // the instance answered (no connection error, 5xx or 404)
$health->authorized;                // the probe was answered 2xx with the key
$health->status;                    // ?int — HTTP status of the probe, null when not reached
$health->message;                   // human-readable status

health() najprv skontroluje, či sú nastavené url a key. Spôsob overenia potom závisí od toho, čo sa dá overiť:

• S webom — z argumentu, inak z PLAUSIBLE_SITE — zavolá Stats API (GET /api/v1/stats/realtime/visitors), ktoré je dostupné pre kľúč Stats API.
• Bez webu zavolá Sites API (GET /api/v1/sites), ktoré je dostupné iba pre kľúč Sites API; odmietnutý kľúč Stats API nahlási ako taký aj s riešením — nastavte PLAUSIBLE_SITE alebo zadajte web.

Prejde iba odpoveď 2xx. Chyba servera (5xx) alebo 404 — nesprávna PLAUSIBLE_URL — označí inštanciu za nedostupnú; 401, 402 alebo 403 znamená odmietnutý kľúč a 429 to, že kľúč je obmedzený limitom a nedal sa overiť. Chyba spojenia sa uvedie v správe, nikdy sa nevyhodí. ping() je skratka pre health()->ok().

Artisan príkaz

Rovnaký stav vypíše aj príkaz — s voľbou --site= overí kľúč voči Stats API daného webu:

php artisan plausible:health
php artisan plausible:health --site=my-site.com

Plausible health check
  URL configured: yes
  Key configured: yes
  Reachable:      yes
  Key accepted:   yes
  HTTP status:    200
Plausible is reachable and the API key can read stats for my-site.com.

Úspešne skončí iba vtedy, keď platí ok(), teda balík je nakonfigurovaný, inštancia dostupná a kľúč prijatý. Zaraďte ho do deploy pipeline ako kontrolu po nasadení. Sekciu Plausible zobrazí aj php artisan about (pozri Konfigurácia).