DocumentaçãoAEMGuia do Dispatcher

Visão geral do Dispatcher dispatcher-overview

Last update: Sat May 20 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Admin
NOTE
As versões do Dispatcher são independentes do AEM. Você pode ter sido redirecionado para esta página se tiver seguido um link para a documentação do Dispatcher incorporada à documentação de uma versão anterior do AEM.

O Dispatcher é a ferramenta de armazenamento em cache e balanceamento de carga do Adobe Experience Manager, e ele é usado em conjunto com um servidor da web de classe empresarial.

O processo de implantação do Dispatcher é independente do servidor da web e da plataforma de SO escolhida:

  1. Saiba mais sobre o Dispatcher (nesta página). Além disso, consulte as perguntas frequentes sobre o Dispatcher.
  2. Instale um servidor Web compatível de acordo com a documentação do servidor Web.
  3. Instale o módulo Dispatcher em seu servidor Web e configure o servidor Web apropriadamente.
  4. Configurar o Dispatcher (qualquer arquivo no dispatcher).
  5. Configure o AEM para que atualizações de conteúdo invalidem o cache.
NOTE
Para entender melhor como o Dispatcher funciona com o AEM:

Use as seguintes informações conforme necessário:

NOTE
O uso mais comum do Dispatcher é armazenar em cache as respostas de uma instância de publicação do AEM, para aumentar a capacidade de resposta e a segurança de seu site publicado voltado para o exterior. A maior parte da discussão se concentra nesse caso.
Mas o Dispatcher também pode ser usado para aumentar a capacidade de resposta da instância do seu autor, principalmente se você tiver um grande número de usuários editando e atualizando seu site. Para obter detalhes específicos deste caso, consulte Uso de um Dispatcher com um servidor de autor, abaixo.

Por que usar o Dispatcher para implementar o armazenamento em cache? why-use-dispatcher-to-implement-caching

Há duas abordagens básicas para publicação na web:

  • Servidores web estáticos: como o Apache ou IIS; eles são simples, porém rápidos.
  • Servidores: que fornecem conteúdo dinâmico, em tempo real e inteligente, mas exigem muito mais tempo de computação e outros recursos.

O Dispatcher ajuda a realizar um ambiente rápido e dinâmico. Funciona como parte de um servidor HTML estático, como o Apache, com o objetivo de:

  • armazenar (ou "armazenar em cache") o máximo possível do conteúdo do site, na forma de um site estático
  • acesso ao mecanismo de layout o mínimo possível

O que significa que:

  • o conteúdo estático é manipulado com a mesma velocidade e facilidade de um servidor web estático. Além disso, você pode usar as ferramentas de administração e segurança disponíveis para seus servidores web estáticos.

  • o conteúdo dinâmico é gerado conforme necessário, sem retardar o sistema além do absolutamente necessário.

O Dispatcher contém mecanismos para gerar e atualizar HTML estático com base no conteúdo do site dinâmico. Você pode especificar em detalhes quais documentos são armazenados como arquivos estáticos e quais são sempre gerados dinamicamente.

Esta seção ilustra os princípios por trás desse processo.

Servidor Web estático static-web-server

Um servidor web estático, como o Apache ou o IIS, serve arquivos HTML estáticos para os visitantes do seu site. As páginas estáticas são criadas uma vez, então o mesmo conteúdo é entregue para cada solicitação.

Esse processo é simples e eficiente. Se um visitante solicitar um arquivo, como uma página HTML, o arquivo será obtido diretamente da memória; na pior das hipóteses, ele será lido da unidade local. Os servidores web estáticos já estão disponíveis há bastante tempo, então há uma grande variedade de ferramentas para administração e gerenciamento de segurança e elas estão muito bem integradas às infraestruturas de rede.

Servidores de gerenciamento de conteúdo content-management-servers

Se você usar um CMS (servidor de gerenciamento de conteúdo), como o AEM, um mecanismo de layout avançado processará a solicitação de um visitante. O mecanismo lê o conteúdo de um repositório que, combinado com estilos, formatos e direitos de acesso, transforma o conteúdo em um documento adaptado às necessidades e direitos do visitante.

Esse fluxo de trabalho permite que você crie um conteúdo mais rico e dinâmico, o que aumenta a flexibilidade e funcionalidade do site. No entanto, o mecanismo de layout requer mais potência do que um servidor estático, portanto, essa configuração pode ser sujeita a lentidão se muitos visitantes usarem o sistema.

