Gestion & surveillance du Cache Redis : installation et aide

Dans votre Back Office, ouvrez Modules > "Module Manager", choisissez "Upload a module" et téléversez le ZIP du module. Installez-le, puis cliquez sur Configurer. Sur les anciennes versions de PrestaShop, utilisez la page des modules correspondante.

Votre hébergement doit déjà fournir Redis et l'extension PHP Redis pour l'environnement PHP web. Le module gère une connexion, un tableau de bord et un explorateur de clés. Il n'installe pas Redis et ne configure pas le moteur de cache de votre boutique.

Dans le Back Office, le module s'appelle Tableau de bord Redis et gestion des clés. Ouvrez son écran Paramètres. Commencez par Connexion. Renseignez l'hôte Redis, le port, le mot de passe facultatif, la base et un préfixe de clés exclusif. Sur Docker, utilisez le nom du service Redis si 127.0.0.1 pointerait vers le conteneur PHP lui-même.

Avant le premier enregistrement, vérifiez Mise en cache > Vider le cache à l’enregistrement de la configuration, dont la valeur par défaut est Oui. Désactivez ce réglage si vous souhaitez seulement tester la connexion. Enregistrez, puis vérifiez le résultat de la connexion.

Les onglets sont Connexion, Mise en cache et Suivi. Connexion contient l'interrupteur principal et les informations Redis. Mise en cache contient les trois préférences de cache enregistrées et le vidage à l'enregistrement. Suivi contrôle les statistiques du tableau de bord et son actualisation automatique.

• Activer le module. Active ou désactive la connexion du tableau de bord Redis et de l'explorateur de clés ; valeur par défaut : 1. Réglez cette option dans l'onglet Connexion.
• Hôte Redis. Définit le nom d'hôte ou l'adresse IP de Redis ; valeur par défaut : 127.0.0.1. Sur un hébergement Docker, utilisez le nom du conteneur ou du service Redis.
• Port Redis. Définit le port TCP de Redis ; valeur par défaut : 6379.
• Mot de passe Redis. Définit le mot de passe d'authentification Redis ; valeur par défaut : vide. Un champ secret vide conserve le mot de passe enregistré. Utilisez la commande d'effacement du champ secret pour le supprimer lorsque Redis ne nécessite plus d'authentification.
• Index de la base Redis. Sélectionne le numéro de base Redis ; valeur par défaut : 0. Utilisez un autre numéro uniquement si votre hébergeur vous l'a attribué.
• Préfixe des clés. Limite les recherches de l'explorateur et les vidages par préfixe aux clés commençant par ce préfixe ; valeur par défaut : ps_.
• Activer le cache d’objets. Enregistre la préférence du module pour utiliser Redis comme moteur de cache d'objets PrestaShop ; valeur par défaut : 0. Le module enregistre ce réglage mais ne réécrit pas lui-même les fichiers de cache serveur de PrestaShop.
• Activer le stockage des sessions. Enregistre la préférence du module pour conserver les sessions PHP dans Redis ; valeur par défaut : 0. La gestion des sessions serveur/PHP doit toujours être configurée par votre hébergeur ou développeur.
• Activer le cache des pages complètes. Enregistre la préférence du module pour la mise en cache des pages complètes pour les visiteurs non connectés ; valeur par défaut : 0. Ce module n'ajoute pas à lui seul de couche de cache de pages dans la boutique.
• Vider le cache à l’enregistrement de la configuration. Supprime les clés correspondant au préfixe configuré après un enregistrement de configuration et un test de connexion réussis ; valeur par défaut : 1.
• Activer le tableau de bord de surveillance. Contrôle le chargement des statistiques du tableau de bord ; valeur par défaut : 1. L’extension PHP Redis doit être disponible, et ce réglage ainsi que Activer le module doivent être activés.
• Intervalle d’actualisation du tableau de bord. Recharge automatiquement le tableau de bord à cet intervalle en secondes ; valeur par défaut : 30. Réglez-le sur 0 pour une actualisation manuelle uniquement.

Les trois interrupteurs de cache n’activent pas le cache d’objets, le stockage des sessions PHP ni le cache de pages complètes. L’actualisation automatique fonctionne uniquement si l’extension PHP Redis est disponible et que le module et la surveillance sont activés. Elle est suspendue tant que l’onglet est masqué ou que vous remplissez la confirmation du vidage de la base partagée. Elle utilise l’URL du tableau de bord sans paramètres d’action pour ne pas répéter une action envoyée.

Ces exemples décrivent des valeurs de connexion ; ils ne constituent pas un format d'importation de fichier d'environnement :

Local service: Redis Host=127.0.0.1, Redis Port=6379, Redis Database Index=0, Key Prefix=shop1_
Docker service: Redis Host=redis, Redis Port=6379, Redis Database Index=0, Key Prefix=shop1_

