Registro de configuração
Observação:
Os registros de log de configuração aparecem somente em inglês, independentemente do idioma selecionado para 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 registro de configuração é um recurso que captura as alterações de configuração de implantação do Citrix Virtual Apps and Desktops™ e do Citrix DaaS (anteriormente serviço Citrix Virtual Apps and Desktops) e as atividades administrativas em um banco de dados de log no Citrix Cloud. Você pode usar o conteúdo registrado para:
- Diagnosticar e solucionar problemas após as alterações de configuração. O log fornece um rastro de navegação.
- Auxiliar no gerenciamento de alterações e rastrear configurações.
- Relatar atividades administrativas.
Neste Citrix DaaS™, o registro de configuração está sempre habilitado. Você não pode desabilitá-lo.
No Studio, você pode visualizar 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. Neste console, você não pode editar ou excluir o conteúdo do log. Você pode usar o SDK do PowerShell Remoto para agendar a exclusão periódica de dados do log.
Atualizar a retenção de logs de configuração do DaaS
Para manter o desempenho dos locatários do DaaS, a partir de 9 de setembro de 2024, a retenção de logs de configuração será definida para 180 dias.
Os logs com mais de 180 dias em 9 de setembro de 2024 serão excluídos. À medida que continuamos a expandir nossos Limites do DaaS para um único locatário do DaaS, essa implementação garante o melhor desempenho e resiliência para nossos clientes.
Como prática recomendada, aconselhamos os clientes a ter um mecanismo de exportação trimestral. Isso pode ser feito via PowerShell; consulte Gerar relatórios. Também recomendamos que os clientes agendem a exclusão periódica de dados; consulte Agendar exclusão periódica de dados.
Permissões necessárias (consulte Administração delegada):
- Administradores Completos no Citrix Cloud™, além de Administradores de Nuvem do Citrix DaaS e Administradores Somente Leitura podem visualizar logs de configuração no Studio.
- Administradores Completos e Administradores de Nuvem também podem baixar um relatório CSV da atividade de log, usando o PowerShell.
O que é registrado
As seguintes operações são registradas:
- Alterações de configuração e atividades administrativas iniciadas na seção Gerenciar e no nó Monitorar
- Scripts do PowerShell
- Solicitações de API REST
Observação:
Você não pode ver entradas de log para operações internas da plataforma Citrix Cloud, como configuração e gerenciamento de banco de dados.
Exemplos de alterações de configuração registradas incluem trabalhar com (criar, editar, excluir, atribuir):
- Catálogos de máquinas
- Grupos de entrega (incluindo alteração das configurações de gerenciamento de energia)
- Funções e escopos de administrador
- Recursos e conexões de host
- Políticas Citrix® via Studio
Exemplos de alterações administrativas registradas incluem:
- Gerenciamento de energia de uma máquina virtual ou de uma área de trabalho de usuário
- Funções de gerenciamento ou monitoramento que enviam uma mensagem a um usuário
As seguintes operações não são registradas. (Muitas delas não estão disponíveis para administradores de clientes.)
- Operações automáticas, como o ligamento de máquinas virtuais no gerenciamento de pool.
- Ações de política implementadas por meio do Console de Gerenciamento de Política de Grupo (GPMC). Use as ferramentas da Microsoft para visualizar os logs dessas ações.
- Alterações feitas por meio do registro ou de outras fontes que não o Studio, Monitor ou PowerShell.
Visualizar o conteúdo do log de configuração
Para visualizar o conteúdo do log de configuração, siga estas etapas:
- Entre no Citrix Cloud.
- No bloco DaaS, clique em Gerenciar.
- Selecione Registro no painel esquerdo e clique na guia Eventos.
Por padrão, os logs de eventos são listados por nomes de administrador. Você pode executar as seguintes tarefas conforme necessário:
- Classificar a exibição. Classifique a exibição clicando em um cabeçalho de coluna.
- Filtrar logs. Refine a exibição definindo condições de filtro, como intervalos de dias ou períodos personalizados, ou inserindo nomes de Tarefas Principais completos ou parciais na caixa de Pesquisa. Para retornar à exibição padrão após usar a pesquisa, limpe o texto na caixa de Pesquisa.
- Exportar logs. Exporte logs selecionados ou todos os logs para um arquivo CSV para arquivamento ou análise posterior.
- Personalizar colunas. Adapte a exibição às suas necessidades adicionando colunas não padrão, como IP do Cliente e Rótulos.
- Gerenciar rótulos. Adicione, edite e remova rótulos para logs de eventos para aprimorar a organização e o rastreamento de logs.
Características da exibição:
- Operações de alto nível criadas durante o gerenciamento e monitoramento são listadas no painel superior central. Uma operação de alto nível resulta em um ou mais serviços e chamadas de SDK do PowerShell, que são operações de baixo nível. Ao selecionar uma operação de alto nível no painel superior central, o painel inferior exibe as operações de baixo nível.
- Se você criar uma operação de baixo nível no PowerShell sem especificar uma operação de alto nível pai, o registro de configuração criará 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 um registro de parada correspondente. Nesses casos, o log indica que há informações ausentes. Ao exibir logs com base em intervalos de tempo, logs incompletos são mostrados se os dados nos logs corresponderem aos critérios. Por exemplo, se você solicitar logs dos últimos cinco dias e um log com um horário de início nos últimos cinco dias não tiver um horário de término, ele será incluído.
- Lembre-se: Você não pode ver entradas de log para operações internas da plataforma Citrix Cloud, como configuração e gerenciamento de banco de dados.
Visualizar tarefas relacionadas a operações de catálogo de máquinas
Para visualizar tarefas relacionadas a operações de catálogo de máquinas, navegue até Registro > Tarefas. A guia Tarefas exibe apenas tarefas relacionadas a catálogos criados por meio do Machine Creation Services™ (MCS) ou Provisioning Services (PVS). Especificamente, aparecem as tarefas associadas às seguintes operações de catálogo de máquinas:
- Criar catálogos
- Clonar catálogos
- Adicionar máquinas
- Remover máquinas
- Atualizar um catálogo (atualizar imagens ou máquinas)
- Reverter atualizações de máquina
Dica:
A guia Tarefas exibe apenas tarefas relacionadas a alterações de esquema de provisionamento (criação ou modificação de um esquema de provisionamento).
Uma tarefa pode estar no seguinte estado:
- Concluída
- Não iniciada
- Em execução
- Cancelada
- Falha
- Desconhecida
Para cancelar uma tarefa em execução, selecione a tarefa e clique em Cancelar. O cancelamento leva algum tempo para ser concluído.
Exemplos de tarefas registradas 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
- Catálogo criado
Por padrão, a exibição no painel central lista as tarefas registradas cronologicamente (entradas mais recentes primeiro), separadas por data. Você pode classificar a exibição pelo cabeçalho da coluna. Para limpar as tarefas concluídas, clique em Limpar Tarefas Concluídas na guia Tarefas. Para escolher quais colunas aparecerão na exibição, selecione o ícone Colunas a Exibir no canto superior direito da tabela.
Visualizar logs de API
Para visualizar logs de API REST, navegue até Registro > APIs. A guia APIs exibe as solicitações de API REST feitas durante um determinado período.
Esteja ciente das seguintes considerações:
- Os logs da API REST são limpos depois que você sai do console. (Eles também são limpos se você atualizar a janela do navegador.)
- Quaisquer operações no console que resultem em chamadas de API terão suas solicitações de API correspondentes exibidas na guia APIs.
- A exibição lista as solicitações de API cronologicamente (entradas mais recentes primeiro), separadas por data. O número máximo de solicitações de API na exibição é 1.000.
Visualizar logs do PowerShell
Para visualizar os comandos do PowerShell correspondentes às ações da interface do usuário que você realizou durante o dia, navegue até a guia Registro > PowerShell.
Associar metadados a logs de configuração
Você pode anexar metadados a logs de configuração associando um par nome-valor chamado MetadataMap aos registros de log.
Observação:
- 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 aceita 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. Esta é uma alternativa ao parâmetro
Id, onde 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 para a propriedade.
-
Map: Dicionário de pares (nome, valor) para as propriedades. Esta é 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:
-
Pesquisar por chave e valor:
Get-LogHighLevelOperation -Metadata "Key:Value" -
Pesquisar por valor e qualquer chave:
Get-LogHighLevelOperation -Metadata "*:Value" -
Pesquisar 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 aceita 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. Esta é uma alternativa ao parâmetro
Id, onde 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. Pode ser um hashtable (criado com @{“name1” = “val1”; “name2” = “val2”}) ou um dicionário de strings (criado com new-object “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 de log de configuração, use os cmdlets do PowerShell para o Serviço ConfigLogging no SDK do PowerShell Remoto do Citrix Virtual Apps™ e Desktops. Para obter detalhes, consulte:
Agendar exclusão periódica de dados
Use o SDK do PowerShell Remoto para especificar por quanto tempo os dados são retidos no banco de dados de registro de configuração. (Este recurso não está disponível no Studio.) No Citrix DaaS, você deve ter acesso total.
No cmdlet Set-LogSite, o parâmetro -LoggingDBPurgeDurationDays especifica quantos dias os dados são retidos no banco de dados de registro 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 de registro 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. Dados mais antigos que o período de retenção são excluídos.
Use Get-LogSite para visualizar o valor atual do parâmetro.
Diferenças em relação ao Citrix Virtual Apps and Desktops local
Se você está familiarizado com o registro de configuração no produto Virtual Apps and Desktops local, a versão do Citrix Cloud apresenta várias diferenças. No Citrix Cloud:
- O registro de configuração está sempre habilitado. Você não pode desabilitá-lo. O registro obrigatório não está disponível.
- Você não pode alterar o local do banco de dados de registro de configuração, pois o banco de dados é gerenciado na plataforma Citrix Cloud.
- As exibições de log de configuração não incluem operações e atividades realizadas na plataforma Citrix Cloud.
- O PowerShell é sua única opção para criar um relatório CSV ou HTML de operações registradas. No produto local, os relatórios podem ser gerados a partir do Citrix Studio ou do PowerShell.
- Você não pode excluir o conteúdo do log de configuração.
Neste artigo
- Atualizar a retenção de logs de configuração do DaaS
- O que é registrado
- Visualizar o conteúdo do log de configuração
- Visualizar tarefas relacionadas a operações de catálogo de máquinas
- Visualizar logs de API
- Visualizar logs do PowerShell
- Associar metadados a logs de configuração
- Gerar relatórios
- Agendar exclusão periódica de dados
- Diferenças em relação ao Citrix Virtual Apps and Desktops local