Citrix Virtual Apps and Desktops™ 7 2507 LTSR

Visualizando e Usando Logs AOT

Acessando Logs via UI do Director

Etapa 1

Edite o arquivo StartLogServer.bat

O arquivo StartLogServer.bat contém todos os parâmetros de configuração usados para iniciar o contêiner do Servidor de Log AOT, incluindo várias variáveis de ambiente que controlam o acesso e o comportamento do log. Uma das configurações principais é LOCAL_DOWN_ONLY.

  • Quando LOCAL_DOWN_ONLY=false, o Servidor de Log aceita solicitações de visualização de log remotas. Isso permite que o Citrix Director/Monitor se conecte ao Servidor de Log e exiba os logs AOT diretamente na UI do Monitor.

  • Quando LOCAL_DOWN_ONLY=true, o Servidor de Log restringe o acesso ao log a conexões somente locais. Neste modo, você deve se conectar diretamente à máquina do Servidor de Log para visualizar os logs, e o Citrix Director Monitor não conseguirá recuperar ou exibir os logs.

Arquivo bat AOT

Etapa 2

O Web Studio fornece uma configuração dedicada que permite ao Citrix Director conectar-se ao Servidor de Log AOT e exibir logs no console do Monitor. Uma vez que as configurações do Web Studio são salvas, os Delivery Controllers atualizam a configuração do site, e o Director recebe os detalhes do servidor de log, incluindo o endereço do servidor de log, porta e chave de autenticação. O Director usa essas configurações para estabelecer uma conexão segura com o Servidor de Log.

Etapa 3

Após a configuração:

  1. Abra o Citrix Director.
  2. Uma nova opção Logs aparece no painel de navegação esquerdo.
  3. Selecione Logs e você verá a página Primeiros Passos, clique em Fechar para ignorá-la, pois já concluímos essas configurações anteriormente.
  4. Agora, você verá o Director recuperando e exibindo logs AOT diretamente do Servidor de Log.

Citrix Director

A página Logs no Director fornece uma visão unificada dos eventos AOT de Delivery Controllers, VDAs, servidores StoreFront e outros componentes Citrix. Você pode pesquisar, filtrar e inspecionar logs em tempo real para solucionar problemas rapidamente.

Pesquisa de texto livre: Na parte superior da página Logs, você encontrará uma barra de pesquisa de texto livre. Você pode digitar qualquer palavra-chave para começar a refinar os resultados. A pesquisa atualiza os resultados instantaneamente assim que você aplica os filtros. Os exemplos incluem:

  • Nomes de usuário
  • Nomes de máquina
  • Palavras-chave de evento (por exemplo, registro, autenticação, STA)
  • IDs de transação
  • Mensagens de erro ou cadeias de caracteres parciais

Filtro de tempo: Use o seletor de tempo (por exemplo, Últimos 5 minutos, Última 1 hora, Últimas 24 horas) para visualizar logs gerados dentro de uma duração específica. Isso ajuda você a isolar rapidamente eventos em torno do momento exato em que um problema ocorreu.

Filtro de categoria: O campo Categoria permite filtrar logs com base no tipo de evento ou subsistema. Isso ajuda você a se concentrar em logs relacionados a inicialização de aplicativos, registro, configuração de VDA, gráficos, HDX Direct, conexão ICA, etc.

Filtro de Classe de Log: O filtro Classe de Log agrupa os logs por gravidade ou tipo de evento. Isso permite que você se concentre apenas em erros ou eventos importantes ao solucionar problemas. As classes comuns incluem:

  • Informação
  • Aviso
  • Erro
  • Falha

Filtro de nome de host: O filtro de nome de host permite selecionar uma máquina específica — como um VDA, Delivery Controller, CWA ou servidor StoreFront. Isso é útil quando você deseja detalhar os logs de um único endpoint ou VM em vez de pesquisar em toda a implantação.

Este acesso centralizado simplifica a solução de problemas, permitindo a recuperação e análise rápidas de logs a partir de um único console. Saiba mais sobre os pré-requisitos e como começar em Director - Logs.

Acessando Logs via Servidor de Log

O conteúdo a seguir é Gerar a AuthKey. Para habilitar o acesso aos logs, o usuário precisa

  1. Modifique o script StartLogServer.bat LOCAL_DOWN_ONLY=false

  2. Gere a AuthKey

Para manter seus logs seguros, você precisará de uma AuthKey antes de baixá-los. Veja o que fazer:

  1. Obtenha sua AuthKey – Use seu próprio nome de função/nome para gerá-la.
  2. Execute localmente – Os scripts só podem ser executados na máquina onde o contêiner Docker está instalado.
  3. Usuários Windows – Use os scripts GetAuthKey.bat em vez de scripts shell.
  4. Baixe os logs – Uma vez autenticado, você pode recuperar seus logs com segurança.

Gerando e Gerenciando chaves de autenticação para o Servidor de Log AOT

Você pode usar os scripts .sh (Linux) ou .bat (Windows) fornecidos para gerar rapidamente uma nova chave de autenticação para uma função ou usuário específico. Esses scripts simplificam o processo retornando a chave gerada junto com a função associada.

Para Linux

./GetAuthKey.sh role-name
<!--NeedCopy-->

Para Windows

