Log de configuração
Nota:
Os registros do log de configuração aparecem somente em inglês, independentemente do idioma selecionado para a sua conta do Citrix Cloud. As datas e horas associadas a esses registros estão no formato MM/DD/AA, expressas em Tempo Universal Coordenado (UTC).
O log de configuração é um recurso que captura as alterações de configuração de implantação do Citrix DaaS (anteriormente Citrix Virtual Apps and Desktops) e atividades administrativas em um banco de dados de log no Citrix Cloud. Você pode usar o conteúdo no log para:
- Diagnosticar e solucionar problemas após fazer alterações de configuração. O log fornece uma trilha de localização.
- Auxiliar no gerenciamento de mudanças e rastrear as configurações.
- Informar atividades administrativas.
Neste Citrix DaaS, o log de configuração está sempre ativado. Você não pode desativá-lo.
Na interface de gerenciamento Full Configuration, você pode exibir o conteúdo do log de configuração, filtrado por intervalos de datas ou por pesquisa de texto completo. Você também pode gerar um relatório CSV usando o PowerShell. Nesse console, você não pode editar ou excluir o conteúdo do log. Você pode usar o Remote PowerShell SDK para agendar a exclusão periódica de dados do log.
Permissões necessárias (consulte Administração delegada):
- Full Administrators no Citrix Cloud, além de Cloud Administrators e Read Only Administrators no Citrix DaaS, podem visualizar logs de configuração no console Manage.
- Full Administrators e Cloud Administrators também podem baixar um relatório CSV da atividade de log, usando o PowerShell.
O que é registrado no log
As seguintes operações são registradas em log:
- Alterações de configuração e atividades administrativas iniciadas nas guias Manage e Monitor
- Scripts do PowerShell
- Solicitações de API REST
Nota:
Você não pode ver entradas de log de operações internas da plataforma Citrix Cloud, como configuração e gerenciamento de banco de dados.
Exemplos de alterações de configuração em log incluem trabalhar com (criar, editar, excluir, atribuir):
- Catálogos de máquinas
- Grupos de entrega (incluindo a alteração das configurações de gerenciamento de energia)
- Funções e escopos do administrador
- Recursos e conexões do host
- Políticas da Citrix por meio do console Manage
Exemplos de alterações administrativas em log incluem:
- Gerenciamento de energia de uma máquina virtual ou área de trabalho do usuário
- Gerenciar ou monitorar funções enviando uma mensagem para um usuário
As seguintes operações não são registradas em log. (Muitas delas não estão disponíveis para administradores de clientes.)
- Operações automáticas, como a ativação do gerenciamento em pool de máquinas virtuais.
- Ações de políticas implementadas por meio do Console de gerenciamento de política de grupo (GPMC). Use as ferramentas da Microsoft para exibir os logs dessas ações.
- Alterações feitas por meio do registro ou de fontes que não a interface de gerenciamento Full Configuration, Monitor ou PowerShell.
Exibir conteúdo do log de configuração
Para exibir o conteúdo do log de configuração, siga estas etapas:
- Faça login no Citrix Cloud. Selecione My Services > DaaS no menu superior esquerdo.
- Em Manage > Full Configuration, selecione Logging > Events no painel esquerdo.
Por padrão, a exibição no painel central lista o conteúdo do log cronologicamente (entradas mais recentes primeiro), separado por data. Você pode:
- Ordenar a exibição pelo cabeçalho da coluna.
- Filtrar a exibição especificando um intervalo de dias ou um período de tempo personalizado, ou inserindo texto na caixa de pesquisa. Para retornar à exibição padrão depois de usar a pesquisa, apague o texto na caixa Search.
Características de exibição:
- As operações de alto nível criadas durante o gerenciamento e o monitoramento são listadas no painel central superior. Uma operação de alto nível resulta em uma ou mais chamadas de serviço e PowerShell SDK, que são operações de baixo nível. Quando você seleciona uma operação de alto nível no painel central superior, o painel inferior exibe as operações de nível baixo.
- Se você criar uma operação de baixo nível no PowerShell sem especificar uma operação de alto nível pai, o log de configuração cria uma operação de alto nível substituta.
- Se uma operação falhar antes da conclusão, a operação de log pode não ser concluída no banco de dados. Por exemplo, um registro de início não tem o registro de parada correspondente. Nesses casos, o log indica que há informações ausentes. Quando você exibe logs com base em intervalos de tempo, os registros incompletos são mostrados se os dados nos logs corresponderem aos critérios. Por exemplo, se você solicitar os logs dos últimos cinco dias e um log com uma hora de início nos últimos cinco dias não tiver hora de término, ele será incluído.
- Lembre-se: você não pode ver entradas de log de operações internas da plataforma Citrix Cloud, como configuração e gerenciamento de banco de dados.
Exibir tarefas relacionadas às operações do catálogo de máquinas
Para exibir tarefas relacionadas às operações do catálogo de máquinas, navegue até Manage > Full Configuration > Logging > Tasks. A guia Tasks exibe apenas as tarefas relacionadas aos catálogos criados por meio do Machine Creation Services (MCS) ou Provisioning Services (PVS). Especificamente, as tarefas associadas às seguintes operações do catálogo de máquinas são exibidas:
- Criar catálogos
- Clonar catálogos
- Adicionar máquinas
- Remover máquinas
- Atualizar um catálogo (atualizar imagens ou máquinas)
- Reverter atualizações da máquina
Dica:
A guia Tasks exibe somente as tarefas relacionadas às alterações do esquema de provisionamento (criação ou modificação de um esquema de provisionamento).
Uma tarefa pode estar no seguinte estado:
- Completed
- Not started
- Running
- Canceled
- Failed
- Unknown
Para cancelar uma tarefa em execução, selecione-a e clique em Cancel. O cancelamento leva algum tempo para ser concluído.
Exemplos de tarefas em log incluem:
- Atualização de imagem concluída para um determinado catálogo
- Erro ao atualizar a imagem para um determinado catálogo
- Atualização de imagem cancelada para um determinado catálogo
- Provisionamento de VMs para um determinado catálogo
- Remoção de VMs de um determinado catálogo
- Criação de um determinado catálogo
Por padrão, a exibição no painel central lista as tarefas registradas cronologicamente (as entradas mais recentes primeiro), separadas por data. Você pode classificar a exibição pelo cabeçalho da coluna. Para limpar tarefas concluídas, clique em Clear Completed Tasks na guia Tasks.
Exibir logs de API
Para visualizar os logs da API REST, navegue até Manage > Full Configuration > Logging > APIs. A guia APIs exibe as solicitações da API REST feitas durante um determinado período de tempo.
Esteja ciente das seguintes considerações:
- Os logs da API REST são apagados depois que você sai do console. (Eles também são apagados se você atualizar a janela do navegador.)
- Todas as operações no console que resultam em chamadas da API têm suas solicitações de API correspondentes exibidas na guia APIs.
- A exibição lista as solicitações de API cronologicamente (as entradas mais recentes primeiro), separadas por data. O número máximo de solicitações de API na tela é 1.000.
Associar metadados aos logs de configuração
Você pode anexar metadados aos logs de configuração associando um par name-value chamado MetadataMap aos registros de log.
Nota:
- Você só pode anexar metadados a objetos de operação de alto nível.
- Os metadados são associados aos registros existentes no momento da execução.
Definir os metadados
Execute o comando do PowerShell Set-LogHighLevelOperationMetadata para associar um registro de log ao MetadataMap.
Set-LogHighLevelOperationMetadata usa os seguintes parâmetros:
- Id:ID da operação de alto nível.
-
InputObject:as operações de alto nível às quais você adiciona os metadados. Essa é uma alternativa ao parâmetro
Idem que um objeto de operação de alto nível ou uma lista de objetos é passada para o comando do PowerShell. -
Name:nome da propriedade dos metadados a serem adicionados. A propriedade deve ser exclusiva para a operação de alto nível especificada. A propriedade não pode conter nenhum dos seguintes caracteres:
()\/;:#.*?=<>|[]"' - Value:valor da propriedade.
-
Map:dicionário de pares (nome, valor) para as propriedades. Essa é uma alternativa para definir os metadados usando os parâmetros
-Namee-Value.
Por exemplo, para anexar os metadados a todos os registros de log de alto nível com Id 40, execute o seguinte comando do PowerShell:
Get-LogHighLevelOperation – Id 40 | Set-LogHighLevelOperationMetadata -Name A -Value B
Para anexar os metadados ao registro de alto nível com o usuário abc@example.com, execute o seguinte comando do PowerShell:
Get-LogHighLevelOperation – User `abc@example.com` | Set-LogHighLevelOperationMetadata -Name C -Value D
Recuperar usando os metadados
Execute os seguintes comandos do PowerShell para usar os metadados associados para recuperar os registros de log:
-
Pesquise por chave e valor:
Get-LogHighLevelOperation -Metadata "Key:Value" -
Pesquise por valor e qualquer chave:
Get-LogHighLevelOperation -Metadata "*:Value" -
Pesquise por chave e qualquer valor:
Get-LogHighLevelOperation -Metadata "Key:*"
Remover os metadados
Execute o comando do PowerShell Remove-LogHighLevelOperationMetadata para remover os metadados associados.
Remove-LogHighLevelOperationMetadata usa os seguintes parâmetros:
- Id:ID da operação de alto nível.
-
InputObject:as operações de alto nível às quais você adiciona os metadados. Essa é uma alternativa ao parâmetro
Id` em que um objeto de operação de alto nível ou uma lista de objetos é passada para o comando do PowerShell. - Name:nome da propriedade dos metadados a serem removidos. Defina como $null para remover todos os metadados do objeto especificado.
- Map:dicionário de pares (nome, valor) para as propriedades. Isso pode ser uma tabela de hash (criada com @{“name1” = “val1”; “name2” = “val2”}) ou um dicionário de cadeias de caracteres (criado com o novo objeto “System.Collections.Generic.Dictionary[String, String]”). As propriedades cujos nomes correspondem às chaves no mapa são removidas.
Gerar relatórios
Para gerar um relatório CSV ou HTML contendo dados do log de configuração, use os cmdlets do PowerShell para o ConfigLogging Service no SDK do PowerShell remoto do Citrix Virtual Apps and Desktops. Para obter detalhes, consulte:
Agendar a exclusão periódica de dados
Use o Remote PowerShell SDK para especificar por quanto tempo os dados são retidos no banco de dados do log de configuração. (Esse recurso não está disponível na interface de gerenciamento Full Configuration.) No Citrix DaaS, você deve ter acesso completo.
No cmdlet Set-LogSite, o parâmetro -LoggingDBPurgeDurationDays especifica por quantos dias os dados são retidos no banco de dados do log de configuração antes de serem excluídos automaticamente.
- Por padrão, o valor desse parâmetro é 0. Um valor zero significa que os dados no banco de dados do log de configuração nunca são excluídos automaticamente.
- Quando você define um valor diferente de zero, o banco de dados é verificado uma vez a cada 120 minutos. Os dados mais antigos do que o período de retenção são excluídos.
Use Get-LogSite para exibir o valor atual do parâmetro.
Diferenças do Citrix Virtual Apps and Desktops no local
Se você estiver familiarizado com o log de configuração no produto Virtual Apps and Desktops local, a versão do Citrix Cloud tem várias diferenças. No Citrix Cloud:
- O log de configuração está sempre ativado. Você não pode desativá-lo. O log obrigatório não está disponível.
- Você não pode alterar o local do banco de dados do log de configuração, porque o banco de dados é gerenciado na plataforma Citrix Cloud.
- As exibições do log de configuração não incluem operações e atividades que são executadas na plataforma Citrix Cloud.
- O PowerShell é a sua única opção para criar um relatório CSV ou HTML das operações registradas no log. No produto local, os relatórios podem ser gerados a partir do Citrix Studio ou do PowerShell.
- Não é possível excluir o conteúdo do log de configuração.
Neste artigo
- O que é registrado no log
- Exibir conteúdo do log de configuração
- Exibir tarefas relacionadas às operações do catálogo de máquinas
- Exibir logs de API
- Associar metadados aos logs de configuração
- Gerar relatórios
- Agendar a exclusão periódica de dados
- Diferenças do Citrix Virtual Apps and Desktops no local