Configurer Dispatcher configuring-dispatcher

Les sections suivantes décrivent comment configurer divers aspects de Dispatcher.

Prise en charge d’IPv6 et IPv4 support-for-ipv-and-ipv

Vous pouvez installer tous les éléments d’AEM et de Dispatcher sur des réseaux IPv4 et IPv6. Voir IPV4 et IPV6.

Fichiers de configuration de Dispatcher dispatcher-configuration-files

Par défaut, la configuration de Dispatcher est stockée dans le fichier texte dispatcher.any, bien que vous puissiez modifier le nom et l’emplacement de ce fichier au cours de l’installation.

Le fichier de configuration contient une série de propriétés à une ou plusieurs valeurs qui contrôlent le comportement de Dispatcher :

Une configuration peut être structurée comme suit :

# name of the dispatcher
/name "internet-server"

# each farm configures a set off (loadbalanced) renders
/farms
 {
  # first farm entry (label is not important, just for your convenience)
   /website
     {
     /clientheaders
       {
       # List of headers that are passed on
       }
     /virtualhosts
       {
       # List of URLs for this Web site
       }
     /sessionmanagement
       {
       # settings for user authentification
       }
     /renders
       {
       # List of AEM instances that render the documents
       }
     /filter
       {
       # List of filters
       }
     /vanity_urls
       {
       # List of vanity URLs
       }
     /cache
       {
       # Cache configuration
       /rules
         {
         # List of cachable documents
         }
       /invalidate
         {
         # List of auto-invalidated documents
         }
       }
     /statistics
       {
       /categories
         {
         # The document categories that are used for load balancing estimates
         }
       }
     /stickyConnectionsFor "/myFolder"
     /health_check
       {
       # Page gets contacted when an instance returns a 500
       }
     /retryDelay "1"
     /numberOfRetries "5"
     /unavailablePenalty "1"
     /failover "1"
     }
 }

Vous pouvez inclure d’autres fichiers qui contribuent à la configuration :

Par exemple, pour inclure le fichier myFarm.any dans la configuration de /farms, utilisez le code suivant :

/farms
  {
  $include "myFarm.any"
  }

Pour spécifier une plage de fichiers à inclure, utilisez l’astérisque (*) comme caractère générique.

Par exemple, si les fichiers allant de farm_1.any à farm_5.any contiennent la configuration des batteries 1 à 5, vous pouvez les inclure comme suit :

/farms
  {
  $include "farm_*.any"
  }

Utiliser les variables d’environnement using-environment-variables

Vous pouvez utiliser des variables d’environnement dans des propriétés à valeur de chaîne dans le fichier dispatcher.any au lieu de coder en dur les valeurs. Pour inclure la valeur d’une variable d’environnement, utilisez le format ${variable_name}.

Par exemple, si le fichier dispatcher.any se trouve dans le même répertoire que le répertoire de cache, la valeur de la propriété docroot suivante peut être utilisée :

/docroot "${PWD}/cache"

Autre exemple : si vous créez une variable d’environnement nommée PUBLISH_IP qui stocke le nom d’hôte de l’instance de publication AEM, la configuration de la propriété /renders suivante peut être utilisée :

/renders {
  /0001 {
    /hostname "${PUBLISH_IP}"
    /port "8443"
  }
}

Attribuer un nom à l’instance de Dispatcher naming-the-dispatcher-instance-name

Utilisez la propriété /name pour indiquer un nom unique permettant d’identifier votre instance de Dispatcher. La propriété /name est une propriété de niveau supérieur dans la structure de configuration.

Définir des batteries defining-farms-farms

La propriété /farms définit un ou plusieurs groupes de comportements de Dispatcher, chaque groupe étant associé à différents sites web ou URL. La propriété /farms peut inclure une ou plusieurs fermes de serveurs :

La propriété /farms est une propriété de niveau supérieur dans la structure de configuration. Pour définir une ferme de serveurs, ajoutez une propriété enfant à la propriété /farms. Utilisez un nom de propriété qui identifie la ferme de serveurs de manière unique dans l’instance de Dispatcher.

La propriété /farmname est composée de plusieurs valeurs et contient d’autres propriétés définissant le comportement de Dispatcher :

La valeur peut inclure n’importe quel caractère alphanumérique (a-z, 0-9). L’exemple suivant montre la définition du squelette pour deux fermes de serveurs appelées /daycom et /docsdaycom :

#name of dispatcher
/name "day sites"

#farms section defines a list of farms or sites
/farms
{
   /daycom
   {
       ...
   }
   /docdaycom
   {
      ...
   }
}

Chaque propriété /farm peut contenir les propriétés enfants suivantes :

Spécifier une page par défaut (IIS uniquement) - /homepage specify-a-default-page-iis-only-homepage

Spécifier les en-têtes HTTP à transférer specifying-the-http-headers-to-pass-through-clientheaders

La propriété /clientheaders définit une liste d’en-têtes HTTP que Dispatcher transfère de la demande HTTP client vers le rendu (instance AEM).

Par défaut, Dispatcher transmet les en-têtes HTTP standard à l’instance AEM. Dans certains cas, vous souhaiterez peut-être transférer des en-têtes supplémentaires ou supprimer des en-têtes spécifiques :

Si vous personnalisez le groupe d’en-têtes à transférer, vous devez définir une liste complète d’en-têtes, y compris ceux qui sont normalement inclus par défaut.

Par exemple, une instance de Dispatcher qui gère les demandes d’activation de pages pour les instances de publication nécessite l’en-tête PATH dans la section /clientheaders. L’en-tête PATH permet la communication entre l’agent de réplication et Dispatcher.

Le code suivant est un exemple de configuration pour /clientheaders :

/clientheaders
  {
  "CSRF-Token"
  "X-Forwarded-Proto"
  "referer"
  "user-agent"
  "authorization"
  "from"
  "content-type"
  "content-length"
  "accept-charset"
  "accept-encoding"
  "accept-language"
  "accept"
  "host"
  "max-forwards"
  "proxy-authorization"
  "proxy-connection"
  "range"
  "cookie"
  "cq-action"
  "cq-handle"
  "handle"
  "action"
  "cqstats"
  "depth"
  "translate"
  "expires"
  "date"
  "dav"
  "ms-author-via"
  "if"
  "lock-token"
  "x-expected-entity-length"
  "destination"
  "PATH"
  }

Identifier les hôtes virtuels identifying-virtual-hosts-virtualhosts

La propriété /virtualhosts définit une liste de toutes les combinaisons de nom d’hôte/URI que Dispatcher accepte pour cette batterie. Vous pouvez utiliser un astérisque (*) comme caractère générique. Les valeurs de la propriété /virtualhosts utilisent le format suivant :

[scheme]host[uri][*]

