Diffuser les événements analytics vers Amazon S3
Configurez la diffusion analytics Enterprise pour envoyer certaines catégories d'événements et certains déploiements vers Amazon S3.
Les analytics nécessitent un plan Pro ou Enterprise. La diffusion analytics est disponible uniquement sur les plans Enterprise.
Diffusez les événements analytics vers Amazon S3 en temps quasi réel afin d’envoyer les événements vers votre data warehouse ou vos pipelines analytics en aval, sans attendre les exports CSV.
Les administrateurs d’organisation peuvent ajouter plusieurs destinations, choisir quelles catégories d’événements envoyer et depuis quels déploiements diffuser. La diffusion analytics utilise un modèle d’inclusion : aucun événement n’est diffusé tant que vous n’avez pas sélectionné au moins une catégorie et un déploiement. Les mêmes sélections de catégories et de déploiements s’appliquent à chaque destination.
- Accédez à la page Streaming de votre dashboard.
- Dans la section Stream configuration, sélectionnez Configure.
- Sélectionnez Add destination.
- Saisissez un libellé optionnel, puis fournissez le bucket Amazon S3, la région AWS, l’access key ID et la secret access key. Optionnellement, saisissez un préfixe que Mintlify ajoutera au début de chaque clé d’objet.
- Sélectionnez Add destination.
Pour arrêter la diffusion vers une destination, ouvrez la configuration de streaming, sélectionnez l’icône de suppression à côté de la destination, puis sélectionnez Remove pour confirmer.
-
Accédez à la page Streaming de votre dashboard.
-
Dans la section Stream configuration, sélectionnez Configure.
-
Dans le tableau des catégories, sélectionnez les catégories que vous souhaitez envoyer.
Catégorie Exemples Pages vues Événements de consultation de pages et de Markdown. Navigation Clics sur les éléments de navigation, clics sur les appels à l’action de la navigation, et changements de version. Recherche Requêtes de recherche, clics sur les résultats, fermetures de recherche et comparaisons de recherche. Composants de page Interactions avec les composants dépliables, accordéons, blocs de code et API playground. Retours Pouce en haut, pouce en bas et soumissions de retours détaillés. AI Assistant Conversations avec l’assistant, sources, suggestions, retours et erreurs. Menu contextuel & MCP Actions du menu contextuel, copies de lien MCP, installations de serveur MCP et appels d’outils MCP. Les exemples résument chaque catégorie. Utilisez la valeur
eventTypediffusée pour identifier l’événement exact. -
Sélectionnez Save.
Sélectionnez ceux des déploiements de votre organisation qui envoient des événements. Le dashboard liste chaque déploiement par sous-domaine. Si vous créez un déploiement, revenez à la configuration de streaming et sélectionnez-le. Les nouveaux déploiements ne commencent pas automatiquement à diffuser des événements.
- Accédez à la page Streaming de votre dashboard.
- Dans la section Stream configuration, sélectionnez Configure.
- Dans le tableau des déploiements, sélectionnez les déploiements depuis lesquels vous souhaitez envoyer des événements.
- Sélectionnez Save.
Aucun événement n’est diffusé tant que vous n’avez pas sélectionné au moins une catégorie et un déploiement.
Mintlify écrit des objets JSON délimités par des sauts de ligne (.jsonl) dans votre bucket. Mintlify génère les noms d’objets à partir d’horodatages UTC. Si vous configurez un préfixe de clé, Mintlify écrit les objets sous ce préfixe.
Chaque ligne contient une enveloppe d’événement avec un eventType et un payload. Le eventType est le nom de l’événement, par exemple docs.content.view. Le payload contient l’événement analytics sous forme d’objet JSON ou de chaîne encodée en JSON. Si payload est une chaîne, analysez-la comme du JSON avant de la charger dans votre warehouse.
Le payload de l’événement contient les champs suivants :
| Champ | Description |
|---|---|
event_id | UUID qui identifie l’événement. Utilisez-le comme clé de déduplication lors du chargement des données. |
subdomain | Sous-domaine du déploiement qui a généré l’événement. |
user_id | ID de l’utilisateur authentifié, lorsque disponible. |
anon_id | ID de visiteur anonyme, lorsque disponible. |
session_id | ID de session du visiteur ou de l’assistant, lorsque disponible. |
created_at | Horodatage ISO 8601 du moment où l’événement s’est produit. |
event | Nom de l’événement. Il correspond à eventType dans l’enveloppe. |
path | Chemin de la documentation où l’événement s’est produit. |
referrer | URL de référence, lorsque disponible. |
user_agent | Chaîne user-agent du navigateur ou du client. |
ip | Adresse IP du visiteur. |
properties | Données spécifiques à l’événement sous forme d’objet JSON ou de chaîne encodée en JSON. |
Les changements de configuration peuvent prendre jusqu’à une minute à s’appliquer.
Les événements diffusés peuvent contenir des données personnelles, notamment des adresses IP, des identifiants d’utilisateur et de session, des requêtes et réponses de l’assistant, et des commentaires de retour ou des coordonnées de contact. Appliquez des contrôles d’accès, des politiques de rétention et d’autres exigences de traitement des données appropriées à votre organisation.