Como o Dispatcher executa o armazenamento em cache how-dispatcher-performs-caching

O diretório de cache para armazenamento em cache, o módulo Dispatcher, usa a capacidade do servidor Web de fornecer conteúdo estático. O Dispatcher coloca os documentos em cache na raiz do documento do servidor web.

NOTE
Quando falta a configuração para o HTTP Header Caching, o Dispatcher armazena apenas o código HTML da página - não armazena os cabeçalhos HTTP. Esse cenário pode ser um problema se você usar diferentes codificações no site, pois elas podem se perder. Para habilitar o armazenamento de cabeçalhos HTTP em cache, consulte Configuração do cache do Dispatcher.
NOTE
Localizar o documento-raiz do seu servidor web no armazenamento anexo à rede (NAS) causa degradação de desempenho. Além disso, quando um documento-raiz no NAS é compartilhado entre vários servidores web, podem ocorrer bloqueios intermitentes quando ações de replicação são realizadas.
NOTE
O Dispatcher armazena o documento em cache em uma estrutura igual ao URL solicitado.
Poderão haver limitações no nível do sistema operacional com relação ao comprimento do nome do arquivo. Isso é, se você tiver um URL com vários seletores.

Métodos de cache

O Dispatcher tem dois métodos primários para atualizar o conteúdo em cache quando mudanças são feitas no site.

  • As atualizações de conteúdo removem as páginas que foram alteradas e os arquivos que estão diretamente associados a elas.
  • A invalidação automática invalida automaticamente as partes do cache que podem estar desatualizadas após uma atualização. Ou seja, ela sinaliza as páginas relevantes como desatualizadas, sem excluir nada.

Atualizações de conteúdo

Em uma atualização de conteúdo, um ou mais documentos do AEM são alterados. O AEM envia uma solicitação de agregação para o Dispatcher, que atualiza o cache de acordo:

  1. Ele exclui os arquivos modificados do cache.
  2. Ele exclui do cache todos os arquivos que iniciam com o mesmo identificador. Por exemplo, se o arquivo /en/index.html for atualizado, todos os arquivos que começam com /en/index. são excluídos. Esse mecanismo permite criar sites que utilizam o cache de maneira eficiente, especialmente com relação à navegação de imagens.
  3. Ele toca o chamado arquivo de status, o que atualiza o carimbo de data e hora do arquivo de status para indicar a data da última alteração.

É de salientar os seguintes pontos:

  • As atualizações de conteúdo geralmente são usadas em conjunto com um sistema de criação que “sabe” o que deve ser substituído.
  • Os arquivos afetados por uma atualização de conteúdo são removidos, mas não são substituídos imediatamente. Na próxima vez que um arquivo for solicitado, o Dispatcher buscará o novo arquivo na instância do AEM e o colocará no cache, substituindo o conteúdo antigo.
  • Normalmente, as imagens geradas automaticamente que incorporam texto de uma página são armazenadas em arquivos de imagem que começam com o mesmo identificador - garantindo assim que a associação exista para exclusão. Por exemplo, você pode armazenar o texto do título da página mypage.html como a imagem mypage.titlePicture.gif na mesma pasta. Desta forma, a imagem é automaticamente eliminada do cache sempre que a página é atualizada, para que possa ter a certeza de que a imagem reflete sempre a versão atual da página.
  • Você pode ter vários arquivos de status, por exemplo, um por pasta de idioma. Se uma página for atualizada, o AEM procurará a próxima pasta pai que contém um arquivo de status e tocará esse arquivo.

Invalidação automática

A invalidação automática invalida automaticamente partes do cache - sem excluir fisicamente quaisquer arquivos. Em cada atualização de conteúdo, o chamado arquivo de status é tocado, portanto, seu carimbo de data e hora reflete a última atualização de conteúdo.

O Dispatcher tem uma lista de arquivos que estão sujeitos à invalidação automática. Quando um documento dessa lista é solicitado, o Dispatcher compara a data do documento em cache com o carimbo de data e hora do arquivo de status:

  • se o documento em cache for mais recente, o Dispatcher o retornará.
  • se for mais antigo, o Dispatcher recuperará a versão atual da instância do AEM.

