Qu'est-ce que PM2 : Un guide complet pour la gestion des processus Node.js

LightNode
By LightNode ·

Introduction

La gestion des processus est un aspect crucial de l'exécution des applications Node.js en environnement de production, et PM2 s'est imposé comme l'une des solutions les plus puissantes et les plus largement adoptées dans ce domaine. En tant que gestionnaire de processus robuste et environnement d'exécution pour la production, PM2 est devenu un outil essentiel dans l'écosystème moderne de Node.js.

PM2 (Process Manager 2) est un gestionnaire de processus avancé conçu spécifiquement pour les applications Node.js, bien qu'il puisse également gérer d'autres types d'applications. Il offre une suite complète de fonctionnalités qui aident les développeurs et les équipes d'exploitation à maintenir et à faire évoluer efficacement leurs applications. De la gestion de processus de base aux capacités avancées de surveillance, PM2 répond à de nombreux défis rencontrés lors de l'exécution d'applications Node.js en production.

L'importance de la gestion des processus dans les applications Node.js ne saurait être surestimée. Les applications Node.js s'exécutent par défaut sur un seul thread, ce qui les rend vulnérables aux plantages et nécessite une intervention manuelle pour les redémarrages. De plus, les applications modernes doivent se mettre à l'échelle sur plusieurs cœurs CPU pour gérer efficacement une charge accrue. C'est là que PM2 intervient, offrant une gestion automatique des processus, un équilibrage de charge et des capacités de surveillance essentielles pour les applications de niveau production.

En environnement de production, PM2 constitue un composant d'infrastructure essentiel en fournissant :

  • Le redémarrage automatique des applications après un plantage
  • L'équilibrage de charge sur plusieurs cœurs CPU
  • La surveillance et la journalisation intégrées
  • Les mises à jour sans interruption
  • La gestion des environnements
  • Le clustering des processus

Comprendre PM2

Définition et fonctionnalités principales

PM2 est un gestionnaire de processus open-source pour les applications Node.js, développé et maintenu par l'équipe de Keymetrics (aujourd'hui PM2). Il agit comme un gestionnaire de processus en arrière-plan qui aide les développeurs à gérer et à maintenir leurs applications en ligne 24 heures sur 24, 7 jours sur 7. Au cœur de PM2, un niveau de gestion des processus enveloppe vos applications Node.js pour gérer de nombreux aspects complexes de leur exécution en production.

Historique et développement

Lancé pour la première fois en 2013, PM2 a été créé pour répondre aux besoins croissants des applications Node.js en environnement de production. Le projet est depuis devenu l'un des gestionnaires de processus les plus populaires de l'écosystème Node.js, avec des millions de téléchargements sur npm et une communauté solide de contributeurs. Le nom "PM2" signifie qu'il s'agit d'un gestionnaire de processus de deuxième génération, tirant parti des enseignements des solutions précédentes.

Pourquoi choisir PM2 ?

Comparé à d'autres gestionnaires de processus comme Forever, Nodemon ou SystemD, PM2 se distingue par plusieurs aspects :

  1. Jeu de fonctionnalités complet : PM2 propose une suite complète de fonctionnalités prêtes pour la production, allant de la gestion de processus de base à des outils avancés de surveillance et de déploiement.
  2. Développement actif : Avec des mises à jour régulières et une communauté solide, PM2 évolue constamment pour répondre aux besoins des applications modernes.
  3. Intégration facile : PM2 s'intègre parfaitement avec les outils et plateformes de développement populaires, ce qui en fait un choix naturel pour les workflows modernes.
  4. Prêt pour la production : Testé sur le terrain, il est utilisé par des entreprises de toutes tailles, des startups aux grandes entreprises.

Principaux avantages

Pour les équipes de développement, PM2 offre plusieurs avantages majeurs :

  1. Gestion simplifiée des processus : Les développeurs peuvent se concentrer sur l'écriture de code tandis que PM2 gère les complexités de la gestion des processus.
  2. Fiabilité accrue des applications : Les capacités de redémarrage automatique et de surveillance garantissent que les applications restent en ligne.
  3. Performance améliorée : Les capacités intégrées d'équilibrage de charge et de clustering permettent aux applications d'utiliser efficacement les ressources du serveur.
  4. Visibilité détaillée : Les fonctionnalités complètes de surveillance et de journalisation offrent une visibilité sur le comportement et les performances des applications.
  5. Intégration dans le workflow de développement : PM2 s'intègre naturellement aux workflows de développement modernes, prenant en charge diverses stratégies et environnements de déploiement.

