Référence
API de capture
Pour envoyer des erreurs à Oxvel depuis n'importe quel langage, ou régler le script du navigateur.
L'adresse
POST https://oxvel.dev/api/ingest/ox_…
Pas de session, la clé du projet suffit. Le corps est un objet JSON, envoyé en application/json ou en text/plain. N'importe quel site peut appeler cette adresse. 100 000 caractères au plus.
Les champs
Tous sont facultatifs. Les textes trop longs sont coupés.
| Champ | Contenu |
|---|---|
type | Le type d'erreur, comme TypeError. Error par défaut. |
message | Le message, 500 caractères au plus. |
stack | La pile d'appels, telle que votre langage l'écrit. |
level | fatal, error, warning ou info. error par défaut. |
release | Le commit ou la version en ligne. |
environment | production, staging… |
url | La page ou la requête en cause. |
method | La méthode HTTP de la requête. |
user | L'identifiant de la personne touchée. |
platform | browser, node… |
runtime | Le navigateur ou la version du moteur. |
tags | Un objet clé et valeur, 20 entrées au plus. |
breadcrumbs | Ce qui s'est passé avant. Les 10 derniers sont gardés. |
Exemple
curl -X POST https://oxvel.dev/api/ingest/ox_… \
-H "content-type: application/json" \
-d '{"type":"TypeError","message":"cart is undefined","level":"error","release":"a1b2c3d"}'Les réponses
| 204 | Reçu |
| 400 | Clé ou JSON invalide |
| 404 | Aucun projet n'a cette clé |
| 413 | Corps trop gros |
| 429 | Trop de nouvelles erreurs pour ce projet cette heure-ci |
Au-delà de 30 nouvelles erreurs par heure, les erreurs déjà connues continuent d'être comptées.
Le script du navigateur
data-key | La clé du projet |
data-release | Le commit déployé |
data-environment | production par défaut |
Oxvel.capture(err, options) | Envoie une erreur à la main. options peut contenir level et tags. |
Oxvel.setUser(id) | Relie les erreurs suivantes à une personne |
Le script garde les 20 derniers événements (erreurs et avertissements de la console, changements de page). Il envoie 25 erreurs au plus par chargement de page, et la même erreur une seule fois si elle revient dans la seconde.