Mais uma vez, é de salientar alguns pontos:

  • Normalmente, a invalidação automática é usada quando as inter-relações são complexas, como páginas HTML. Essas páginas contêm links e entradas de navegação, portanto, elas geralmente precisam ser atualizadas após uma atualização de conteúdo. Se você tem arquivos de PDF ou imagem que são gerados automaticamente, pode escolher invalidá-los automaticamente também.
  • A invalidação automática não envolve nenhuma ação do Dispatcher no momento da atualização, exceto ao tocar no arquivo de status. Entretanto, tocar no arquivo de status torna automaticamente o conteúdo do cache obsoleto, sem removê-lo fisicamente do cache.

Como o Dispatcher retorna documentos how-dispatcher-returns-documents

Determinar se um documento está sujeito ao armazenamento em cache

Você pode definir quais documentos o Dispatcher armazena em cache no arquivo de configuração. O Dispatcher verifica a solicitação em relação à lista de documentos que podem ser armazenados em cache. Se o documento não estiver nessa lista, o Dispatcher solicitará o documento da instância do AEM.

O Dispatcher sempre solicita o documento diretamente da instância do AEM nos seguintes casos:

  • Se o URI da solicitação contiver um ponto de interrogação “?”. Esse cenário geralmente indica uma página dinâmica, como um resultado de pesquisa, que não precisa ser armazenada em cache.
  • A extensão do arquivo está ausente. O servidor web precisa da extensão para determinar o tipo de documento (o tipo MIME).
  • O cabeçalho de autenticação está definido (configurável).
NOTE
Os métodos GET ou HEAD (para o cabeçalho HTTP) podem ser armazenados em cache pelo Dispatcher. Para obter informações adicionais sobre o armazenamento em cache do cabeçalho de resposta, consulte a seção Armazenamento em cache de cabeçalhos de resposta HTTP.

Determinar se um documento está em cache

O Dispatcher armazena os arquivos em cache no servidor Web como se fossem parte de um site estático. Se um usuário solicitar um documento armazenável em cache, o Dispatcher verificará se esse documento existe no sistema de arquivos do servidor web:

  • se o documento estiver em cache, o Dispatcher retornará o arquivo.
  • se não estiver em cache, o Dispatcher solicitará o documento da instância do AEM.

Como determinar se um documento está atualizado

Para descobrir se um documento está atualizado, o Dispatcher executa duas etapas:

  1. Verifica se o documento está sujeito a invalidação automática. Caso contrário, o documento será considerado atualizado.
  2. Se o documento estiver configurado para invalidação automática, o Dispatcher verificará se ele é mais antigo ou mais recente do que a última alteração disponível. Se for mais antigo, o Dispatcher solicitará a versão atual da instância do AEM e substituirá a versão no cache.
NOTE
Documentos sem invalidação automática permanecem no cache até serem fisicamente excluídos. Por exemplo, por uma atualização de conteúdo no site.

Os benefícios do balanceamento de carga the-benefits-of-load-balancing

Balanceamento de carga é a prática de distribuir a carga computacional do site em várias instâncias do AEM.

Você ganha:

  • maior poder de processamento
    Na prática, isso significa que o Dispatcher compartilha solicitações de documento entre várias instâncias do AEM. Como cada instância agora tem menos documentos para processar, você tem tempos de resposta mais rápidos. O Dispatcher mantém estatísticas internas para cada categoria de documento, de modo que ele possa estimar o carregamento e distribuir as consultas com eficiência.

  • maior cobertura à prova de falhas
    Se o Dispatcher não receber respostas de uma instância, ele transmitirá automaticamente as solicitações para uma das outras instâncias. Se uma instância se tornar indisponível, o único efeito será uma lentidão no site, proporcional à potência computacional perdida. No entanto, todos os serviços continuarão funcionando.

  • Você também pode gerenciar sites diferentes no mesmo servidor web estático.

NOTE
Enquanto o balanceamento de carga espalha a carga com eficiência, o cache ajuda a reduzir a carga. Portanto, tente otimizar o cache e reduzir a carga geral antes de configurar o balanceamento de carga. Um bom cache pode aumentar o desempenho do balanceador de carga ou tornar desnecessário o balanceamento de carga.
CAUTION
Embora um único Dispatcher possa saturar a capacidade das instâncias de publicação disponíveis, no caso de alguns aplicativos raros, pode fazer sentido balancear adicionalmente a carga entre duas instâncias do Dispatcher. As configurações com vários Dispatchers devem ser cuidadosamente consideradas, já que um Dispatcher adicional aumentará a carga nas instâncias de publicação disponíveis e poderá facilmente diminuir o desempenho na maioria dos aplicativos.