L’exemple de configuration suivant traite des requêtes pour les domaines .com et .ch de myCompany, ainsi que tous les domaines de mySubDivision :

   /virtualhosts
    {
    "www.myCompany.com"
    "www.myCompany.ch"
    "www.mySubDivison.*"
    }

La configuration suivante traite  toutes  les requêtes :

   /virtualhosts
    {
    "*"
    }

Résoudre l’hôte virtuel resolving-the-virtual-host

Lorsque Dispatcher reçoit une requête HTTP ou HTTPS, il trouve la valeur d’hôte virtuel qui correspond le mieux aux en-têtes host,, uri et scheme de la requête. Dispatcher évalue les valeurs dans les propriétés virtualhosts dans l’ordre suivant :

Dispatcher détecte la valeur d’hôte virtuel correspondant le mieux comme suit :

Par conséquent, vous devez définir l’hôte virtuel par défaut dans la partie supérieure de la propriété virtualhosts dans la batterie la plus élevée de votre fichier dispatcher.any.

Exemple de résolution du nom d’hôte virtuel example-virtual-host-resolution

L’exemple suivant représente un extrait de code provenant d’un fichier dispatcher.any qui définit deux batteries de Dispatcher et chaque batterie définit une propriété virtualhosts.

/farms
  {
  /myProducts
    {
    /virtualhosts
      {
      "www.mycompany.com/products/*"
      }
    /renders
      {
      /hostname "server1.myCompany.com"
      /port "80"
      }
    }
  /myCompany
    {
    /virtualhosts
      {
      "www.mycompany.com"
      }
    /renders
      {
      /hostname "server2.myCompany.com"
      /port "80"
      }
    }
  }

À l’aide de cet exemple, le tableau suivant montre les hôtes virtuels résolus pour les requêtes HTTP données :

Activer des sessions sécurisées - /sessionmanagement enabling-secure-sessions-sessionmanagement

Créez une session sécurisée pour l’accès à la batterie de rendus, de sorte que les utilisateurs et les utilisatrices doivent ouvrir une session pour accéder à n’importe quelle page de la batterie. Après avoir ouvert une session, les utilisateurs et utilisatrices peuvent accéder à toutes les pages de la batterie. Voir Création d’un groupe d’utilisateurs et d’utilisatrices fermé pour plus d’informations sur l’utilisation de cette fonctionnalité avec les groupes d’utilisateurs et d’utilisatrices fermés. Consultez également la Liste de contrôle de sécurité de Dispatcher avant la mise en ligne.

La propriété /sessionmanagement est une sous-propriété de /farms.

/sessionmanagement comporte plusieurs sous-paramètres :

/directory (obligatoire)

Répertoire qui stocke les informations de session. Si le répertoire n’existe pas, il est créé.

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  }

/encode (facultatif)

Mode de codage des informations de session. Utilisez md5 pour le chiffrement à l’aide de l’algorithme md5, ou hex pour un codage hexadécimal. Si vous chiffrez les données de session, un utilisateur ou une utilisatrice ayant accès au système de fichiers ne peut pas lire le contenu de la session. La valeur par défaut est md5.

/header (facultatif)

Nom de l’en-tête HTTP ou du cookie qui stocke les informations d’autorisation. Si vous stockez les informations dans l’en-tête http, utilisez HTTP:<header-name>. Pour stocker les informations dans un cookie, utilisez Cookie:<header-name>. Si vous n’indiquez pas de valeur, HTTP:authorization est utilisé.

/timeout (facultatif)

Nombre de secondes avant que la session ne s’arrête lorsqu’elle a été utilisée en dernier. Si la valeur n’est pas spécifiée, "800" est utilisé, de sorte que la session expire un peu plus de 13 minutes après la dernière requête de l’utilisateur ou l’utilisatrice.

Une configuration peut, par exemple, être structurée comme suit :

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  /encode "md5"
  /header "HTTP:authorization"
  /timeout "800"
  }

Définir des rendus de page defining-page-renderers-renders

La propriété /renders définit l’URL à laquelle Dispatcher envoie les demandes de rendu d’un document. La section d’exemple suivante /renders identifie une seule instance AEM pour le rendu :

/renders
  {
    /myRenderer
      {
      # hostname or IP of the renderer
      /hostname "aem.myCompany.com"
      # port of the renderer
      /port "4503"
      # connection timeout in milliseconds, "0" (default) waits indefinitely
      /timeout "0"
      }
  }

La section d’exemple suivante /renders identifie une instance AEM qui s’exécute sur le même ordinateur que Dispatcher :

/renders
  {
    /myRenderer
     {
     /hostname "127.0.0.1"
     /port "4503"
     }
  }

La section d’exemple suivante /renders répartit les demandes de rendu à égalité entre deux instances AEM :

/renders
  {
    /myFirstRenderer
      {
      /hostname "aem.myCompany.com"
      /port "4503"
      }
    /mySecondRenderer
      {
      /hostname "127.0.0.1"
      /port "4503"
      }
  }

Options de rendu renders-options

/timeout

Indique le délai de connexion (en millisecondes) pour accéder à l’instance AEM. La valeur par défaut est "0", ce qui amène Dispatcher à attendre indéfiniment.

/receiveTimeout

Indique la durée (en millisecondes) autorisée d’une réponse. La valeur par défaut est "600000", ce qui amène Dispatcher à attendre pendant 10 minutes. Un paramètre de "0" élimine le délai d’expiration.

Si le délai est atteint pendant l’analyse des en-têtes de réponse, un état HTTP 504 (passerelle erronée) est renvoyé. Si le délai d’expiration est atteint pendant la lecture du corps de la réponse, Dispatcher renvoie la réponse incomplète au client. Il supprime également tout fichier du cache qui peut avoir été écrit.

/ipv4

Indique si Dispatcher utilise la fonction getaddrinfo (pour IPv6) ou la fonction gethostbyname (pour IPv4) pour obtenir l’adresse IP du rendu. Une valeur de 0 provoque l’utilisation de getaddrinfo. Une valeur de 1 provoque l’utilisation de gethostbyname. La valeur par défaut est 0.

La fonction getaddrinfo renvoie une liste d’adresses IP. Dispatcher itère la liste des adresses jusqu’à établir une connexion TCP/IP. Par conséquent, la propriété ipv4 est importante lorsque le nom d’hôte du rendu est associé à plusieurs adresses IP. L’hôte, en réponse à la fonction getaddrinfo, renvoie une liste d’adresses IP toujours dans le même ordre. Dans ce cas, vous devez utiliser la fonction gethostbyname, de sorte que l’adresse IP à laquelle Dispatcher se connecte soit randomisée.

Amazon Elastic Load Balancing (ELB) est un service qui répond à getaddrinfo avec une liste d’adresses IP potentiellement dans le même ordre.

