Ferramenta do servidor proxy (proxy.jar)

O servidor proxy atua como um servidor intermediário que reporta solicitações entre um cliente e um servidor. O servidor proxy rastreia todas as interações cliente-servidor e gera um log de toda a comunicação TCP. Isso permite monitorar exatamente o que está acontecendo, sem precisar acessar o servidor principal.

Você pode encontrar o servidor proxy na pasta de instalação apropriada:

  • <cq_install_path>/opt/helpers/proxy.jar
  • <crx_install_path>/opt/helpers/proxy.jar

Você pode usar o servidor proxy para monitorar todas as interações cliente-servidor, independentemente do protocolo de comunicação subjacente. Por exemplo, você pode monitorar os seguintes protocolos:

  • HTTP para páginas da Web
  • HTTPS para páginas da Web seguras
  • SMTP para mensagens de email
  • LDAP para gerenciamento de usuários

Por exemplo, você pode posicionar o servidor proxy entre dois aplicativos que se comunicam por meio de uma rede TCP/IP; Por exemplo, um navegador da Web e AEM. Isso permite monitorar exatamente o que acontece quando você solicita uma página de AEM.

Iniciando a Ferramenta Servidor Proxy

A ferramenta pode ser encontrada na pasta /opt/helpers da instalação do AEM. Para iniciá-lo, digite:

java -jar proxy.jar <host> <remoteport> <localport> [options]

Opções

  • q (modo silencioso) Não grava as solicitações na janela do console. Use essa opção se não quiser retardar a conexão ou se registrar a saída em um arquivo (consulte -logfile option).
  • b (modo binário) Se você estiver procurando combinações de bytes específicas no tráfego, ative o modo binário. A saída conterá a saída hexadecimal e de caractere.
  • t (entradas do registro de carimbo de data/hora) Adiciona um carimbo de data/hora a cada saída de log. O carimbo de data/hora é em segundos, portanto, pode não ser adequado para verificar solicitações únicas. Use-o para localizar eventos que ocorreram em um horário específico se você usar o servidor proxy por um período de tempo mais longo.
  • arquivo de log <filename> (gravar no arquivo de log) Grava a conversação cliente-servidor em um arquivo de log. Esse parâmetro também funciona no modo silencioso.
  • i <numindentions> (adicionar recuo) Cada conexão ativa é recuada para melhorar a legibilidade. O padrão é 16 níveis. (Novo no proxy.jar versão 1.16).

Usos da Ferramenta Servidor Proxy

Os cenários a seguir ilustram alguns dos propósitos para os quais a Ferramenta de servidor proxy pode ser usada:

Verificar Cookies e seus Valores

O exemplo de entrada de log a seguir mostra todos os cookies e seus valores enviados pelo cliente na 6ª conexão aberta desde o início do proxy:

C-6-#000635 -> [Cookie: cq3session=7e39bc51-ac72-3f48-88a9-ed80dbac0693; Show=ShowMode; JSESSIONID=68d78874-cabf-9444-84a4-538d43f5064d ]

Verificando cabeçalhos e seus valores O exemplo de entrada de log a seguir mostra que o servidor pode fazer uma conexão keep-alive e o cabeçalho de comprimento do conteúdo foi definido corretamente:

S-7-#000017 -> [Connection: Keep-Alive ]
...
S-7-#000107 -> [Content-Length: 124 ]

Verificando se a opção Keep-Alive funciona

Keep-Alive significa que um cliente reutiliza a conexão com o servidor para transportar vários arquivos (o código da página, imagens, folhas de estilos e assim por diante). Sem manter vivo, o cliente precisa estabelecer uma nova conexão para cada solicitação.

Para verificar se o keep-alive funciona:

  1. Inicie o servidor proxy.
  2. Solicite uma página.
  • Se keep-alive estiver funcionando, o contador de conexão nunca deve ultrapassar 5 a 10 conexões.
  • Se keep-alive não estiver funcionando, o contador de conexão aumenta rapidamente.

Encontrar solicitações perdidas

Se você perder solicitações em uma configuração complexa de servidor, por exemplo, com um firewall e um dispatcher, poderá usar o servidor proxy para descobrir onde a solicitação foi perdida. No caso de um firewall:

  1. Iniciar um proxy antes de um firewall
  2. Iniciar outro proxy após um firewall
  3. Use-os para ver até que ponto as solicitações estão chegando.

