Module MemCached FR

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

Informations

Module name Accélérateur MemCached
Editor / Editeur NLTechno - http://www.nltechno.com
Download or buy page / Page achat ou téléchargement www.dolistore.com
Status / Statut / Estado Stable
Prerequisites / Prérequis Dolibarr min version 3.6.0   
Last update date / Date mise à jour fiche / Fecha última actualización 2019-08-16
Note / Nota

Fonctionnalités

Permet à Dolibarr d'améliorer ses performances en utilisant un serveur de cache MemCached. Dolibarr met alors en cache le résultat d'opérations récurrentes comme le chargement de fichiers de traduction. Selon la plateforme le temps d'affichage des pages est accéléré de 20% à 40%.

Prérequis

Pour installer/utiliser ce module, vous devez au préalable

  • Disposer d'un serveur memcached et connaitre son adresse (ex: localhost) et son port (ex: 11211). La procédure pour installer un tel serveur ne fait pas partie de cette documentation. Se référer à la documentation sur Internet pour cela. Exemple:

- Voir http://rutfin.wordpress.com/2013/05/19/installing-memcache-on-windows-8-for-wamp-server/ pour une installation d'un serveur memcached sous Windows

- Voir http://2bits.com/articles/installing-memcached-125-and-memcache-pecl-223-ubuntu-server.html pour une installation sur Ubuntu, ...

- Voir https://wincent.com/wiki/Installing_memcached_1.4.1_on_Mac_OS_X_10.6_Snow_Leopard pour une installation sur MacOS 10.6

  • Avoir les fonctions "memcache" ou "memcached" actives dans votre PHP (Voir dans Accueil -> Information systèmes -> PHP si au moins un des modules client memcache ou memcached est disponible).

La encore si ces fonctions ne sont pas disponibles, se référer à la documentation sur Internet pour voir comment ajouter le module PHP memcache ou memcached.

Installation

  • Télécharger le fichier archive du module (.zip) depuis le site web www.dolistore.com ou le récupérer par tout autre manière.
  • Placer le répertoire du module dans le répertoire custom de Dolibarr:
    • Pour cela, aller dans Accueil - Configuration - Modules - Déployer/installer une app/module externe
    • Téléverser le fichier. Note: Si cela échoue, vous pouvez manuellement dézipper le fichier dans le répertoire custom via la ligne de commande: aller dans le répertoire *custom* et décompressez le zip avec la commande: unzip fichiermodule.zip
  • Le module est opérationnel et peut être activé.

Configuration

Pour utiliser ce module, il vous faut d'abord l'activer. Pour cela, après s'être connecté avec un compte administrateur, aller sur la page "Accueil - Configuration - Modules".

Choisissez l'onglet dans lequel apparaît le module puis cliquez sur "Activer".

Le module est alors activé.

Si un pictogramme apparaît à la fin de la ligne du module, cliquez dessus pour accéder à la page de paramétrage spécifique à ce module.


Page de configuration propre au module:

Onglet configuration serveur

Dans la page de configuration dédiée au module, renseigner les informations suivantes:

  • Nom du serveur de cache: Mettre un nom dns ou une addresse ip du serveur Memcached.
  • Port du serveur de cache: Mettre le port du serveur Memcached.

Sauvegarder et c'est tout. Dolibarr doit maintenant utiliser le serveur de cache quand il l'estime nécessaire.

Note: Si vous ajouter la ligne

$dolibarr_memcached_view_disable=1;

dans le fichier htdocs/conf/conf.php alors les 2 onglets de statistiques globales seront désactivés. Ceci est utile pour les hébergeurs de Dolibarr en mode SaaS afin que les utilisateurs n'aient pas de visualisation sur des éléments partagés par la plateforme d'hébergement et qui ne les concernent pas.


Onglet statistiques serveur

Cet onglet présente des statistiques sur l'utilisation du cache. Pour une estimation de la performance, voir plutôt le chapitre suivant.

Memcached screenshot 1.png

Utilisation

Ce module est un module technique. Dès lors que la configuration est faite, Dolibarr utilise le serveur de cache quand il l'estime nécessaire (par exemple, à chaque appel de page pour éviter de charger les paramètres/traductions). Il n'y a aucune autre manipulation particulière à faire.

La copie écran suivante présente une comparaison de performance, réalisé avec BlackFire, avec et sans le cache. Le gros gain de 59ms (soit 25% plus rapide pour un total après de 159ms) se fait surtout lors de la phase de chargement des fichiers langs (déjà en cache, 56ms de gain pour la seule phase des appels des fonctions Translate::load).

Comparison with blackfire.png

Développement

Le développement de ce module n'est pas inclus dans le repository GIT standard de Dolibarr mais dans un repository dédié de modules gérés par NLTechno sur la plateforme Git de Framasoft:

Notons que c'est un repository privé, aussi il vous faut créer un compte et postuler au projet depuis le site https://git.framasoft.org pour pouvoir cloner les sources par GIT.