/secure

Si la propriété /secure a une valeur de "1", Dispatcher utilise HTTPS pour communiquer avec l’instance AEM. Pour plus de détails, voir aussi Configuration de Dispatcher pour l’utilisation de SSL.

/always-resolve

Avec la version 4.1.6 de Dispatcher, vous pouvez configurer la propriété /always-resolve comme suit :

En outre, cette propriété peut être utilisée si vous rencontrez des problèmes de résolution d’adresse IP dynamique, comme illustré dans l’exemple suivant :

/renders {
  /0001 {
     /hostname "host-name-here"
     /port "4502"
     /ipv4 "1"
     /always-resolve "1"
     }
  }

Configurer l’accès au contenu configuring-access-to-content-filter

Utilisez la section /filter pour définir les requêtes HTTP que Dispatcher accepte. Les autres demandes sont renvoyées au serveur web avec le code d’erreur 404 (page introuvable). Si aucune section /filter n’existe, toutes les demandes sont acceptées.

Remarque : les demandes pour le fichier stat sont toujours rejetées.

La section /filter se compose d’une série de règles qui refusent ou autorisent l’accès au contenu en fonction des modèles de la partie ligne de demande de la requête HTTP. Utilisez une stratégie de liste autorisée pour votre section /filter :

Définir un filtre defining-a-filter

Chaque élément de la section /filter comprend un type et un modèle associé à un élément spécifique de la ligne de requête ou à l’intégralité de la ligne de demande. Chaque filtre peut contenir les éléments suivants :

Partie de la ligne de demande des requêtes HTTP the-request-line-part-of-http-requests

HTTP/1.1 définit la ligne de demande comme suit :

Method Request-URI HTTP-Version<CRLF>

Les caractères <CRLF> représentent un retour chariot suivi d’un saut de ligne. L’exemple suivant est la ligne de demande reçue lorsqu’une personne demande la page en anglais américain du site WKND :

GET /content/wknd/us/en.html HTTP.1.1<CRLF>

Vos modèles doivent prendre en considération les caractères d’espace dans la ligne de demande ainsi que les caractères <CRLF>.

Guillemets doubles ou guillemets simples double-quotes-vs-single-quotes

Lors de la création de vos règles de filtrage, utilisez des guillemets doubles "pattern" pour les motifs simples. Si vous utilisez Dispatcher 4.2.0 ou version ultérieure et que votre motif inclut une expression régulière, vous devez placer l’expression régulière '(pattern1|pattern2)' entre des guillemets simples.

Expressions régulières regular-expressions

Après la version 4.2.0 de Dispatcher, vous pouvez inclure les expressions régulières POSIX étendues dans vos modèles de filtre.

Résoudre des problèmes de filtres troubleshooting-filters

Si vos filtres ne se déclenchent pas comme prévu, activez l’option Journalisation de trace sur Dispatcher pour déterminer le filtre qui intercepte la requête.

Exemple de filtre : Tout refuser example-filter-deny-all

L’exemple suivant de section de filtre amène Dispatcher à refuser les requêtes pour tous les fichiers. Refusez l’accès à tous les fichiers, puis autorisez l’accès à des zones spécifiques.

/0001  { /type "deny" /url "*"  }

Les requêtes concernant une zone explicitement refusée renvoient le code d’erreur 404 (page introuvable).

Exemple de filtre : Refuser l’accès à des zones spécifiques example-filter-deny-access-to-specific-areas

Les filtres permettent également de refuser l’accès à divers éléments, par exemple à des pages ASP et à des zones sensibles de l’instance de publication. Le filtre suivant refuse l’accès aux pages ASP :

/0002  { /type "deny" /url "*.asp"  }

Exemple de filtre : Activer les requêtes POST example-filter-enable-post-requests

L’exemple de filtre suivant permet d’envoyer des données de formulaire par la méthode POST :

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002 { /type "allow" /method "POST" /url "/content/[.]*.form.html" }
}

Exemple de filtre : Activer l’accès à la console de workflow example-filter-allow-access-to-the-workflow-console

L’exemple suivant illustre un filtre utilisé pour autoriser l’accès externe à la console de workflow :

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002  {  /type "allow"  /url "/libs/cq/workflow/content/console*"  }
}

Si votre instance de publication utilise un contexte d’application web (par exemple, publication), elle peut également être ajoutée à votre définition de filtre.

/0003   { /type "deny"  /url "/publish/libs/cq/workflow/content/console/archive*"  }

Si vous devez accéder à des pages uniques dans la zone restreinte, vous pouvez y autoriser l’accès. Par exemple, pour autoriser l’accès à l’onglet Archive dans la console de workflow, ajoutez la section suivante :

/0004  { /type "allow"  /url "/libs/cq/workflow/content/console/archive*"   }

Exemple de filtre : Utilisation d’expressions régulières example-filter-using-regular-expressions

Ce filtre permet des extensions dans des répertoires de contenu non publics à l’aide d’une expression régulière, définie ici entre guillemets simples :

/005  {  /type "allow" /extension '(css|gif|ico|js|png|swf|jpe?g)' }

Exemple de filtre : Filtrer des éléments supplémentaires d’une URL de demande example-filter-filter-additional-elements-of-a-request-url

Voici un exemple de règle qui bloque la récupération de contenu à partir du chemin /content et de sa sous-arborescence, en utilisant des filtres par chemin, sélecteurs et extensions :

/006 {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy|sysview|docview|query|jcr:content|_jcr_content|search|childrenlist|ext|assets|assetsearch|[0-9-]+)'
        /extension '(json|xml|html|feed))'
        }

Exemple de section /filter example-filter-section

Lors de la configuration de Dispatcher, vous devez restreindre l’accès externe autant que possible. L’exemple suivant offre un accès minimal aux visiteurs et visiteuses externes :

Une fois que vous avez créé des filtres, testez l’accès à la page pour vérifier que votre instance AEM est sécurisée.

La section /filter suivante du fichier dispatcher.any peut être utilisée comme base dans votre fichier de configuration Dispatcher.

Cet exemple se base sur le fichier de configuration par défaut fourni avec Dispatcher. C’est un exemple d’utilisation dans un environnement de production. Les éléments précédés de # sont désactivés (commentés). Faites preuve de prudence si vous décidez d’activer l’un de ces éléments (en supprimant le # sur cette ligne). Cela peut avoir un impact sur la sécurité.