Como o Dispatcher executa o balanceamento de carga how-the-dispatcher-performs-load-balancing

Estatísticas de desempenho

O Dispatcher mantém estatísticas internas sobre a velocidade com que cada instância do AEM processa documentos. Com base nesses dados, o Dispatcher estima qual instância fornecerá o tempo de resposta mais rápido ao responder uma solicitação e, portanto, reserva o tempo de cálculo necessário para essa instância.

Tipos diferentes de solicitações podem ter tempos médios diferentes de conclusão. Por esse motivo, o Dispatcher permite que você especifique categorias de documento. Essas categorias são consideradas ao calcular as estimativas de tempo. Por exemplo, é possível fazer uma distinção entre páginas HTML e imagens, já que seus tempos de resposta típicos podem ser diferentes.

Se você usar uma função de pesquisa elaborada, poderá criar uma categoria para consultas de pesquisa. Esse método ajuda o Dispatcher a enviar consultas de pesquisa para a instância que responde mais rapidamente. Isso também ajuda a impedir que uma instância mais lenta seja paralisada ao receber várias consultas de pesquisa avançadas, enquanto as outras recebem as solicitações mais simples.

Conteúdo personalizado (conexões adesivas)

As conexões adesivas garantem que os documentos de um usuário sejam todos compostos na mesma instância do AEM. Esse ponto é importante se você usar páginas personalizadas e dados de sessão. Os dados são armazenados na instância, portanto as solicitações subsequentes do mesmo usuário devem retornar a essa instância ou os dados são perdidos.

Como as conexões aderentes restringem a capacidade do Dispatcher de otimizar as solicitações, você deve usá-las somente quando necessário. Você pode especificar a pasta que contém os documentos "fixos", garantindo que todos os documentos dessa pasta sejam compostos na mesma instância para cada usuário.

NOTE
Para a maioria das páginas que usam conexões adesivas, é necessário desligar o cache; caso contrário, a página será a mesma para todos os usuários, independentemente do conteúdo da sessão.
Para algumas aplicações, pode ser possível utilizar ligações aderentes e armazenamento em cache; por exemplo, se você exibir um formulário que grava dados na sessão.

Uso de vários Dispatchers using-multiple-dispatchers

Em configurações complexas, você pode usar vários Dispatchers. Por exemplo, você pode usar:

  • um Dispatcher para publicar um site na Intranet
  • um segundo Dispatcher, em um endereço diferente e com configurações de segurança diferentes, para publicar o mesmo conteúdo na Internet.

Nesse caso, verifique se cada solicitação passa por apenas um Dispatcher. Um Dispatcher não lida com solicitações provenientes de outro Dispatcher. Portanto, verifique se ambos os Dispatchers acessam o site do AEM diretamente.

Uso do Dispatcher com um CDN using-dispatcher-with-a-cdn

Uma rede de entrega de conteúdo (CDN), como Akamai Edge Delivery ou Amazon Cloud Front, fornece conteúdo de um local próximo ao usuário final. Assim,

  • acelera os tempos de resposta para usuários finais
  • e carrega seus servidores

Como um componente de infraestrutura HTTP, uma CDN funciona de maneira semelhante ao Dispatcher: quando um nó da CDN recebe uma solicitação, ele serve a solicitação de seu cache, se possível (se o recurso está disponível no cache e é válido). Caso contrário, ele chegará ao próximo servidor mais próximo para recuperar o recurso e armazená-lo em cache para outras solicitações, se apropriado.

O "próximo servidor mais próximo" depende de sua configuração específica. Por exemplo, em uma configuração do Akamai, a solicitação pode seguir o seguinte caminho:

  • O nó Akamai Edge
  • A Camada Akamai Midgres
  • Seu firewall
  • Seu balanceador de carga
  • Dispatcher
  • AEM

Geralmente, o Dispatcher é o próximo servidor que pode servir o documento de um cache e influenciar os cabeçalhos de resposta retornados ao servidor da CDN.

Controle de um cache CDN controlling-a-cdn-cache