GetAuthKey.bat role-name
<!--NeedCopy-->

O Servidor de Log AOT fornece comandos para gerenciar chaves de autenticação associadas a diferentes funções ou usuários. Esses comandos permitem que os administradores adicionem, listem, validem e excluam chaves de autenticação diretamente do contêiner. Use os comandos docker exec disponíveis diretamente no contêiner do Servidor de Log.

  • Adicionar uma nova chave de autenticação: Cria uma nova chave de autenticação para uma função ou usuário especificado:

docker exec logserver /app/authkey add <RoleName>

  • Listar todas as chaves de autenticação: Exibe todas as funções/usuários existentes para os quais as chaves de autenticação foram criadas:

docker exec logserver /app/authkey list

  • Validar uma chave de autenticação: Verifica se uma determinada chave de autenticação é válida e identifica a função associada:

docker exec logserver /app/authkey validate <key>

  • Excluir uma chave de autenticação: Remove uma chave de autenticação associada a uma função específica:

docker exec logserver /app/authkey del <RoleName>

  • Ver uso do comando: Exibe as opções disponíveis para o gerenciamento de chaves de autenticação:

docker exec logserver /app/authkey ??

O exemplo a seguir demonstra como gerenciar chaves de autenticação:

Chave de autenticação AOT

Listar nomes de máquinas que já enviaram seus logs AOT para o servidor de log

O parâmetro é a chave obtida de GetAuthKey.sh

Para Linux

./ListMachines.sh ebac9b7726cb4be597c92c6769134d25
{"machines":["MachineName"]}
<!--NeedCopy-->

Máquinas vazias significa que não há log

Para Windows

ListMachines.bat ebac9b7726cb4be597c92c6769134d25
{"machines":["MachineName"]}
<!--NeedCopy-->

Para o PowerShell do Windows quando o LogServer inicia com “-e LOCAL_DOWN_ONLY=false”:

Invoke-WebRequest -Uri "https://logserver_fqdn:8443/ctxlogserver/Download/ListMachine" -Headers @{ AuthKey = "ebac9b7726cb4be597c92c6769134d25" }
<!--NeedCopy-->

Substitua logserver_fqdn pelo FQDN real do logserver e 8443 pela porta real do logserver. Substitua https por http quando instalado no modo http.

Máquinas vazias significa que não há log

Baixar logs por nome da máquina e intervalo de tempo.

A hora está no formato UTC: AAAA-mm-ddTHH:MM:SSZ.

#Usage: ./DownloadLogsByTime.sh [AuthKey] [MachineName] [StartTime|YYYY-mm-ddTHH:MM:SSZ] [EndTime|YYYY-mm-ddTHH:MM:SSZ] [OutputFile]
#Example:
<!--NeedCopy-->

Para Linux

./DownloadLogsByTime.sh ebac9b7726cb4be597c92c6769134d25 MachineName 2025-01-01T00:00:00Z 2025-01-02T00:00:00Z logs.csv
<!--NeedCopy-->

Para Windows

DownloadLogsByTime.bat ebac9b7726cb4be597c92c6769134d25 MachineName 2025-01-01T00:00:00Z 2025-01-02T00:00:00Z logs.csv
<!--NeedCopy-->

Para o PowerShell do Windows quando o LogServer inicia com “-e LOCAL_DOWN_ONLY=false”:

Invoke-WebRequest -Uri "https://logserver_fqdn:8443/ctxlogserver/Download/TimeRange?start=2025-01-01T00:00:00Z&end=2025-01-02T00:00:00Z" -Headers @{ AuthKey = "ebac9b7726cb4be597c92c6769134d25" } -OutFile logs.csv
<!--NeedCopy-->

Baixar logs por filtro de palavra(s)-chave. A hora está no formato UTC

Nota:

  • Uma palavra-chave pode ser uma única palavra ou uma combinação de palavras.
  • Palavras-chave podem corresponder em qualquer lugar dentro da mensagem de log.
  • Um ID de Transação também pode ser usado como palavra-chave.
#Usage: ./DownloadLogsByWords.sh [AuthKey] [StartTime|YYYY-mm-ddTHH:MM:SSZ] [EndTime|YYYY-mm-ddTHH:MM:SSZ] [SearchWords] [OutputFile]
#Example:
<!--NeedCopy-->

Para Linux

./DownloadLogsByWords.sh authkey 2025-01-01T00:00:00.000Z 2025-12-31T23:59:59.999Z "session launch" logs.csv
<!--NeedCopy-->

Para Windows

DownloadLogsByWords.bat authkey 2025-01-01T00:00:00.000Z 2025-12-31T23:59:59.999Z "failed vda" logs.csv
<!--NeedCopy-->

Para PowerShell do Windows quando o LogServer inicia com “-e LOCAL_DOWN_ONLY=false”:

Invoke-WebRequest -Uri "https://logserver_fqdn:8443/ctxlogserver/Download/SearchLog?start=2025-01-01T00:00:00Z&end=2025-01-02T00:00:00Z&words=failed vda" -Headers @{ AuthKey = "ebac9b7726cb4be597c92c6769134d25" } -OutFile logs.csv
<!--NeedCopy-->

As palavras são separadas por espaço

Visualizando e Usando Logs AOT