Vous devez refuser l’accès à tous les éléments, puis accorder l’accès à des éléments spécifiques (limités) :

  /filter
      {
      # Deny everything first and then allow specific entries
      /0001  { /type "deny" /url "*"  }

      # Open consoles
#     /0011 { /type "allow" /url "/admin/*"  }  # allow servlet engine admin
#     /0012 { /type "allow" /url "/crx/*"    }  # allow content repository
#     /0013 { /type "allow" /url "/system/*" }  # allow OSGi console

      # Allow non-public content directories
#     /0021 { /type "allow" /url "/apps/*"   }  # allow apps access
#     /0022 { /type "allow" /url "/bin/*"    }
      /0023 { /type "allow" /url "/content*" }  # disable this rule to allow mapped content only

#     /0024 { /type "allow" /url "/libs/*"   }
#     /0025 { /type "deny"  /url "/libs/shindig/proxy*" } # if you enable /libs close access to proxy

#     /0026 { /type "allow" /url "/home/*"   }
#     /0027 { /type "allow" /url "/tmp/*"    }
#     /0028 { /type "allow" /url "/var/*"    }

      # Enable extensions in non-public content directories, using a regular expression
      /0041
        {
        /type "allow"
        /extension '(css|gif|ico|js|png|swf|jpe?g)'
        }

      # Enable features
      /0062 { /type "allow" /url "/libs/cq/personalization/*"  }  # enable personalization

      # Deny content grabbing, on all accessible pages, using regular expressions
      /0081
        {
        /type "deny"
        /selectors '((sys|doc)view|query|[0-9-]+)'
        /extension '(json|xml)'
        }
      # Deny content grabbing for /content and its subtree
      /0082
        {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy)'
        /extension '(json|xml|html)'
        }

#     /0087 { /type "allow" /method "GET" /extension 'json' "*.1.json" }  # allow one-level json requests
}

Tenez compte des recommandations suivantes si vous choisissez d’étendre l’accès :

En fonction de l’installation, il peut y avoir des ressources supplémentaires sous /libs, /apps ou ailleurs. Faites en sorte qu’elles soient disponibles. Vous pouvez utiliser le fichier access.log en tant que méthode permettant de déterminer les ressources accessibles en externe.

Restreindre des chaînes de requête restricting-query-strings

Depuis la version 4.1.5 de Dispatcher, utilisez la section /filter pour limiter les chaînes de requête. Il est fortement recommandé d’autoriser explicitement les chaînes de requête et d’exclure l’allocation générique par l’intermédiaire des éléments de filtre allow.

Une seule entrée peut avoir glob ou une combinaison de method, url, query, et version, mais pas les deux. L’exemple suivant autorise la chaîne de requête a=* et refuse toutes les autres chaînes de requête des URL qui se résolvent sur le nœud /etc :

/filter {
 /0001 { /type "deny" /method "POST" /url "/etc/*" }
 /0002 { /type "allow" /method "GET" /url "/etc/*" /query "a=*" }
}

/filter {
>/0001 { /type "deny" /method "*" /url "/path/*" }
>/0002 { /type "allow" /method "GET" /url "/path/*" }
>/0003 { /type "deny" /method "GET" /url "/path/*" /query "*" }
>/0004 { /type "allow" /method "GET" /url "/path/*" /query "a=*" }
}

Tester la sécurité de Dispatcher testing-dispatcher-security

Les filtres de Dispatcher doivent bloquer l’accès aux pages et scripts suivants sur les instances de publication AEM. Utilisez un navigateur web pour tenter d’ouvrir les pages suivantes en tant que visiteur ou visiteuse du site et vérifier qu’un code 404 est renvoyé. Si un autre résultat est obtenu, ajustez vos filtres.

Le rendu de page normal doit s’afficher pour /content/add_valid_page.html?debug=layout.

Pour déterminer si l’accès en écriture anonyme est activé, lancez la commande suivante dans un terminal ou une invite de commande. Vous ne devriez pas être en mesure d’écrire des données sur le nœud.

curl -X POST "https://anonymous:anonymous@hostname:port/content/usergenerated/mytestnode"

Pour tenter d’invalider le cache de Dispatcher et de vous assurer que vous recevez une réponse 403 du code, exécutez la commande suivante dans un terminal ou une invite de commande :

curl -H "CQ-Handle: /content" -H "CQ-Path: /content" https://yourhostname/dispatcher/invalidate.cache

Activer l’accès aux URL de redirection enabling-access-to-vanity-urls-vanity-urls

Configurez Dispatcher pour activer l’accès aux URL de redirection configurées pour vos pages AEM.

Lorsque l’accès aux URL de redirection est activé, Dispatcher appelle régulièrement un service qui s’exécute sur l’instance de rendu pour obtenir une liste des URL de redirection. Dispatcher stocke cette liste dans un fichier local. Lorsqu’une demande de page est refusée en raison d’un filtre de la section /filter, Dispatcher consulte la liste des URL de redirection vers un microsite. Si l’URL refusée se trouve dans la liste, Dispatcher autorise l’accès à l’URL de redirection vers un microsite.

Pour autoriser l’accès aux URL de redirection vers un microsite, ajoutez une section /vanity_urls à la section /farms, comme illustré dans l’exemple suivant :

 /vanity_urls {
      /url "/libs/granite/dispatcher/content/vanityUrls.html"
      /file "/tmp/vanity_urls"
      /delay 300
 }

La section /vanity_urls contient les propriétés suivantes :

Utilisez la procédure suivante pour autoriser l’accès aux URL de redirection.

Transfert des demandes de syndication - /propagateSyndPost forwarding-syndication-requests-propagatesyndpost

Les requêtes de syndication sont généralement prévues uniquement pour Dispatcher. Par défaut, elles ne sont donc pas envoyées au moteur de rendu (par exemple, une instance AEM).

Si nécessaire, définissez la propriété /propagateSyndPost sur « "1" » pour transférer les requêtes de syndication à Dispatcher. Si les requêtes POST sont définies, vous devez vous assurer qu’elles ne sont pas refusées dans la section filter.

Configurer le cache de Dispatcher - /cache configuring-the-dispatcher-cache-cache

La section /cache contrôle la manière dont Dispatcher met en cache les documents. Configurez plusieurs sous-propriétés pour implémenter vos stratégies de mise en cache :

Un exemple de section cache pourrait ressembler à ce qui suit :

/cache
  {
  /docroot "/opt/dispatcher/cache"
  /statfile  "/tmp/dispatcher-website.stat"
  /allowAuthorized "0"

  /rules
    {
    # List of files that are cached
    }

  /invalidate
    {
    # List of files that are auto-invalidated
    }
  }

Indication du répertoire du cache specifying-the-cache-directory

La propriété /docroot identifie le répertoire dans lequel les fichiers mis en cache sont stockés.

Si vous utilisez plusieurs batteries, chacune doit utiliser une racine de document différente.

Nommer le fichier stat naming-the-statfile

La propriété /statfile identifie le fichier à utiliser en tant que fichier stat. Dispatcher utilise ce fichier pour enregistrer l’heure de la mise à jour de contenu la plus récente. Le fichier stat peut être n’importe quel fichier sur le serveur web.

