# Performances

Lemonldap::NG a été conçu pour être très performant. En particulier, il utilise les capacités multi-threads d'Apache-2, donc pour optimiser les performances, utilisez de préférence mpm-worker.

## Performance globale

On Linux, by default, there is no DNS cache and LemonLDAP::NG portal request DNS at every connexions on LDAP or DB. Sous forte charge, ça peut générer des centaines de requêtes DNS et des erreurs sur les connexions LDAP (timed out).

To bypass this, you can:

- Use IP in configuration to avoid DNS resolution
- Install a DNS cache like nscd, netmask or bind

## Performance des agents (handlers)

Les agents vérifient les droits et calculent les en-têtes pour chaque requête HTTP. Donc pour augmenter les performances, évitez les règles trop complexes en utilisant les macros, groupes ou macros locales.

### Macros et groupes

Les macros et les groupes sont calculées pendant le processus d'authentification par le portail :

- les macros sont utilisées pour étendre (ou réécrire) les variables exportées. Une macro est stockée comme un attribut : elle peut contenir le résultat d'un calcul booléen ou n'importe quelle chaîne de caractères
- les groupes sont stockées en chaîne de caractères séparées par des espaces dans l'attribut spécial “groups” : il contient les noms des groupes dont la règle à retournée une valeur non nulle pour l'utilisateur courant
- On peut également définir des groupes dans `$hGroups` qui est une référence à une table de hashage de la forme :

    $hGroups = {
              'group3' => {
                            'description' => [
                                               'Service 3',
                                               'Service 3 TEST'
                                             ],
                            'cn' => [
                                      'group3'
                                    ],
                            'name' => 'group3'
                          },
              'admin' => {
                           'name' => 'admin'
                         }
            }

Exemples de macros:

    # macro booléenne
    isAdmin -> $uid eq 'foo' or $uid eq 'bar'
    # autre macro
    displayName -> $givenName." ".$surName

    # Utiliser une macro booléenne dans une règle
    ^/admin -> $isAdmin
    # Utiliser une macro chaîne dans un en-tête HTTP
    Display-Name -> $displayName

Exemples de groupes:

    # group
    admin -> $uid eq 'foo' or $uid eq 'bar'

    # Use a group in a rule
    ^/admin -> $groups =~ /\badmin\b/

    # Or with hGroups
    ^/admin -> defined $hGroups->{'admin'}

Noter que les groupes sont calculés après les macros, donc une règle de groupe peut utiliser une valeur issue d'une macro.
Les macros et groupes sont calculés dans l'ordre alpha-numerique, c'est à dire dans l'ordre d'affichage dans le manager. Par exemple, la macro “macro1” sear calculée avant la macro “macro2” : donc l'expression de macro2 peut utiliser la valeur $macro1. De même pour les groupes : une règle de groupe peut en utiliser une autre calculée précédemment.

### Macros locales

Les macros et les groupes sont stockées dans la base de données des sessions. Local macros is a special feature of handler that permits one to have macros useable localy only. Ces macros sont calculées seulement à leur premier usage et stockées dans le cache local des sessions (uniquement pour ce serveur) et seulement si l'utilisateur accède à l'application relative. Ce dispositif évite de stocker trop de données.

    # règle
    admin -> $admin ||= ($uid eq 'foo' or $uid eq 'bar')
    # en-tête
    Display-Name -> $displayName ||= $givenName." ".$surName

Notez que cette fonctionnalité n'est intéressante que pour les systèmes Lemonldap::NG protégeant un grand nombre d'applications

## Performances du portail

### Performances générales

Le portail est le composant le plus gros de Lemonldap::NG. Il est recommendé d'utiliser ModPerl::Registry au lieu d'utiliser le dispositif "cgi-script" tel qu'indiqué dans les fichiers de configuration d'Apache proposés en exemple (portal-apache2.conf):

    <Files *.pl>
        SetHandler perl-script
        PerlResponseHandler ModPerl::Registry
    </Files>

On peut utiliser un serveur FastCGI en utilisant le fichier index.fcgi disponible dans les exemples du portail.

En environnement de production et pour de meilleures performances réseau, utiliser les versions compactées des librairies javascript et css : utiliser `make install PROD=yes`. Ceci est fait par défaut avec les paquets RPM/DEB.

### Accès à la configuration

En mettant `useLocalConf` à 1 dans lemonldap-ng.ini (section [Portal]), le portail utilisera la configuration cachée. Pour la rafraîchir, il faut installer un agent (handler) sur le même serveur pour utiliser le mécanisme de rafraîchissement ou redémarrer le serveur à chaque changement.

### Performances au démarrage

Pour accélérer le démarrage du portail lorsque le serveur est relancé, ajoutez les lignes suivantes dans les fichiers de configuration d'Apache (tel que proposé dans portal-apache2.conf):

    <Perl>
        require Lemonldap::NG::Portal::SharedConf;
        Lemonldap::NG::Portal::SharedConf->compile(
            qw(delete header cache read_from_client cookie redirect unescapeHTML));
        # Décommentez cette ligne si vous utilisez le menu Lemonldap::NG
        require Lemonldap::NG::Portal::Menu;
        # Décommentez cette ligne si vous utilisez les capacités SOAP du portail
        require SOAP::Lite;
    </Perl>