Utilisez le mot de passe fourni par votre hébergeur. Si vous gérez la configuration du déploiement en PHP, les clés enregistrées sont REDIS_HOST, REDIS_PORT, REDIS_AUTH, REDIS_DB, REDIS_PREFIX, FLUSH_ON_SAVE, MONITOR_ENABLED et STATS_REFRESH sous ConfigTable::setMultiple('mprinstantredis', [...]).

Ouvrez le tableau de bord du module et utilisez son test de connexion. Il indique la version de Redis, les détails de connexion, la durée de fonctionnement, la mémoire, le taux de réussite, les opérations par seconde, les clients, les évictions et les informations d'expiration. Il s'agit de statistiques du serveur Redis et non de mesures limitées à votre préfixe. Le nombre total de clés est la somme des entrées de bases de données de Redis INFO.

Ouvrez Explorateur de clés. "Pattern" vaut * par défaut. "Limit" vaut 100 par défaut et accepte de 1 à 1000. Le préfixe configuré est ajouté au début de votre recherche :

Key Prefix: ps_
Pattern: *           scans ps_*
Pattern: product:*   scans ps_product:*

La liste affiche la clé sans le préfixe, son type, son TTL et sa taille/son nombre d'éléments. Inspectez les chaînes, listes, ensembles, ensembles triés et tables de hachage. Les aperçus des listes et des ensembles triés sont limités aux 100 premières entrées. Utilisez l'action Supprimer de la ligne uniquement pour les clés que vous souhaitez supprimer. Les demandes de suppression en masse sont prises en charge, mais l’explorateur de clés ne comporte pas de contrôles de sélection multiple.

Utilisez Vider l’espace de noms du tableau de bord Redis et de la gestion des clés pour l'espace de noms propre au module. Un vidage parcourt et supprime les clés portant le préfixe configuré littéral. Une propriété vide et un chevauchement avec un autre propriétaire enregistré bloquent la suppression. Les mêmes vérifications de propriété s'appliquent à la suppression des lignes et au vidage à l'enregistrement.

Pour une réinitialisation complète, le tableau de bord propose Vider la base partagée comme opération distincte uniquement lorsque la coordination des espaces de noms est prête. Vérifiez les propriétaires, cochez l'accusé de prise en compte et saisissez la phrase de confirmation affichée à l'écran. Un manifeste de propriété périmé ou une coordination indisponible bloque l'opération. Un vidage complet supprime toutes les clés de la base Redis sélectionnée, y compris celles d'applications indépendantes. Vérifiez le contenu de ces clés avant de l'utiliser.

1. Enregistrez les informations de connexion et vérifiez le message Connexion Redis vérifiée.
2. Ouvrez le tableau de bord et vérifiez que l'hôte et le port correspondent à l'instance Redis prévue.
3. Recherchez une clé connue dans Explorateur de clés. Un nombre de clés serveur supérieur à zéro sans clés correspondantes dans l'explorateur peut indiquer un préfixe incorrect.
4. Si l'avertissement concernant l'extension apparaît, activez php-redis pour l'environnement PHP qui sert le Back Office. L'activer uniquement pour la ligne de commande (CLI) ne suffit pas.
5. En cas d'échec de connexion, vérifiez avec votre hébergeur l'accessibilité réseau, le nom d'hôte, les identifiants et les autorisations de la base.
6. Si la suppression est bloquée, vérifiez le préfixe exclusif et les chevauchements entre propriétaires enregistrés. N'élargissez pas le préfixe pour contourner la protection.

Lisez le taux de réussite avec la mémoire et les évictions. Il correspond au rapport entre les succès Redis et la somme des succès et des échecs sur le serveur entier. La suppression de clés peut forcer la reconstruction du cache. Si Redis stocke aussi des sessions ou d'autres données applicatives, leur suppression peut affecter ces applications.

Utilisez Intégrité pour les vérifications du module. Les identifiants de contrôleur sont AdminMPRInstantRedis pour le tableau de bord, AdminMPRInstantRedisConfig pour la configuration, AdminMPRInstantRedisBrowser pour l'exploration et AdminMPRInstantRedisIntegrity pour l'intégrité.

Réglez Activer le module sur Non pour arrêter les connexions normales du tableau de bord et de l'explorateur. Désinstallez via "Module Manager" pour supprimer la configuration et les menus du module. La routine de désinstallation ne vide pas Redis et ne supprime pas le serveur Redis. Examinez séparément la configuration indépendante du cache et des sessions de votre hébergeur.

Nécessite PrestaShop 1.6.1 ou une version ultérieure et PHP 7.1 ou une version ultérieure.