Le fichier stat n’a aucun contenu. Lorsque le contenu est mis à jour, Dispatcher met à jour la date et l’heure. Le fichier stat par défaut est nommé .stat et est stocké dans le docroot. Dispatcher bloque l’accès au fichier stat.

Distribuer des documents obsolètes lorsque des erreurs se produisent serving-stale-documents-when-errors-occur

La propriété /serveStaleOnError contrôle si Dispatcher renvoie des documents invalidés lorsque le serveur de rendu renvoie une erreur. Par défaut, lorsqu’un fichier stat est modifié et invalide un contenu mis en cache, Dispatcher supprime le contenu mis en cache la prochaine fois qu’il est demandé.

Si /serveStaleOnError est définit sur « "1" », Dispatcher ne supprime pas le contenu invalidé du cache à moins que le serveur de rendu ne renvoie une réponse réussie. Une réponse 5xx d’AEM ou une expiration du délai de connexion entraîne Dispatcher à diffuser du contenu obsolète et à répondre avec l’état HTTP 111 (Échec de la revalidation).

Mettre en cache lors de l’utilisation de l’authentification caching-when-authentication-is-used

La propriété /allowAuthorized contrôle si les requêtes contenant les informations d’authentification suivantes sont mises en cache :

Par défaut, les requêtes contenant ces informations d’authentification ne sont pas mises en cache, car l’authentification n’est pas effectuée lorsqu’un document mis en cache est renvoyé au client. Cette configuration empêche Dispatcher de diffuser des documents mis en cache aux utilisateurs et utilisatrices qui ne disposent pas des droits nécessaires.

Toutefois, si vos besoins permettent la mise en cache de documents authentifiés, définissez /allowAuthorized sur un :

/allowAuthorized "1"

Spécifier les documents à mettre en cache specifying-the-documents-to-cache

La propriété /rules contrôle les documents qui sont mis en cache selon le chemin d’accès au document. Quelle que soit la propriété /rules, Dispatcher ne procède jamais à la mise en cache d’un document dans les cas suivants :

Chaque élément de la propriété /rules inclut un motif glob et un type :

Si vous ne disposez pas de pages dynamiques (au-delà des pages déjà exclues par les règles ci-dessus), vous pouvez configurer Dispatcher pour tout mettre en cache. La section des règles se présente comme suit :

/rules
  {
    /0000  {  /glob "*"   /type "allow" }
  }

Pour plus d’informations sur les propriétés glob, voir Création de modèles pour les propriétés glob.

Si certaines sections de votre page sont dynamiques (une application d’actualités, par exemple) ou au sein d’un groupe d’utilisateurs et d’utilisatrices fermé, vous pouvez définir des exceptions :

/rules
  {
   /0000  { /glob "*" /type "allow" }
   /0001  { /glob "/en/news/*" /type "deny" }
   /0002  { /glob "*/private/*" /type "deny"  }
  }

Compression

Sur les serveurs web Apache, vous pouvez compresser les documents mis en cache. La compression permet à Apache de renvoyer le document sous forme compressée si cela est demandé par le client. La compression se fait automatiquement en activant le module Apache mod_deflate, par exemple :

AddOutputFilterByType DEFLATE text/plain

Le module est installé par défaut avec Apache 2.x.

Invalider des fichiers par niveau de dossier invalidating-files-by-folder-level

Utilisez la propriété /statfileslevel pour invalider une sélection de fichiers mis en cache en fonction de leur chemin d’accès :

Seules les ressources situées le long du chemin vers le fichier invalidé sont affectées. Prenons l’exemple suivant : un site web utilise la structure /content/myWebsite/xx/.. Si vous définissez statfileslevel sur 3, un fichier .stat est créé comme suit :

Lorsqu’un fichier dans /content/myWebsite/xx est invalidé, tous les fichiers .stat de docroot à /content/myWebsite/xx sont modifiés. Ce scénario s’applique uniquement pour /content/myWebsite/xx et non par exemple pour /content/myWebsite/yy ou /content/anotherWebSite.

Invalidation automatique des fichiers mis en cache automatically-invalidating-cached-files

La propriété /invalidate définit les documents qui sont automatiquement invalidés lorsque le contenu est mis à jour.

Avec l’invalidation automatique, Dispatcher ne supprime pas les fichiers mis en cache après une mise à jour du contenu, mais vérifie leur validité la prochaine fois qu’ils sont demandés. Les documents du cache qui ne sont pas invalidés automatiquement restent dans le cache jusqu’à ce qu’une mise à jour du contenu les supprime explicitement.

L’invalidation automatique est généralement utilisée pour les pages HTML. Les pages HTML contiennent souvent des liens vers d’autres pages, ce qui rend difficile de déterminer si une mise à jour du contenu affecte une page. Pour vous assurer que toutes les pages pertinentes sont invalidées lorsque le contenu est mis à jour, invalidez automatiquement toutes les pages HTML. La configuration suivante invalide toutes les pages HTML :

  /invalidate
  {
   /0000  { /glob "*" /type "deny" }
   /0001  { /glob "*.html" /type "allow" }
  }

Pour plus d’informations sur les propriétés glob, voir Création de modèles pour les propriétés glob.

Cette configuration provoque l’activité suivante lorsque /content/wknd/us/en est activé :

Si vous proposez des fichiers PDF et ZIP générés automatiquement au téléchargement, vous devrez peut-être également invalider automatiquement ces fichiers. Voici un exemple de configuration :

/invalidate
  {
   /0000 { /glob "*" /type "deny" }
   /0001 { /glob "*.html" /type "allow" }
   /0002 { /glob "*.zip" /type "allow" }
   /0003 { /glob "*.pdf" /type "allow" }
  }

L’intégration d’AEM à Adobe Analytics fournit des données de configuration dans un fichier analytics.sitecatalyst.js sur votre site web. Le fichier d’exemple dispatcher.any fourni avec Dispatcher comprend la règle d’invalidation suivante pour ce fichier :

{
   /glob "*/analytics.sitecatalyst.js"  /type "allow"
}

Utiliser des scripts d’invalidation personnalisés using-custom-invalidation-scripts

La propriété /invalidateHandler vous permet de définir un script appelé pour chaque requête d’invalidation reçue par Dispatcher.

Elle est appelée avec les arguments suivants :

Cette méthode peut être utilisée pour couvrir plusieurs cas d’utilisation différents. Par exemple, l’invalidation d’autres caches spécifiques à l’application, ou la gestion de cas où l’URL externalisée d’une page, ainsi que sa place dans le docroot, ne correspondent pas au chemin d’accès au contenu.

L’exemple de script ci-dessous consigne chaque requête d’invalidation à un fichier.