Solicitações Suspensas

Se você passar por solicitações pendentes de vez em quando:

  1. Inicie um proxy.jar.
  2. Aguarde ou grave o log de acesso em um arquivo, com cada entrada com um carimbo de data e hora.
  3. Quando a solicitação começa a ser suspensa, você pode ver quantas conexões foram abertas e qual solicitação está causando problemas.

O formato das mensagens de log

As entradas de log produzidas por proxy.jar têm o seguinte formato:

[timestamp (optional)] [<b>C</b>lient|<b>S</b>erver]-[ConnectionNumber]-[BytePosition] ->[Character Stream]

Por exemplo, uma solicitação de uma página da Web pode ser semelhante a:

C-0-#000000 -> [GET /author/prox.html?CFC_cK=1102938422341 HTTP/1.1 ]
  • C significa que essa entrada vem do cliente (é uma solicitação de uma página da Web)
  • 0 é o número da conexão (o contador de conexão inicia em 0)
  • ​# 00000 o deslocamento no fluxo de bytes. Esta é a primeira entrada, então o deslocamento é 0.
  • [GET <?>] é o conteúdo da solicitação, no exemplo um dos cabeçalhos HTTP (url).

Quando uma conexão é fechada, as seguintes informações são registradas:

C-6-Finished: 758 bytes (1.0 kb/s)
S-6-Finished: 665 bytes (1.0 kb/s)

Mostra o número de bytes passados entre o cliente e o servidor na 6ª conexão e na velocidade média.

Um exemplo de saída de log

Revisaremos um modelo simples que produz o seguinte código quando solicitado:

<html>
  <head>
    <title>Welcome</title>
  </head>
  <body>
    Welcome to Playground<br>
    <img src="/logo.gif">
  </body>
</html>

Se AEM estiver em execução em localhost:4303, inicie o servidor proxy da seguinte maneira:

java -jar proxy.jar localhost 4303 4444 -logfile test.log

Você pode acessar o servidor (localhost:4303) sem o servidor proxy, mas se você acessá-lo via localhost:4444, o servidor proxy registrará a comunicação. Abra um navegador e acesse uma página criada com o modelo acima. Depois disso, olhe o arquivo de log.

OBSERVAÇÃO

Até a versão 1.14 do proxy.jar, as entradas de log de uma conexão não são sincronizadas, o que significa que as entradas de log de uma conexão cliente/servidor não são necessárias na ordem sequencial correta. As versões mais recentes (>=1.14) do servidor proxy não têm esse problema.

Ao iniciar, as seguintes informações são gravadas no log:

starting proxy for localhost:4303 on port 4444
using logfile: C:\CQUnify355default\opt\helpers\test.log

Os seguintes campos de cabeçalho são listados no início da primeira conexão (0), que está solicitando a página de HTML principal:

C-0-#000000 -> [GET /author/prox.html?CFC_cK=1102936796533 HTTP/1.1 ]
C-0-#000053 -> [Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/vnd.ms-powerpoint, application/vnd.ms-excel, application/msword, appl]
C-0-#000194 -> [ication/x-shockwave-flash, */* ]
C-0-#000227 -> [Accept-Language: de-ch ]
C-0-#000251 -> [Accept-Encoding: gzip, deflate ]
C-0-#000283 -> [User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0) ]
C-0-#000347 -> [Host: localhost:4444 ]

O Cliente solicita uma conexão keep-alive, para que o servidor possa enviar vários arquivos pela mesma conexão:

C-0-#000369 -> [Connection: Keep-Alive ]

O servidor proxy é uma boa ferramenta para verificar se os cookies estão definidos corretamente ou não. Aqui, vemos o seguinte:

  • cookie cq3session gerado pelo AEM
  • o cookie do switch de modo show gerado pelo CFC
  • um cookie chamado JSESSIONID; isso é criado automaticamente pelo JSP se não for desligado explicitamente usando <%@ page session="false" %>:
C-0-#000393 -> [Cookie: Show=ShowMode; cq3session=3bce15cf-1575-1b4e-8ea6-0d1a0c64738e; JSESSIONID=4161a56b-f193-d748-88a5-e09c5ff7ef2a ]
C-0-#000514 -> [ ]
S-0-#000000 -> [HTTP/1.0 200 OK ]