### Performances d'Apache::Session

Les agents (handlers) Lemonldap::NG utilisent un cache local pour stocker les sessions (pour 10 minutes). Ainsi, les modules Apache::Session ne posent pas de problèmes aux agents. En revanche, ce peut-être un frein pour le portail :

1. Lorsque sont activées les paramètres de restriction d'ouverture de session, celles-ci sont toutes examinées à chaque nouvelle authentification sauf lorsqu'un module de la famille Apache::Session::Browseable est utilisé.
2. Comme MySQL ne dispose pas toujours de dispositif de transaction, Apache::Session::MySQL a été conçu en utilisant les verrous MySQL. Ceci dégrade fortement les performances de MySQL, si vous voulez stocker les sessions dans une base de données MySQL, utilisez l'une des solutions suivantes

#### Remplacer MySQL par Apache::Session::Flex

Dans le champ “Module Apache::Session”, indiquez ”Apache::Session::Flex” et utilisez les paramètres suivants :

    Store      -> MySQL
    Lock       -> Null
    Generate   -> MD5
    Serialize  -> Storable
    DataSource -> dbi:mysql:sessions;host=...
    UserName   -> ...
    Password   -> ...

Depuis la version 1.90 d'Apache::Session, on peut utiliser Apache::Session::MySQL::NoLock à la place

#### Utiliser Apache::Session::Browseable

Apache::Session::Browseable est une surcouche d'autres modules Apache::Session qui ajoute des capacités d'indexation. Pour l'utiliser (avec MySQL par exemple), choisissez “Apache::Session::Browseable::MySQL” comme “Module Apache::Session” et utilisez les paramètres suivants :

    DataSource -> dbi:mysql:sessions;host=...
    UserName   -> user
    Password   -> password
    Index      -> ipAddr uid

Notez que Apache::Session::Browseable::MySQL n'utilise pas les verrous MySQL.

Un module Apache::Session::Browseable::Redis a été créé, c'est le plus rapide (excepté pour l'explorateur de sessions, battu par Apache::Session::Browseable::DBI/LDAP >= 1.0)
Certains modules Apache::Session ne sont pas utilisables par Lemonldap::NG tel Apache::Session::Memcached, car ce module n'offre pas de dispositif de parcours des sessions They does not allow one to use sessions explorer neither manage one-off sessions.

### Performances LDAP

Le serveur LDAP peut être un frein lorsque vous utilisez la récupération des groupes LDAP. Vous pouvez contourner cette dificulté en utilisant les champs “memberOf” dans votre schéma LDAP :

    dn: uid=foo,dmdName=people,dc=example,dc=com
    ...
    memberOf: cn=admin,dmdName=groups,dc=example,dc=com
    memberOf: cn=su,dmdName=groups,dc=example,dc=com

Ainsi au lieu d'utiliser la récupération des groupes LDAP, vous avez juste à stocker le champ “memberOf” dans vos variables exportées. With OpenLDAP, you can use the memberof overlay to do it automatically.

N'oubliez pas de créer un index sur le champ utilisé pour trouver les utilisateurs (uid par défaut)
Pour éviter de stocker les dn dans votre base de sessions, vous pouvez utiliser une macro pour réécrire memberOf :

- Variables exportées

    ldapgroups -> memberOf

Pour l'instant, ldapgroups contient “cn=admin,dmdName=groups,dc=example,dc=com cn=su,dmdName=groups,dc=example,dc=com”

- Une petite macro :

    ldapgroups -> join(" ",($ldapgroups =~ /cn=(.*?),/g))

Maintenant, ldapgroups contient “admin su”

## Performances du Manager

### Désactiver les modules inutilisés

In lemonldap-ng.ini, set only modules that you will use. By default, configuration, sessions explorer and notifications explorer are enabled. Exemple :

    [manager]
    enabledModules = conf, sessions

### Use static HTML files

Once Manager is installed, browse enabled modules (configuration, sessions, notifications) and save the web pages respectively under `manager.html`, `sessions.html` and `notifications.html` in the `DocumentRoot` directory. Then replace this in Manager file of Apache configuration:

    RewriteRule "^/$" "/psgi/manager-server.fcgi" [PT]
    # DirectoryIndex manager.html
    # RewriteCond "%{REQUEST_FILENAME}" "!\.html$"
    RewriteCond "%{REQUEST_FILENAME}" "!^/(?:static|doc|fr-doc|lib).*"
    RewriteRule "^/(.+)$" "/psgi/manager-server.fcgi/$1" [PT]

by:

    # RewriteRule "^/$" "/psgi/manager-server.fcgi" [PT]
    DirectoryIndex manager.html
    RewriteCond "%{REQUEST_FILENAME}" "!\.html$"
    RewriteCond "%{REQUEST_FILENAME}" "!^/(?:static|doc|fr-doc|lib).*"
    RewriteRule "^/(.+)$" "/psgi/manager-server.fcgi/$1" [PT]

So manager HTML templates will be no more generated by Perl but directly given by the web server.