/invalidateHandler "/opt/dispatcher/scripts/invalidate.sh"

Exemple de script de gestionnaire d’invalidation sample-invalidation-handler-script

#!/bin/bash

printf "%-15s: %s %s" $1 $2 $3>> /opt/dispatcher/logs/invalidate.log

Limiter les clients qui peuvent vider le cache limiting-the-clients-that-can-flush-the-cache

La propriété /allowedClients définit les clients spécifiques autorisés à vider le cache. Les modèles d’extension métacaractère sont comparés à l’adresse IP.

L’exemple suivant :

/allowedClients
  {
   /0001 { /glob "*.*.*.*"  /type "deny" }
   /0002 { /glob "127.0.0.1" /type "allow" }
  }

Pour plus d’informations sur les propriétés glob, voir Création de modèles pour les propriétés glob.

Ignorer les paramètres d’URL ignoring-url-parameters

La section ignoreUrlParams définit les paramètres d’URL qui sont ignorés lorsque vous déterminez si une page est mise en cache ou exclue du cache :

Si un paramètre est ignoré pour une page, la page est mise en cache lorsqu’elle est demandée pour la première fois. Les requêtes suivantes sont diffusées à la page mise en cache, quelle que soit la valeur du paramètre dans la requête.

Pour spécifier les paramètres qui sont ignorés, ajoutez les règles glob à la propriété ignoreUrlParams :

Dans l’exemple suivant, Dispatcher ignore tous les paramètres, à l’exception du paramètre nocache. Par conséquent, les URL de requête qui incluent le paramètre nocache ne sont jamais mises en cache par Dispatcher :

/ignoreUrlParams
{
    # ignore-all-url-parameters-by-dispatcher-and-requests-are-cached
    /0001 { /glob "*" /type "allow" }
    # allow-the-url-parameter-nocache-to-bypass-dispatcher-on-every-request
    /0002 { /glob "nocache" /type "deny" }
}

Si l’on reprend l’exemple de configuration ignoreUrlParams ci-dessus, la requête HTTP suivante provoque la mise en cache de la page, car le paramètre willbecached est ignoré :

GET /mypage.html?willbecached=true

Si l’on reprend l’exemple de configuration ignoreUrlParams, la requête HTTP suivante ne provoque pas la mise en cache de la page, car le paramètre nocache n’est pas ignoré :

GET /mypage.html?nocache=true
GET /mypage.html?nocache=true&willbecached=true

Pour plus d’informations sur les propriétés glob, voir Création de modèles pour les propriétés glob.

Mettre en cache des en-têtes de réponse HTTP caching-http-response-headers

La propriété /headers permet de définir les types d’en-têtes HTTP qui vont être mis en cache par Dispatcher. Lors de la première requête à une ressource non mise en cache, tous les en-têtes correspondant à l’une des valeurs configurées (voir l’exemple de configuration ci-dessous) sont stockés dans un fichier séparé, à côté du fichier cache. Lors des requêtes ultérieures à la ressource mise en cache, les en-têtes stockés sont ajoutés à la réponse.

Voici ci-dessous un exemple de la configuration par défaut :

/cache {
  ...
  /headers {
    "Cache-Control"
    "Content-Disposition"
    "Content-Type"
    "Expires"
    "Last-Modified"
    "X-Content-Type-Options"
    "Last-Modified"
  }
}

FileETag none

Autorisations de fichier de cache de Dispatcher dispatcher-cache-file-permissions

La propriété mode définit les autorisations de fichier appliquées aux nouveaux répertoires et fichiers du cache. Ce paramètre est limité par le umask du processus appelant. Il s’agit d’un nombre octal construit à partir de la somme d’une ou de plusieurs des valeurs suivantes :

La valeur par défaut est 0755. Elle donne des autorisations en lecture, écriture et recherche à la personne propriétaire et des autorisations en lecture et en recherche au groupe et à d’autres personnes.

Limiter le fichier .stat touchant throttling-stat-file-touching

Si la propriété /invalidate est définie par défaut, chaque activation invalide effectivement tous les fichiers .html (si leur chemin correspond à la section /invalidate). Sur un site web avec un trafic considérable, de multiples activations ultérieures augmenteront la charge du processeur sur le serveur principal. Dans un tel scénario, il serait souhaitable de « limiter » le fichier .stat touchant pour que le site web reste réactif. Vous pouvez le faire en utilisant la propriété /gracePeriod.

La propriété /gracePeriod définit le nombre de secondes pendant lesquelles une ressource obsolète à invalidation automatique peut toujours être servie à partir du cache après la dernière activation. La propriété peut être utilisée dans une configuration où un lot d’activations invaliderait de manière répétée le cache entier. La valeur recommandée est de 2 secondes.

Pour plus de détails, vous pouvez aussi lire les sections /invalidate et /statfileslevel ci-dessus.

Configurer une invalidation temporelle du cache - /enableTTL configuring-time-based-cache-invalidation-enablettl

L’invalidation temporelle du cache dépend de la propriété /enableTTL et de la présence d’en-têtes d’expiration standard de la norme HTTP. Si vous définissez la propriété sur 1 (/enableTTL "1"), elle évalue les en-têtes de réponse du serveur principal. Si les en-têtes contiennent une date Cache-Control, max-age ou Expires, un fichier vide auxiliaire en regard du fichier mis en cache est créé, avec l’heure de modification égale à la date d’expiration. Lorsque le fichier mis en cache est demandé après l’heure de modification, il est automatiquement redemandé depuis le serveur principal.

Avant la version 4.3.5 de Dispatcher, la logique d’invalidation TTL ne reposait que sur la valeur TTL configurée. Avec Dispatcher 4.3.5, la TTL définie et les règles d’invalidation du cache de Dispatcher sont prises en compte. Par conséquent, pour un fichier mis en cache :

Cette nouvelle mise en œuvre prend en charge les cas d’utilisation où les fichiers ont une TTL plus longue (par exemple, sur le réseau CDN) mais peuvent toujours être invalidés même si la TTL n’a pas expiré. Elle privilégie l’actualisation du contenu par rapport au taux d’accès au cache sur Dispatcher.

À l’inverse, si seule la logique d’expiration doit être appliquée à un fichier, définissez alors /enableTTL sur 1 et excluez ce fichier du mécanisme d’invalidation du cache standard. Par exemple, vous pouvez effectuer les actions suivantes :

  /invalidate
  {
   /0000  { /glob "*" /type "deny" }
   /0001  { /glob "*.html" /type "allow" }
   /0002  { /glob "*.example.html" /type "deny" }
  }

Cela garantit que l’invalidation de fichier .stat n’est pas utilisée et que seule l’expiration TTL est active pour les fichiers spécifiés.

Configurer l’équilibrage de charge - /statistics configuring-load-balancing-statistics

