Log de configuração
O log de configuração é um recurso que captura alterações na configuração do site e atividades administrativas no banco de dados. O recurso é ativado por padrão. 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.
Você define as preferências de log de configuração, exibe os logs de configuração e gera relatórios HTML e CSV no Citrix Studio. Você pode filtrar as exibições do log de configuração por intervalos de datas e resultados de pesquisa de texto. O log obrigatório, quando ativado, impede que alterações de configuração sejam feitas, a menos que possam ser registradas em log. Com a permissão apropriada, você pode excluir entradas do log de configuração. Você não pode usar o recurso de log de configuração para editar o conteúdo do log.
O log de configuração usa um SDK do PowerShell e o Configuration Logging Service. O Configuration Logging Service é executado em todos os Controllers do site. Se um Controller falhar, o serviço em outro Controller lida automaticamente com as solicitações de log.
Por padrão, o recurso de registro de configuração está ativado e usa o banco de dados criado quando você cria o site (o banco de dados de configuração do site). Você pode especificar um local diferente para o banco de dados. O banco de dados do log de configuração suporta os mesmos recursos de alta disponibilidade que o banco de dados de configuração do site.
O acesso ao registro de configuração é controlado por meio da administração delegada, com as permissões Edit Logging Preferences e View Configuration Logs.
Os logs de configuração são localizados quando são criados. Por exemplo, um registro criado em inglês é lido em inglês, independentemente da localidade do leitor.
O que é registrado no log
As alterações de configuração e as atividades administrativas iniciadas no Studio, Director e por scripts PowerShell são registradas em log. 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 Citrix através do Studio
Exemplos de alterações administrativas em log incluem:
- Gerenciamento de energia de uma máquina virtual ou área de trabalho do usuário
- Quando o Studio ou Director envia uma mensagem para um usuário
As seguintes operações não são registradas em log:
- Operações autônomas, 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 ver os logs dessas ações.
- Alterações feitas por meio do registro, acesso direto do banco de dados ou a partir de outras fontes que não o Studio, Director ou PowerShell.
- Quando a implantação é inicializada, o log de configuração fica disponível quando a primeira instância do Configuration Logging Service é registrada no Configuration Service. Portanto, os estágios iniciais da configuração não são registrados em log (por exemplo, quando o esquema do banco de dados é obtido e aplicado, quando um hipervisor é inicializado).
Gerenciar o log de configuração
Por padrão, o log de configuração usa o banco de dados que é criado quando você cria um site (também conhecido como banco de dados de configuração do site). A Citrix recomenda que você use um local separado para o banco de dados de log de configuração (e o banco de dados de monitoramento) pelos seguintes motivos:
- A estratégia de backup do banco de dados de log de configuração provavelmente será diferente da estratégia de backup do banco de dados de configuração do site.
- O volume de dados coletados do log de configuração (e o Monitoring Service) pode afetar negativamente o espaço disponível para o banco de dados de configuração do site.
- Ele divide o ponto único de falha entre os três bancos de dados.
As edições de produtos que não oferecem suporte ao log de configuração não têm um nó Logging no Studio.
Ativar e desativar o log de configuração e o log obrigatório
Por padrão, o log de configuração está ativado e o log obrigatório está desativado.
- Selecione Logging no painel de navegação do Studio.
- Selecione Preferences no painel Actions. A caixa de diálogo do log de configuração contém informações do banco de dados e indica se o log de configuração e o log obrigatório estão ativados ou desativados.
-
Selecione a ação desejada:
Para ativar o registro em log de configuração, selecione Enable. Essa é a configuração padrão. Se o banco de dados não puder ser gravado, as informações de log são descartadas, mas a operação continua.
Para desativar o log de configuração, selecione Disable. Se o registro em log tiver sido ativado anteriormente, os registros existentes permanecem legíveis com o SDK do PowerShell.
Para ativar o log obrigatório, selecione Prevent changes to the site configuration when the database is not available. Nenhuma alteração de configuração ou atividade administrativa que é normalmente registrada em log é permitida, a menos que possa ser gravada no banco de dados de log de configuração. Você pode ativar o log obrigatório somente quando o log de configuração está ativado (quando Enable está selecionado). Se o Configuration Logging Service falhar e a alta disponibilidade não estiver em uso, o log obrigatório passa a ser o padrão. Nesses casos, as operações que normalmente seriam registradas em log não são realizadas.
Para desativar o log obrigatório, selecione Allow changes when to the site configuration when the database is not available. Alterações de configuração e atividades administrativas são permitidas, mesmo que o banco de dados de log de configuração não possa ser acessado. Essa é a configuração padrão.
Alterar a localização do banco de dados de log de configuração
Você não pode alterar a localização do banco de dados quando o log obrigatório está ativado, pois a alteração da localização inclui um breve intervalo de desconexão que não pode ser registrado no log.
- Crie um servidor de banco de dados usando uma versão compatível do SQL Server.
- Selecione Logging no painel de navegação do Studio.
- Selecione Preferences no painel Actions.
- Na caixa de diálogo Logging Preferences, selecione Change logging database.
- Na caixa de diálogo Change Logging Database, especifique a localização do servidor que contém o novo servidor de banco de dados. Consulte Formatos de endereço de banco de dados para formatos válidos
- Para permitir que o Studio crie o banco de dados, clique em OK. Quando solicitado, clique em OK e o banco de dados é criado automaticamente. O Studio tenta acessar o banco de dados usando as credenciais do usuário atual do Studio. Se isso falhar, você será solicitado a fornecer as credenciais do usuário do banco de dados. Em seguida, o Studio carrega o esquema do banco de dados para o banco de dados. (As credenciais são retidas somente durante a criação do banco de dados.)
- Para criar o banco de dados manualmente, clique em Generate database script. O script gerado inclui instruções para criar o banco de dados manualmente. Confirme que o banco de dados está vazio e que pelo menos um usuário tem permissão para acessar e alterar o banco de dados antes de carregar o esquema.
Os dados no log de configuração de dados anterior não são importados para o novo banco de dados. Os logs não podem ser agregados de ambos os bancos de dados quando recuperados. A primeira entrada de log no novo banco de dados de log de configuração indica que ocorreu uma alteração no banco de dados, mas não identifica o banco de dados anterior.
Exibir conteúdo do log de configuração
Ao iniciar alterações de configuração e atividades administrativas, as operações de alto nível criadas pelo Studio e pelo Director são listadas no painel central superior do Studio. Uma operação de alto nível resulta em uma ou mais chamadas de serviço e SDK, que são operações de baixo nível. Quando você seleciona uma operação de alto nível no painel superior, o painel inferior exibe as operações de nível baixo.
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 terá 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 todos os logs dos últimos cinco dias forem solicitados e houver um log com uma hora de início nos últimos cinco dias, mas não houver hora de término, ele será incluído.
Ao usar um script que chama cmdlets do PowerShell, se você criar uma operação de baixo nível sem especificar uma operação de alto nível pai, o log de configuração cria uma operação de alto nível substituta.
Para exibir o conteúdo do log de configuração, selecione Logging no painel de navegação do Studio. Por padrão, o 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.
- Filtre a exibição especificando um intervalo de dia, ou insira um texto na caixa Search. Para retornar à exibição padrão depois de usar a pesquisa, apague o texto na caixa Search.
Gerar relatórios
Você pode gerar relatórios CSV e HTML contendo dados do log de configuração.
- O relatório CSV contém todos os dados do log de um intervalo de tempo especificado. Os dados hierárquicos no banco de dados são dispostos em uma única tabela CSV. Nenhum aspecto dos dados tem precedência no arquivo. Nenhuma formatação é usada e não se pressupõe legibilidade humana. O arquivo (chamado MyReport) contém os dados em um formato universalmente consumível. Os arquivos CSV geralmente são usados para arquivamento de dados ou como fonte de dados para uma ferramenta de geração de relatórios ou manipulação de dados, como o Microsoft Excel.
- O relatório HTML fornece uma forma legível por humanos dos dados de log para um intervalo de tempo especificado. Ele fornece uma visualização estruturada e navegável para revisar as alterações. Um relatório HTML é composto por dois arquivos, denominados Summary e Details. O Summary lista operações de alto nível: quando cada operação ocorreu, por quem e o resultado. Clicar em um link Details ao lado de cada operação leva você às operações de baixo nível no arquivo Details, que fornece informações adicionais.
Para gerar um relatório de log de configuração, selecione Logging no painel de navegação do Studio e, em seguida, selecione Create custom report no painel Actions.
- Selecione o intervalo de datas para o relatório.
- Selecione o formato do relatório: CSV, HTML ou ambos.
- Navegue até o local onde você deseja salvar o relatório.
Excluir conteúdo do log de configuração
Para excluir o log de configuração, você deve ter certas permissões de administração delegada e do banco de dados do SQL Server.
-
Delegated administration: você deve ter uma função de administração delegada que permita que a configuração de implantação seja lida. A função Full Administrator tem essa permissão. Uma função personalizada deve ter Read Only ou Manage selecionado na categoria Other permissions.
Para criar um backup dos dados de log de configuração antes de excluí-los, a função personalizada também deve ter Read Only ou Manage selecionado na categoria Logging Permissions.
-
SQL Server database: você deve ter um login do SQL Server com permissão para excluir registros do banco de dados. Existem duas maneiras de fazer isso:
-
Use um login de banco de dados do SQL Server com uma função de servidor sysadmin, que permite executar qualquer atividade no servidor de banco de dados. Como alternativa, as funções de servidor
serveradminousetupadminpermitem que você execute operações de exclusão. -
Se a sua implantação exigir mais segurança, use um login de banco de dados não sysadmin mapeado para um usuário do banco de dados que tenha permissão para excluir registros do banco de dados.
- No SQL Server Management Studio, crie um login do SQL Server com uma função de servidor diferente de “sysadmin”.
- Mapeie o login para um usuário no banco de dados. O SQL Server cria automaticamente um usuário no banco de dados com o mesmo nome do login.
- Em Database role membership, especifique pelo menos um dos membros da função para o usuário do banco de dados:
ConfigurationLoggingSchema_ROLEoudbowner.
Para obter mais informações, consulte a documentação do SQL Server Management Studio.
-
Para excluir os logs de configuração:
- Selecione Logging no painel de navegação do Studio.
- Selecione Delete logs no painel Actions.
- Você é indagado se deseja criar um backup dos logs antes que eles sejam excluídos. Se você optar por criar um backup, navegue até o local onde o arquivo de backup é salvo. O backup é criado como um arquivo CSV.
Depois que os logs de configuração são eliminados, a exclusão do log é a primeira atividade lançada no log vazio. Essa entrada fornece detalhes sobre quem excluiu os logs e quando.