@pixelpoule/monitoring-setup
v1.0.3
Published
CLI pour installer automatiquement le monitoring Pixel Poule dans une instance Next.js
Maintainers
Readme
🚀 @pixelpoule/monitoring-setup
CLI d'installation automatique du monitoring Pixel Poule pour les instances Next.js.
📦 Installation
Dans n'importe quelle instance Next.js :
npx @pixelpoule/monitoring-setupC'est tout ! ✨
✨ Ce que fait le CLI
- ✅ Vérifie que vous êtes dans un projet Next.js
- ✅ Pose les questions (instanceId, secret, dashboardUrl)
- ✅ Installe automatiquement
@pixelpoule/monitoring - ✅ Ajoute les variables dans
.env.local - ✅ Configure
middleware.tspour le monitoring automatique - ✅ Affiche un résumé et les prochaines étapes
🎯 Questions posées
Le CLI vous demandera :
- URL du Dashboard Admin : L'URL de votre dashboard centralisé
- Instance ID : Fourni lors de la création de l'instance dans le Dashboard
- Instance Secret : Fourni lors de la création de l'instance dans le Dashboard
- Activer le monitoring ? : true/false
📝 Exemple d'utilisation
$ npx @pixelpoule/monitoring-setup
📦 Installation du monitoring Pixel Poule
✅ Projet Next.js détecté
? URL du Dashboard Admin : https://admin.pixelpoule.com
? Instance ID : 3c41b7ff-2f55-4dec-a5da-ab66ef374029
? Instance Secret : ••••••••••••••••••••
? Activer le monitoring ? Yes
🔧 Installation en cours...
📦 Installation de @pixelpoule/monitoring...
✅ Package installé
⚙️ Configuration de .env.local...
✅ Fichier .env.local créé
🔧 Configuration du middleware...
✅ Middleware configuré
✨ Installation terminée !
✅ Package @pixelpoule/monitoring installé
✅ Variables d'environnement configurées
✅ Middleware configuré
📋 Prochaines étapes :
1. Vérifiez votre fichier .env.local
2. Vérifiez votre fichier middleware.ts
3. Lancez votre projet : npm run dev
4. Testez une route API
5. Vérifiez le Dashboard : https://admin.pixelpoule.com/monitoring🔒 Sécurité
- Les secrets sont demandés en mode
password(masqués) - Aucune donnée n'est envoyée ailleurs que dans votre projet
.env.localn'est jamais commité (dans.gitignore)
🗑️ Désinstallation
Pour retirer le monitoring d'un projet :
# 1. Désinstaller le package
npm uninstall @pixelpoule/monitoring
# 2. Supprimer les variables ADMIN_* de .env.local
# 3. Restaurer l'ancien middleware
mv middleware.ts.backup middleware.ts📦 Ce qui est installé
votre-projet/
├── .env.local # ← Variables ADMIN_* ajoutées
├── middleware.ts # ← Modifié pour utiliser le monitoring
├── middleware.ts.backup # ← Backup de l'ancien middleware
├── node_modules/
│ └── @pixelpoule/monitoring/ # ← Package installé
└── package.json # ← Dépendance ajoutée🎯 Ce qui est surveillé automatiquement
- ✅ Performance de toutes les routes
/api/* - ✅ Erreurs capturées automatiquement
- ✅ Méthodes HTTP : GET, POST, PUT, DELETE, etc.
- ✅ Status codes : 200, 400, 500, etc.
- ✅ Durée de chaque requête
💡 Ajouter plus de contexte aux erreurs
Pour enrichir les logs avec plus de contexte (documentId, userId, etc.) :
import { sendLog } from '@pixelpoule/monitoring';
// Dans un catch block
sendLog({
type: 'api_error',
severity: 'critical',
message: error.message,
context: {
endpoint: '/api/process-document',
documentId: '...',
errorStep: 'extraction',
},
stackTrace: error.stack,
});🔧 Options avancées
Exclure certaines routes
Modifiez middleware.ts :
export const middleware = createMonitoringMiddleware({
excludeRoutes: ['/api/health', '/api/ping'],
// ...
});📄 Licence
ISC © Pixel Poule