La section /statistics définit les catégories de fichiers pour lesquelles Dispatcher note la réactivité de chaque rendu. Dispatcher utilise les scores pour déterminer sur quel rendu envoyer une requête.

Chaque catégorie que vous créez définit un motif glob. Dispatcher compare l’URI du contenu demandé à ces modèles afin de déterminer la catégorie du contenu demandé :

Dispatcher prend en charge huit catégories de statistiques au maximum. Si vous définissez plus de huit catégories, seules les 8 premières sont utilisées.

Sélection de rendu

Chaque fois que Dispatcher requiert une page rendue, il utilise l’algorithme suivant pour sélectionner le rendu :

Le score de la catégorie d’un rendu est basé sur les temps de réponse précédents, et sur les connexions précédentes ayant échoué et réussi tentées par Dispatcher. Pour chaque tentative, le score de la catégorie de l’URI demandé est mis à jour.

Définition des catégories de statistiques defining-statistics-categories

Définissez une catégorie pour chaque type de document pour lequel vous souhaitez conserver les statistiques de sélection du rendu. La section /statistics contient une section /categories. Pour définir une catégorie, ajoutez une ligne sous la section /categories au format suivant :

/name { /glob "pattern"}

La catégorie name doit être unique à la ferme de serveurs. pattern est décrit dans la section Conception de modèles pour les propriétés glob.

Pour déterminer la catégorie d’un URI, Dispatcher compare l’URI à chaque motif de catégorie jusqu’à ce qu’une correspondance soit trouvée. Dispatcher commence par la première catégorie de la liste et continue dans l’ordre. Par conséquent, placez d’abord les catégories avec des motifs plus spécifiques.

Par exemple, le fichier par défaut dispatcher.any de Dispatcher définit une catégorie HTML et une catégorie Autres. La catégorie HTML est plus précise et, de ce fait, elle s’affiche en premier :