Fonctionnalités principales et capacités

Gestion des processus

Les capacités de gestion des processus de PM2 constituent la base de son fonctionnement. Les fonctionnalités clés incluent :

  • Daemonisation des applications : PM2 exécute vos applications en tant que processus en arrière-plan (daemons), garantissant qu'elles continuent de fonctionner même après votre déconnexion du serveur.
  • Gestion du cycle de vie des processus : PM2 gère automatiquement les opérations de démarrage, d'arrêt, de redémarrage et de rechargement avec des commandes simples comme pm2 start, pm2 stop et pm2 restart.
  • Redémarrage automatique : En cas de crash ou d'arrêt imprévu, PM2 redémarre automatiquement l'application, garantissant un temps de disponibilité maximal.

Équilibrage de charge

PM2 offre des capacités intégrées d'équilibrage de charge pour répartir efficacement la charge entre plusieurs cœurs CPU :

  • Mode cluster : Créez facilement plusieurs instances de votre application en utilisant le module cluster de Node.js avec une commande unique :
pm2 start app.js -i max
  • Distribution intelligente de la charge : PM2 équilibre automatiquement les requêtes entre toutes les instances de votre application pour maximiser l'utilisation des ressources du serveur.
  • Gestion des instances : Ajustez dynamiquement le nombre d'instances en fonction des besoins de charge.

Gestion des journaux

Les fonctionnalités de gestion des journaux de PM2 permettent de suivre le comportement des applications et de résoudre les problèmes :

  • Gestion centralisée des journaux : Tous les journaux d'application sont automatiquement collectés et stockés dans un emplacement centralisé.
  • Rotation des journaux : La prise en charge intégrée de la rotation des journaux évite qu'ils n'occupent trop d'espace disque.
  • Surveillance en temps réel des journaux : Affichez les journaux en temps réel avec des commandes comme pm2 logs avec des options de filtrage variées.

Capacités de surveillance

PM2 offre des fonctionnalités robustes de surveillance pour maintenir des performances optimales :

  • Surveillance des ressources : Suivez l'utilisation du CPU, la consommation de mémoire et d'autres métriques essentielles pour chaque processus.
  • Métriques de performance : Surveillez les taux de requêtes, les temps de réponse et d'autres métriques spécifiques aux applications.
  • Contrôles d'intégrité : Des vérifications régulières de l'intégrité garantissent que votre application répond correctement.

Rechargement sans interruption

PM2 permet de mettre à jour les applications sans interruption de service :

  • Rechargement en douceur : Mettez à jour le code de l'application sans perdre de connexions utilisateur avec pm2 reload.
  • Redémarrages progressifs : Pour les applications avec plusieurs instances, PM2 effectue des redémarrages progressifs pour maintenir la disponibilité du service.
  • Gestion des versions : Suivez les versions de l'application et effectuez facilement un retour arrière en cas de problème.

Démarrer avec PM2

Processus d'installation

L'installation de PM2 est simple via Node Package Manager (npm). Une installation globale garantit que PM2 est disponible sur tout le système :

npm install pm2 -g

Pour les utilisateurs préférant Yarn :

yarn global add pm2

Commandes et utilisation de base

PM2 offre une interface en ligne de commande intuitive pour gérer les applications :

  1. Démarrer des applications :
# Démarrage basique
pm2 start app.js

# Démarrage avec un nom spécifique
pm2 start app.js --name "mon-application"

# Démarrage en mode cluster
pm2 start app.js -i 4
  1. Gérer les processus :
# Lister tous les processus
pm2 list

# Arrêter une application
pm2 stop nom-application

# Redémarrer une application
pm2 restart nom-application

# Supprimer une application
pm2 delete nom-application

Configuration des processus