Há várias maneiras de controlar por quanto tempo uma CDN armazena em cache um recurso antes de buscá-lo novamente no Dispatcher.

  1. Configuração explícita
    Configure por quanto tempo recursos específicos são mantidos no cache da CDN, dependendo do tipo MIME, extensão, tipo de solicitação etc.

  2. Cabeçalhos de expiração e controle de cache
    A maioria das CDNs respeitará os cabeçalhos HTTP Expires: e Cache-Control: se forem enviados pelo servidor upstream. Isso pode ser feito, por exemplo, usando o módulo mod_expires do Apache.

  3. Invalidação manual
    As CDNs permitem que os recursos sejam removidos do cache por meio de interfaces da Web.

  4. Invalidação baseada em API
    A maioria das CDNs também oferece uma API REST e/ou SOAP que permite a remoção de recursos do cache.

Em uma configuração típica do AEM, as configurações por extensão, caminho ou ambas, que podem ser alcançadas através dos itens 1 e 2 acima, oferecem possibilidades de definir períodos razoáveis de armazenamento em cache para recursos frequentemente usados que não são alterados com frequência, como imagens de design e bibliotecas de clientes. Quando novas versões são implantadas, geralmente é necessária uma invalidação manual.

Se essa abordagem for usada para armazenar em cache conteúdo gerenciado, isso implica que as alterações de conteúdo só estarão visíveis para os usuários finais depois que o período de cache configurado expirar e o documento for buscado do Dispatcher novamente.

Para obter um controle mais preciso, a invalidação com base em API permite invalidar o cache de uma CDN quando o cache do Dispatcher é invalidado. Utilizando a API da CDN, é possível implementar seu próprio ContentBuilder e TransportHandler (se a API não for baseada em REST) e configurar um agente de replicação que os usará para invalidar o cache da CDN.

NOTE
Consulte também Segurança do AEM (CQ) Dispatcher e Armazenamento em cache de CDN+Browser e uma apresentação gravada sobre Armazenamento em cache do Dispatcher.

Uso de um Dispatcher com um Servidor de Autores using-a-dispatcher-with-an-author-server

CAUTION
Se você usar o AEM com interface de toque, não armazene o conteúdo da instância do autor em cache. Se o armazenamento em cache tiver sido ativado para a instância do autor, será necessário desativá-lo e excluir o conteúdo do diretório do cache. Para desativar o armazenamento em cache, edite o arquivo author_dispatcher.any e modifique a propriedade /rule na seção /cache da seguinte maneira:
/rules
{
/0000
{ /type "deny" /glob "*"}
}

Um Dispatcher pode ser usado na frente de uma instância do autor para melhorar o desempenho da criação. Para configurar um Dispatcher de criação, faça o seguinte:

  1. Instale um Dispatcher em um servidor web (Apache ou IIS; consulte Instalação do Dispatcher).

  2. Teste o Dispatcher recém-instalado em uma instância de publicação do AEM em funcionamento. Isso garante que uma instalação correta de linha de base foi alcançada.

  3. Agora, verifique se o Dispatcher consegue se conectar via TCP/IP à sua instância do autor.

  4. Substitua o arquivo de amostra dispatcher.any pelo arquivo author_dispatcher.any fornecido com o download do Dispatcher.

  5. Abra o author_dispatcher.any em um editor de texto e faça as seguintes alterações:

    1. Altere o /hostname e /port da seção /renders para apontar para a instância do autor.
    2. Altere o /docroot da seção /cache para apontar para um diretório de cache. Caso esteja usando o AEM com Touch UI, consulte o aviso acima.
    3. Salve as alterações.

  6. Exclua todos os arquivos existentes no diretório /cache > /docroot que você configurou acima.

  7. Reinicie o servidor Web.

NOTE
Com a configuração author_dispatcher.any fornecida, ao instalar um pacote de recursos, hotfix ou pacote de código de aplicativo do CQ5 que afete qualquer conteúdo em /libs ou /apps, é necessário excluir os arquivos desses diretórios que foram armazenados no cache do Dispatcher. Isso garante que, na próxima vez em que forem solicitados, os arquivos recém-atualizados sejam buscados, e não os arquivos antigos armazenados em cache.
CAUTION
Se você tiver usado o Dispatcher do autor configurado anteriormente e ativado um agente de limpeza do Dispatcher, faça o seguinte:
  1. Exclua ou desative o agente de limpeza do Dispatcher do autor na instância do autor do AEM.
  2. Refaça a configuração do Dispatcher do autor seguindo as novas instruções acima.
recommendation-more-help
ce382601-480f-4a99-8be7-73178d4b6ef5