Administration, schéma et migrations
Administration, schéma et migrations
GenerationLogs & Documents — Schéma, migrations, conservation et bonnes pratiques
Ce guide détaille comment administrer le schéma de stockage des GenerationLogs (ajout des colonnes input_prompt et execution_frequency), activer le lien optionnel vers les hooks d’agent, et définir des règles sûres pour la conservation, suppression et duplication automatisée des documents. Inclut considérations de sécurité, permissions et impact des appels externes.
Couvert dans cette page
Duplication & suppression
Procédures pas-à-pas pour dupliquer, supprimer et finaliser des documents depuis l’interface de revue.
Schéma & Migration
Checklist pratique pour planifier et exécuter la migration qui ajoute input_prompt et execution_frequency, et le lien optionnel agent_hook_id.
Conservation & politiques
Règles de rétention, stratégies de suppression (soft/hard) et bonnes pratiques pour automatisation.
Sécurité & permissions
Contrôles d’accès pour voir les prompts, gestion des droits et recommandations pour appels externes.
Impact des envois externes
Ce qu’il faut savoir quand on exporte/envoie un document (webhooks, coûts/consommations).
Validation post-migration
Étapes pour vérifier l’intégrité après migration et comment revenir en arrière si nécessaire.
A lire en premier
Ce document est destiné aux administrateurs et responsables produit qui gèrent la plateforme et les politiques de données. Il décrit des procédures opérationnelles : planification, exécution et vérifications. Veillez à disposer des autorisations d’administration avant d’effectuer les actions proposées.
Workflow : Planifier et exécuter la migration du schéma (ajout input_prompt, execution_frequency, lien vers AgentHooks)
Étape 1 — Inventaire et justification
Recensez les usages actuels des logs générés : qui les consulte, quelles intégrations y accèdent, et quels champs doivent être conservés pour l’audit. Confirmez pourquoi input_prompt et execution_frequency sont nécessaires (traçabilité, régénération, scheduling).
Étape 2 — Sauvegarde et plan de rollback
Avant toute modification structurelle, effectuez une sauvegarde complète des données susceptibles d’être impactées. Documentez précisément la procédure de retour en arrière (rollback) et qui est responsable de l’exécution.
Étape 3 — Choisir une fenêtre de maintenance
Planifiez la migration dans une fenêtre de faible activité. Communiquez aux équipes concernées (dev, produit, support) la durée estimée et les risques.
Étape 4 — Exécuter la migration (opération contrôlée)
Lancez la migration pendant la fenêtre prévue. Surveillez les indicateurs de santé (files d’attente, workers, erreurs d’écriture). Ne forcez pas d’opérations d’écriture lourdes simultanées pendant l’opération.
Étape 5 — Validation post-migration
Vérifiez un échantillon de logs récents et anciens : présence des nouveaux champs input_prompt et execution_frequency, comportement des enregistrements liés aux hooks d’agent (références optionnelles). Assurez-vous que les enregistrements existants n’ont pas été corrompus.
Étape 6 — Tests d'intégration fonctionnelle
Testez les workflows utilisateurs : génération normale, revue, duplication, suppression, export. Vérifiez que les envois vers destinations externes continuent de fonctionner et que la consommation de crédits liée aux régénérations est cohérente.
Étape 7 — Surveillance et garde-fous
Activez des journaux et alertes sur les erreurs d’écriture, les échecs d’envoi et les anomalies de performance pendant les 72 heures suivant la migration. Prévoyez une vérification plus complète après 1 semaine.
Étape 8 — Documenter la migration
Renseignez dans le changelog projet les raisons de la modification, la fenêtre d’intervention, les actions réalisées et les éventuels problèmes rencontrés.
Tip — Migrations incrémentales
Si possible, déployez la migration en deux temps : (1) ajouter les nouveaux champs en lecture/écriture passifs, (2) activer progressivement les composants qui les remplissent. Cela réduit les risques et facilite le rollback.
Tip — Conserver un échantillon historique
Conservez au moins un échantillon historique des enregistrements avant suppression définitive (par exemple : 30–90 jours) pour permettre des audits et des restaurations rapides.
Attention — Données sensibles dans input_prompt
Les prompts stockés peuvent contenir des données sensibles (ex. extraits de code, snippets privés, données de paiement). Restreignez la visibilité aux rôles strictement nécessaires et appliquez masquage si exigé par la réglementation.
Workflow : Vérifier et activer le lien optionnel vers AgentHooks (agent_hook_id)
Étape 1 — Comprendre le lien optionnel
Le champ agent_hook_id permet d’indiquer qu’un log a été produit à la suite d’un hook d’agent. Il est nullable : l’absence de valeur signifie log généré manuellement ou depuis une autre source.
Étape 2 — Examiner les usages existants des hooks
Identifiez les hooks actifs, leurs fréquences et destinations. Vérifiez quelles actions déclenchent l’écriture des logs et si elles doivent référencer le hook.
Étape 3 — Consistance des références
Après activation, contrôlez les enregistrements produits par les hooks : ils doivent référencer le hook associé. Les enregistrements manuels doivent rester sans référence si pertinent.
Étape 4 — Gestion des suppressions de hooks
Définissez le comportement attendu quand un hook est supprimé : conserver l’historique de logs (référence nulle) ou annoter le log comme « hook supprimé ». Planifiez une migration d’annotation si nécessaire.
Étape 5 — Revue et tests
Créez un hook test et déclenchez une génération. Vérifiez l’association, la visibilité dans l’interface et l’impact sur les exports et envois.
Workflow : Dupliquer un document depuis l'interface (revue et publication)
Étape 1 — Ouvrir le document à dupliquer
Ouvrez le document depuis l’onglet Changelogs ou depuis la liste de documents et cliquez pour afficher le DialogDocument.
Étape 2 — Lancer la duplication
Dans la fenêtre du document, cliquez sur l’action « Duplicate » (ou équivalent). L’interface crée une nouvelle copie en draft.
Étape 3 — Vérifier et modifier les métadonnées
Avant d’enregistrer : vérifiez le titre, la description, et les métadonnées importantes (agent_id, agent_hook_id, batch_uuid). Corrigez l’input_prompt si vous souhaitez l’adapter.
Étape 4 — Sauvegarder la copie
Enregistrez la copie ; elle apparaîtra dans la liste comme un nouveau document. Vérifiez que les permissions et liens (hooks, exports) sont corrects.
Étape 5 — Nettoyage si nécessaire
Si la duplication était expérimentale, supprimez la copie une fois validé le besoin, en suivant la procédure de suppression ci-dessous.
Workflow : Supprimer un document depuis l'interface (sécurisé)
Étape 1 — Evaluer le type de suppression
Décidez si la suppression doit être « soft » (archivage, conservation d’un historique) ou « hard » (suppression définitive). Préférez le soft-delete en production pour auditabilité.
Étape 2 — Ouvrir le DialogDocument
Accédez au document, cliquez sur l’action « Delete ». L’interface demande une confirmation.
Étape 3 — Confirmer la suppression en connaissance de cause
Vérifiez les métadonnées liées (agent_id, agent_hook_id, batch_uuid) et les destinations d’envoi associées. Confirmez l’action.
Étape 4 — Vérifier la propagation
Après suppression, contrôlez les affichages (changelogs, listes) et systèmes liés (index de recherche, exports sauvegardés). Si soft-delete, assurez-vous que l’entrée est marquée comme archivée et non visible par défaut.
Étape 5 — Reprise et restauration
Si une restauration est nécessaire et que l’action était soft-delete, restaurez depuis l’archive. Pour suppression définitive, suivez vos procédures de récupération (si existantes).
Attention — Suppression automatisée et dépendances externes
La suppression automatique peut casser des historiques externes (exports, intégrations, webhooks) ou perdre des preuves d’audit. Vérifiez les dépendances avant d’automatiser un purge complet.
Workflow : Exporter ou envoyer un document (Markdown / JSON / webhook) et gérer l'impact externe
Étape 1 — Préparer le document dans DialogDocument
Ouvrez le document, vérifiez le contenu, les métadonnées et les paramètres d’export (inclusion du prompt, anonymisation).
Étape 2 — Choisir l'action (Export / Send)
- Pour exporter : sélectionnez Export Markdown ou Export JSON.
- Pour envoyer : choisissez la Destination prévue (webhook, email, Notion, etc.).
Étape 3 — Vérifier l'impact des appels externes
Avant d’envoyer, sachez que certains envois peuvent déclencher des appels externes ou des régénérations LLM qui consomment des crédits. Confirmez la consommation prévue auprès du responsable coûts.
Étape 4 — Lancer l'export / l'envoi
Cliquez Export ou Send. Surveillez la notification de succès/erreur. Conservez le journal de l’opération (timestamp, destinataire, statut).
Étape 5 — Post-action : audit
Archivez les logs d’envoi et, si nécessaire, anonymisez les prompts dans les copies exportées ou envoyées pour respecter la protection des données.
Tip — Masquage sélectif du prompt lors d'export
Pour limiter les risques, exportez sans input_prompt par défaut ou fournissez une option « inclure le prompt » réservée aux comptes admins/auditeurs.
Workflow : Définir et appliquer une politique de rétention et fichiers métadonnées (conservation, purge, duplication automatisée)
Étape 1 — Inventorier les métadonnées critiques
Identifiez les métadonnées à conserver pour l’audit : agent_id, agent_hook_id, batch_uuid, auteur, date de création, statut de revue.
Étape 2 — Définir les périodes de rétention
Pour chaque type de document, fixez : période de conservation active (ex. 90 jours), période d’archivage (ex. 1 an), et suppression définitive.
Étape 3 — Choisir stratégie de suppression
- Soft-delete : conserve l’entrée en archive (recommandé).
- Hard-delete : suppression définitive, à réserver aux obligations légales ou tests.
Étape 4 — Automatiser les nettoyages en sécurité
Mettez en place des jobs planifiés qui : 1) déplacent en archive, 2) notifient les équipes responsables, 3) attendent une fenêtre pour suppression définitive. Ajoutez un checkpoint manuel avant purge finale.
Étape 5 — Règles de duplication automatisée
Si vous dupliquez automatiquement (ex. templates journaliers), assurez-vous que les métadonnées de tracking (batch_uuid) sont régénérées et que les références à hooks anciennes sont nettoyées si non pertinentes.
Étape 6 — Audit et traçabilité
Conservez un registre des actions de purge/duplication (qui, quand, pourquoi) accessible aux admins pour requêtes réglementaires.
Avant la migration
- Pas de champ input_prompt permanent → prompts non persistés ou enregistrés ailleurs.
- Peu de traçabilité de la fréquence d’exécution.
- Liens vers hooks non uniformes.
Après la migration
- Champs input_prompt et execution_frequency disponibles dans les nouveaux enregistrements.
- Lien optionnel agent_hook_id permet d’identifier l’origine hook.
- Meilleure auditabilité et capacité d’automatisation sûre.
Approche : bloquer ou limiter l’activité pendant la migration.
Avantages : simplicité, cohérence immédiate.
Inconvénients : indisponibilité partielle, impact sur les utilisateurs.
Warning — Permissions d'affichage des prompts
La visibilité du champ input_prompt doit être restreinte : seules les personnes autorisées (auditeurs, owners, certains rôles d’éditeur) devraient pouvoir afficher le prompt complet. Sinon, afficher une version masquée ou tronquée.
Workflow : Audit sécurité et permissions (visibilité des prompts et envois externes)
Étape 1 — Cartographie des rôles
Listez qui peut créer, éditer, finaliser, dupliquer, supprimer, exporter et envoyer des documents. Associez chaque action à des rôles clairs.
Étape 2 — Restreindre la lecture du prompt
Configurez la visibilité du input_prompt : par défaut masqué pour les rôles non-admin. Donnez un contrôle granulaire pour afficher une version redacted.
Étape 3 — Contrôler les destinations externes
Vérifiez et limitez les destinations d’envoi (webhooks, e-mails, intégrations). Exigez signatures ou tokens pour les destinations sensibles.
Étape 4 — Gérer l'impact coûts/credits
Documentez quelles actions déclenchent des consommations (ex. régénération LLM). Mettez en place des quotas et approbations pour actions coûteuses.
Étape 5 — Suivi et alerting
Activez alertes sur usage anormal : envois massifs, régénérations répétées, exports automatiques. Reliez ces alertes à un processus d’investigation.
Tip — Journalisation des accès sensibles
Conservez un journal d’accès pour toutes les actions permettant de voir le prompt complet (qui l’a vu, quand). Utile pour audits de conformité ou enquêtes post-incident.
Frequently Asked Questions
Checklist rapide avant migration
- Communiquer la fenêtre de maintenance aux équipes impactées.
- Sauvegarde complète des données critiques.
- Plan de rollback et contact des responsables.
- Tests automatisés et manuels après migration.
- Activation du monitoring et des alertes pendant 72h.
Besoin d'aide pour planifier la migration ?
Si vous souhaitez assistance pour exécuter la migration ou définir la politique de conservation, contactez l’équipe d’administration pour un accompagnement personnalisé.