PM2 prend en charge les fichiers de configuration (fichiers d'écosystème) pour des déploiements plus complexes :

// ecosystem.config.js
module.exports = {
  apps: [{
    name: "mon-application",
    script: "./app.js",
    instances: 4,
    exec_mode: "cluster",
    watch: true,
    env: {
      NODE_ENV: "development",
    },
    env_production: {
      NODE_ENV: "production",
    }
  }]
}

Démarrez votre application à l'aide du fichier de configuration :

pm2 start ecosystem.config.js

Gestion des environnements

PM2 simplifie la gestion des configurations d'environnement :

  1. Variables d'environnement :
  • Définissez des variables spécifiques dans le fichier d'écosystème.
  • Passez d'un environnement à l'autre à l'aide du drapeau --env :
pm2 start ecosystem.config.js --env production
  1. Fichiers de configuration :
  • Maintenez des fichiers de configuration distincts pour différents environnements.
  • Utilisez des paramètres spécifiques à l'environnement pour différents scénarios de déploiement.
  1. Configuration en temps réel :
  • Modifiez les variables d'environnement à la volée.
  • Mettez à jour la configuration de l'application sans redémarrage.

Fonctionnalités avancées

Mode cluster

Le mode cluster de PM2 permet des capacités avancées de mise à l'échelle des applications :

// Configuration du mode cluster
module.exports = {
  apps: [{
    script: 'app.js',
    instances: 'max',     // ou un nombre spécifique
    exec_mode: 'cluster',
    instance_var: 'INSTANCE_ID',
    wait_ready: true,
    listen_timeout: 3000
  }]
}

Fonctionnalités clés du mode cluster :

  • Équilibrage automatique de la charge entre les instances.
  • Rechargements sans interruption.
  • Récupération après échec des instances.
  • Optimisation des cœurs CPU.

Intégration avec les conteneurs

PM2 s'intègre parfaitement aux environnements conteneurisés :

  1. Intégration Docker :
  • Images Docker officielles disponibles.
  • Gestion des processus conteneurisés.
  • Points de contrôle de santé (health check).
  • Surveillance adaptée aux conteneurs.
  1. Support Kubernetes :
  • Gestion des processus dans les pods Kubernetes.
  • Intégration avec le cycle de vie des conteneurs.
  • Optimisation des ressources.

Workflow de déploiement

PM2 propose des fonctionnalités de déploiement robustes :

# Configuration du déploiement
pm2 ecosystem

# Déployer en production
pm2 deploy production

# Annuler un déploiement si nécessaire
pm2 deploy production revert 1

Caractéristiques du déploiement :

  • Déploiement multi-serveur.
  • Scripts de déploiement automatisés.
  • Gestion des versions.
  • Capacités de retour arrière.
  • Hooks avant et après le déploiement.

Tableau de bord de surveillance

PM2 offre une surveillance complète via son interface web intégrée :

  1. Métriques en temps réel :
  • Utilisation du CPU et de la mémoire.
  • Taux de requêtes.
  • Taux d'erreurs.
  • Métriques personnalisées.
  1. Surveillance système :
  • Contrôles de santé du serveur.
  • Utilisation des ressources.
  • Statistiques réseau.
  • Utilisation du disque.

Rotation des journaux

PM2 prend en charge une gestion avancée des journaux :

module.exports = {
  apps: [{
    name: "application",
    script: "./app.js",
    log_date_format: "YYYY-MM-DD HH:mm Z",
    error_file: "./logs/error.log",
    out_file: "./logs/out.log",
    log_file: "./logs/combined.log",
    max_size: "10M",
    max_restarts: 10
  }]
}

Meilleures pratiques

Recommandations de configuration

Lors de l'utilisation de PM2 en production, il est essentiel de suivre ces meilleures pratiques de configuration :

  1. Configuration des applications :
  • Utilisez toujours des fichiers de configuration (ecosystem files) plutôt que des paramètres en ligne de commande.
  • Définissez des limites de mémoire adaptées à vos applications.
  • Configurez une gestion appropriée des erreurs et des journaux.
  • Donnez des noms significatifs à vos processus.

Exemple d'un fichier d'écosystème bien configuré :

module.exports = {
  apps: [{
    name: 'application-production',
    script: './app.js',
    instances: 'max',
    max_memory_restart: '1G',
    max_restarts: 10,
    watch: false,
    error_file: './logs/error.log',
    out_file: './logs/output.log',
    time: true
  }]
}

Considérations de sécurité

Il est crucial de mettre en œuvre des mesures de sécurité appropriées :

  1. Permissions des processus :
  • Exécutez les processus avec les privilèges minimum requis.
  • Utilisez des comptes utilisateur séparés pour différentes applications.
  • Configurez correctement les permissions des fichiers.
  1. Variables d'environnement :
  • Ne jamais compromettre les données sensibles dans le contrôle de version.
  • Utilisez des fichiers de configuration spécifiques à l'environnement.
  • Implémentez une gestion sécurisée des secrets.
  1. Sécurité réseau :
  • Configurez des règles de pare-feu adaptées.
  • Mettez en place des limitations de taux.
  • Utilisez des protocoles de communication sécurisés.

Optimisation des performances

Optimisez votre configuration PM2 pour des performances maximales :

  1. Gestion des ressources :
  • Surveillez et ajustez les limites de mémoire.
  • Optimisez le nombre d'instances en fonction des cœurs CPU.
  • Mettez en place des stratégies d'équilibrage de charge adaptées.
  1. Mise à l'échelle des applications :
  • Utilisez efficacement le mode cluster.
  • Implémentez une mise à l'échelle horizontale si nécessaire.
  • Surveillez et ajustez en fonction des modèles de charge.

Pièges courants à éviter

  1. Gestion des processus :
  • Ne pas ignorer les journaux des applications.
  • Évitez de faire fonctionner trop d'instances.
  • Ne négligez pas la surveillance et les alertes.
  1. Erreurs de configuration :
  • Ne pas définir correctement les variables d'environnement.
  • Configurations incorrectes des chemins.
  • Absence de gestion des erreurs.
  1. Problèmes de déploiement :
  • Ne pas tester les scripts de déploiement.
  • Ignorer les procédures de retour arrière.
  • Surveillance insuffisante lors des déploiements.
What is PM2?

Questions fréquemment posées (FAQ)

1. Comment redémarrer mon application lorsque les fichiers changent ?

Réponse : Vous pouvez utiliser la fonctionnalité de surveillance de PM2 :

# Utilisation en ligne de commande
pm2 start app.js --watch

# Ou dans ecosystem.config.js
module.exports = {
  apps: [{
    script: 'app.js',
    watch: true,
    ignore_watch: ['node_modules', 'logs']
  }]
}

2. Comment puis-je afficher les journaux d'une application spécifique ?

Réponse : PM2 fournit plusieurs commandes pour la gestion des journaux :

# Afficher tous les journaux
pm2 logs

# Afficher les journaux d'une application spécifique
pm2 logs nom-application

# Voir les N dernières lignes
pm2 logs --lines 100

3. Pourquoi mon application consomme-t-elle plus de mémoire que prévu ?

Réponse : Cela peut être dû à plusieurs raisons :

  • Fuites de mémoire dans votre application.
  • Trop d'instances en cours d'exécution.
  • Collecte des ordures (garbage collection) inefficace.

Solution : Utilisez la fonctionnalité de limite de mémoire de PM2 :

{
  "name": "app",
  "script": "app.js",
  "max_memory_restart": "1G"
}

4. Comment exécuter des configurations différentes en développement et en production ?

Réponse : Utilisez les configurations spécifiques à l'environnement :

module.exports = {
  apps: [{
    script: 'app.js',
    env: {
      NODE_ENV: 'development',
      PORT: 3000
    },
    env_production: {
      NODE_ENV: 'production',
      PORT: 80
    }
  }]
}

5. Comment configurer PM2 pour qu'il démarre automatiquement après un redémarrage système ?

Réponse : Utilisez la commande startup :

# Générer un script de démarrage
pm2 startup

# Sauvegarder la liste des processus en cours
pm2 save

6. Comment mettre à jour PM2 lui-même ?

Réponse : Suivez ces étapes :

# Installer la dernière version de PM2
npm install pm2@latest -g

# Mettre à jour PM2 en mémoire
pm2 update

7. Pourquoi mon application Node.js n'utilise-t-elle pas tous les cœurs CPU ?

Réponse : Par défaut, Node.js est monothread. Utilisez le mode cluster de PM2 :

# En ligne de commande
pm2 start app.js -i max

# Ou dans ecosystem.config.js
module.exports = {
  apps: [{
    script: 'app.js',
    instances: 'max',
    exec_mode: 'cluster'
  }]
}

8. Comment surveiller les performances de mon application ?

Réponse : Utilisez les outils de surveillance de PM2 :

# Surveillance de base
pm2 monit

# Tableau de bord web
pm2 plus

# Vue d'ensemble du statut
pm2 status

9. Comment gérer les plantages d'application ?

Réponse : PM2 redémarre automatiquement les applications plantées, mais vous pouvez configurer des comportements spécifiques :

module.exports = {
  apps: [{
    script: 'app.js',
    max_restarts: 10,
    min_uptime: "1m",
    restart_delay: 5000
  }]
}

10. Comment faire tourner les journaux pour éviter les problèmes d'espace disque ?

Réponse : Configurez la rotation des journaux dans votre fichier d'écosystème :

module.exports = {
  apps: [{
    script: 'app.js',
    max_size: "10M",
    out_file: "./logs/out.log",
    error_file: "./logs/error.log",
    merge_logs: true,
    time: true
  }]
}