O servidor fechará a conexão 0 após a solicitação. Keep-live não é possível porque a solicitação tem um ponto de interrogação. Isso significa que o servidor não pode retornar uma versão em cache e, portanto, não pode determinar o comprimento do conteúdo neste ponto, que é necessário para uma conexão keep-alive.

S-0-#000017 -> [Connection: Close ]
S-0-#000036 -> [Server: Communique Servlet Engine/3.5.5 ]
S-0-#000077 -> [Content-Type: text/html;charset=iso-8859-1 ]
S-0-#000121 -> [Date: Tue, 14 Dec 2004 09:46:44 GMT ]
S-0-#000158 -> [Set-Cookie: JSESSIONID=4161a56b-f193-d8-88a5-e09c5ff7ef2a;Path=/author ]
S-0-#000232 -> [ ]

Aqui, o servidor inicia o envio do código HTML na conexão 0:

S-0-#000234 -> [<html> ]
S-0-#000242 -> [.<head> ]
S-0-#000251 -> [..<title>Welcome</title> ]
S-0-#000277 -> [.</head> ]
S-0-#000287 -> [.<body> ]
S-0-#000296 -> [..Welcome to Playground<br> ]
S-0-#000325 -> [..<img src="/author/logo.gif"> ]
S-0-#000357 -> [.</body> ]
S-0-#000367 -> [</html>]

A conexão 0 fecha imediatamente após o arquivo HTML ter sido distribuído:

C-0-Finished: 516 bytes (0.0 kb/s)
S-0-Finished: 374 bytes (0.0 kb/s)

Agora, a saída é iniciada para a conexão 1, que baixa a imagem contida no código HTML:

C-1-#000000 -> [GET /author/logo.gif HTTP/1.1 ]
C-1-#000031 -> [Accept: */* ]
C-1-#000044 -> [Referer: http://localhost:4444/author/prox.html?CFC_cK=1102936796533 ]
C-1-#000114 -> [Accept-Language: de-ch ]
C-1-#000138 -> [Accept-Encoding: gzip, deflate ]
C-1-#000170 -> [User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0) ]
C-1-#000234 -> [Host: localhost:4444 ]

Novamente, o cliente solicita uma conexão keep-alive:

C-1-#000256 -> [Connection: Keep-Alive ]
C-1-#000280 -> [Cookie: Show=ShowMode; cq3session=3bce15cf-1575-1b4e-8ea6-0d1a0c64738e; JSESSIONID=4161a56b-f193-d748-88a5-e09c5ff7ef2a ]
C-1-#000401 -> [ ]
S-1-#000000 -> [HTTP/1.0 200 OK ]

Para a conexão 1, o servidor pode fornecer keep-alive, pois a imagem é estática e, portanto, o comprimento do conteúdo é conhecido.

S-1-#000017 -> [Connection: Keep-Alive ]
S-1-#000041 -> [Server: Communique Servlet Engine/3.5.5 ]
S-1-#000082 -> [Content-Type: image/gif ]

O servidor retorna o comprimento do conteúdo da imagem na conexão 1:

S-1-#000107 -> [Content-Length: 124 ]
S-1-#000128 -> [Date: Tue, 14 Dec 2004 09:46:44 GMT ]
S-1-#000165 -> [ ]

Agora que a duração do conteúdo foi estabelecida, o servidor envia os dados da imagem na conexão 1:

S-1-#000167 -> [GIF87a..........................,.......
...I....0.A..8......YDA.W...1..`i.`..6...Z...$@.F..)`..f..A.....iu.........$..;]

Depois que o tempo limite de manutenção de atividade for atingido, a conexão 1 também será encerrada:

S-1-Finished: 291 bytes (0.0 kb/s)
C-1-Finished: 403 bytes (0.0 kb/s)

O exemplo acima é comparativamente simples, pois as duas conexões ocorrem sequencialmente:

  • primeiro, o servidor retorna o código HTML
  • em seguida, o navegador solicita a imagem e abre uma nova conexão

Na prática, uma página pode gerar muitas solicitações paralelas para imagens, folhas de estilos, arquivos JavaScript etc. Isso significa que os logs têm entradas sobrepostas de conexões abertas paralelas. Nesse caso, recomendamos usar a opção -i para melhorar a legibilidade.

Nesta página