/statistics
  {
  /categories
    {
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

L’exemple suivant comprend également une catégorie pour les pages de recherche :

/statistics
  {
  /categories
    {
      /search { /glob "*search.html" }
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

Impact de l’indisponibilité du serveur sur les statistiques de Dispatcher reflecting-server-unavailability-in-dispatcher-statistics

La propriété /unavailablePenalty définit la durée (en dixième de seconde) qui est appliquée aux statistiques de rendu lorsqu’une connexion au rendu échoue. Dispatcher ajoute la durée à la catégorie de statistiques correspondant à l’URI demandé.

Par exemple, la pénalité est appliquée lorsque la connexion TCP/IP au nom d’hôte/port indiqué ne peut pas être établie car AEM ne fonctionne pas (et ne lit pas) ou en raison d’un problème lié au réseau.

La propriété /unavailablePenalty est un enfant direct de la section /farm (également enfant de la section /statistics).

Si aucune propriété /unavailablePenalty n’existe, la valeur "1" est utilisée.

/unavailablePenalty "1"

Identifier un dossier de connexions persistantes - /stickyConnectionsFor identifying-a-sticky-connection-folder-stickyconnectionsfor

La propriété /stickyConnectionsFor définit un dossier contenant des documents persistants. Cette propriété est accessible à l’aide de l’URL. Dispatcher envoie toutes les requêtes, d’un utilisateur ou d’une utilisatrice unique qui se trouve dans ce dossier, à la même instance de rendu. Les connexions persistantes garantissent que les données de session sont présentes et cohérentes pour tous les documents. Ce mécanisme utilise le cookie renderid.

L’exemple suivant définit une connexion persistante au dossier /products :

/stickyConnectionsFor "/products"

Lorsqu’une page est constituée de contenu provenant de plusieurs nœuds de contenu, incluez la propriété /paths répertoriant les chemins d’accès au contenu. Par exemple, une page contient du contenu provenant de /content/image, /content/video et /var/files/pdfs. La configuration suivante active les connexions persistantes pour tout le contenu de la page :

/stickyConnections {
  /paths {
    "/content/image"
    "/content/video"
    "/var/files/pdfs"
  }
}

httpOnly httponly

Lorsque les connexions persistantes sont activées, le module de Dispatcher définit le cookie renderid. Ce cookie n’est pas doté de l’indicateur httponly, qui doit être ajouté pour renforcer la sécurité. Pour ajouter l’indicateur httponly, définissez la propriété httpOnly dans le nœud /stickyConnections d’un fichier de configuration dispatcher.any. La valeur de la propriété (0 ou 1) définit si le cookie renderid se fait adjoindre l’attribut HttpOnly. La valeur par défaut est 0, ce qui signifie que l’attribut n’est pas ajouté.

Pour plus d’informations sur l’indicateur httponly, consultez cette page.

secure secure

Lorsque les connexions persistantes sont activées, le module de Dispatcher définit le cookie renderid. Ce cookie n’est pas doté de l’indicateur secure, qui doit être ajouté pour renforcer la sécurité. Pour ajouter l’indicateur secure, définissez la propriété secure dans le nœud /stickyConnections d’un fichier de configuration dispatcher.any. La valeur de la propriété (0 ou 1) définit si le cookie renderid se fait adjoindre l’attribut secure. La valeur par défaut est 0, ce qui signifie que l’attribut est ajouté si la requête entrante est sécurisée. Si la valeur est définie sur 1, l’indicateur sécurisé sera ajouté, que la requête entrante soit sécurisée ou non.

Gérer les erreurs de connexion au serveur de rendu handling-render-connection-errors

Configurez le comportement de Dispatcher lorsque le serveur de rendu renvoie une erreur 500 ou n’est pas disponible.

Définir une page de contrôle de l’intégrité specifying-a-health-check-page

Utilisez la propriété /health_check pour indiquer une URL qui est vérifiée lorsque le code d’état 500 se produit. Si cette page renvoie également le code d’état 500, l’instance est considérée comme non disponible et une pénalité de temps configurable (/unavailablePenalty) est appliquée au rendu avant de réessayer.

/health_check
  {
  # Page gets contacted when an instance returns a 500
  /url "/health_check.html"
  }

Définir le délai entre deux tentatives de connexion à une page specifying-the-page-retry-delay

La propriété /retryDelay définit le délai (en secondes) pendant lequel Dispatcher attend entre les séries de tentatives de connexion aux rendus de la batterie. Pour chaque série, le nombre maximal de tentatives de connexion de Dispatcher à un rendu est le nombre de rendus de la ferme de serveurs.

Dispatcher utilise la valeur "1" si la propriété /retryDelay n’est pas explicitement définie. La valeur par défaut est généralement correcte.

/retryDelay "1"

Configurer le nombre de reprises configuring-the-number-of-retries

La propriété /numberOfRetries définit le nombre maximal de séries de tentatives de connexion que Dispatcher exécute avec les rendus. Si Dispatcher ne parvient pas à se connecter à un rendu après ce nombre de reprises, il renvoie une réponse en échec.

Pour chaque série, le nombre maximal de tentatives de connexion de Dispatcher à un rendu est le nombre de rendus de la ferme de serveurs. Par conséquent, le nombre maximal de fois que Dispatcher tente une connexion est (/numberOfRetries) x (nombre de rendus).

Si la valeur n’est pas explicitement définie, la valeur par défaut est 5.

/numberOfRetries "5"

Utiliser le mécanisme de basculement using-the-failover-mechanism

Pour renvoyer des requêtes à d’autres rendus lorsque la requête d’origine échoue, activez le mécanisme de basculement sur votre batterie Dispatcher. Lorsque le basculement est activé, Dispatcher se comporte comme suit :

Pour activer le basculement, ajoutez la ligne suivante à la ferme de serveurs (ou au site web) :

/failover "1"

Ignorer les erreurs d’interruption - /ignoreEINTR ignoring-interruption-errors-ignoreeintr

Tout appel à un système orienté fichiers peut être interrompu EINTR si l’objet de l’appel au système se trouve sur un système distant accessible au moyen de NFS. Ces appels système peuvent expirer ou être interrompus en fonction de la manière dont le système de fichiers sous-jacent a été monté sur l’ordinateur local.

Utilisez le paramètre /ignoreEINTR si votre instance comporte une configuration de ce type et que le journal contient le message suivant :

Error while reading response: Interrupted system call

En interne, Dispatcher lit la réponse depuis le serveur distant (à savoir, AEM) en utilisant une boucle qui peut être représentée ainsi :

while (response not finished) {
read more data
}

De tels messages peuvent être générés lorsque l’erreur EINTR se produit dans la section « read more data » et sont provoqués par la réception d’un signal avant que des données n’aient été reçues.

Pour ignorer ces interruptions, ajoutez le paramètre suivant au dispatcher.any (avant /farms) :

/ignoreEINTR "1"

La définition du paramètre /ignoreEINTR sur "1" fait en sorte que Dispatcher continue d’essayer de lire des données jusqu’à la lecture de la réponse complète. La valeur par défaut est 0 et désactive l’option.

Créer des motifs pour les propriétés glob designing-patterns-for-glob-properties

Plusieurs sections du fichier de configuration de Dispatcher utilisent les propriétés glob comme critères de sélection des requêtes du client. Les valeurs des propriétés glob sont des motifs que Dispatcher compare à un aspect de la requête, par exemple au chemin d’accès à la ressource demandée ou à l’adresse IP du client. Par exemple, les éléments de la section /filter utilisent les motifs glob pour identifier les chemins d’accès des pages que Dispatcher traite ou rejette.

Les valeurs glob peuvent inclure des caractères génériques et des caractères alphanumériques pour définir le motif.

Journalisation logging

Dans la configuration du serveur web, vous pouvez définir :

Reportez-vous à la documentation du serveur web et au fichier lisez-moi de l’instance de Dispatcher pour plus d’informations.

Journaux pivotés/redirigés d’Apache

Si vous utilisez un serveur web Apache, vous pouvez utiliser la fonctionnalité standard pour les journaux pivotés, les journaux transmis, ou les deux. Par exemple, avec les journaux transmis :

DispatcherLog "| /usr/apache/bin/rotatelogs logs/dispatcher.log%Y%m%d 604800"

Cette fonctionnalité pivote automatiquement :

Consultez la documentation du serveur web Apache sur la rotation des journaux et les journaux transmis. Par exemple : Apache 2.4.

Journalisation de trace trace-logging

Entre autres améliorations de Dispatcher, la version 4.2.0 introduit également la journalisation de trace.

Cette fonctionnalité est un niveau supérieur à la journalisation de débogage qui affiche des informations supplémentaires dans les journaux. Elle ajoute la journalisation des informations suivantes :

Vous pouvez activer la journalisation de trace en définissant le niveau de journalisation sur 4 dans le serveur web.

Vous trouverez ci-dessous des exemples de journaux avec la trace activée :

[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Host] = "localhost:8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[User-Agent] = "curl/7.43.0"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Accept] = "*/*"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Client-Cert] = "(null)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Via] = "1.1 localhost:8443 (dispatcher)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-For] = "::1"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL] = "on"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Cipher] = "DHE-RSA-AES256-SHA"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Session-ID] = "ba931f5e4925c2dde572d766fdd436375e15a0fd24577b91f4a4d51232a934ae"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-Port] = "8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Server-Agent] = "Communique-Dispatcher"

Et un événement consigné lorsqu’un fichier qui correspond à une règle de blocage est demandé :

[Thu Mar 03 14:42:45 2016] [T] [11831] 'GET /content.infinity.json HTTP/1.1' was blocked because of /0082

Confirmation du fonctionnement de base confirming-basic-operation

Pour confirmer le fonctionnement de base et l’interaction du serveur web, de Dispatcher et de l’instance AEM, procédez comme suit :

Utiliser plusieurs instances de Dispatcher using-multiple-dispatchers

Dans des configurations complexes, vous pouvez utiliser plusieurs instances de Dispatcher. Par exemple, vous pouvez utiliser :

Dans ce cas, veillez à ce que chaque requête ne passe que par une seule instance de Dispatcher. Une instance de Dispatcher ne gère pas les requêtes provenant d’une autre instance. Par conséquent, assurez-vous que les deux instances de Dispatcher accèdent directement au site web d’AEM.

Débogage debugging

Lorsque vous ajoutez un en-tête X-Dispatcher-Info à une requête, Dispatcher indique si la cible a été mise en cache, renvoyée de la mise en cache ou si elle ne pouvait absolument pas faire l’objet d’une mise en cache. L’en-tête de la réponse X-Cache-Info contient ces informations sous une forme lisible. Vous pouvez utiliser ces en-têtes de réponse pour déboguer des problèmes impliquant des réponses mises en cache par Dispatcher.

Cette fonctionnalité n’est pas activée par défaut. Par conséquent, pour que l’en-tête de réponse X-Cache-Info soit inclus, la batterie doit contenir l’entrée suivante :

/info "1"

Par exemple,

/farm
{
    /mywebsite
    {
        # Include X-Cache-Info response header if X-Dispatcher-Info is in request header
        /info "1"
    }
}

De plus, l’en-tête X-Dispatcher-Info n’a pas besoin de valeur, mais si vous utilisez curl pour le test, vous devrez fournir une valeur à envoyer à l’en-tête, par exemple :

curl -v -H "X-Dispatcher-Info: true" https://localhost/content/wknd/us/en.html

Vous trouverez ci-dessous une liste contenant les en-têtes de réponse que X-Dispatcher-Info renvoie :