Serviços Citrix Insight
O Citrix Insight Services (CIS) é uma plataforma Citrix para instrumentação, telemetria e geração de insights de negócios. Seus recursos de instrumentação e telemetria permitem que usuários técnicos (clientes, parceiros e engenheiros) façam o autodiagnóstico e corrijam problemas e otimizem seus ambientes. Para obter detalhes e as informações mais recentes sobre o CIS e como ele funciona, consulte https://cis.citrix.com (credenciais de conta Citrix necessárias).
Todas as informações enviadas ao Citrix são usadas para fins de solução de problemas e diagnóstico, além de melhorar a qualidade, a confiabilidade e o desempenho dos produtos, sujeito a:
- Política de serviços do Citrix Insight em https://cis.citrix.com/legal
- Política de privacidade da Citrix em https://www.cloud.com/privacy-policy
Esta versão do Citrix Virtual Apps and Desktops oferece suporte às seguintes tecnologias.
- Instalação e atualização de análises do Citrix Virtual Apps and Desktops
- Programa de Melhoria da Experiência do Cliente Citrix (CEIP)
- Citrix Ligue para casa
- Citrix Escoteiro
Além (e separadamente) do CIS e do Citrix Analytics: o Google Analytics é coletado (e posteriormente carregado) automaticamente quando você instala (ou atualiza) o Studio. Após instalar o Studio, você pode alterar essa configuração com a chave de registro HKLM\Software\Citrix\DesktopStudio\GAEnabled. O valor 1 habilita a coleta e o upload, 0 desabilita a coleta e o upload.
Instalar e atualizar o Analytics
Quando você usa o instalador completo do produto para implantar ou atualizar componentes do Citrix Virtual Apps and Desktops, informações anônimas sobre o processo de instalação são coletadas e armazenadas na máquina onde você está instalando/atualizando o componente. Esses dados são usados para ajudar a Citrix a melhorar as experiências de instalação de seus clientes.
As informações são armazenadas localmente em %ProgramData%\Citrix\CTQs.
O upload automático desses dados é habilitado por padrão nas interfaces gráfica e de linha de comando do instalador completo do produto.
- Você pode alterar o valor padrão em uma configuração do registro. Se você alterar a configuração do registro antes de instalar/atualizar, esse valor será usado quando você usar o instalador completo do produto.
- Você pode substituir a configuração padrão se instalar/atualizar com a interface de linha de comando especificando uma opção com o comando.
Controle uploads automáticos:
-
Configuração do registro que controla o upload automático de análises de instalação/atualização (padrão = 1):
- Localização: HKLM:\Software\Citrix\MetaInstall
- Nome: SendExperienceMetrics
- Valor: 0 = desabilitado, 1 = habilitado
-
Usando o PowerShell, o seguinte cmdlet desabilita o upload automático de análises de instalação/atualização:
New-ItemProperty -Path HKLM:\SOFTWARE\Citrix\MetaInstall -Name SendExperienceMetrics -PropertyType DWORD -Value 0 <!--NeedCopy-->
-
Para desabilitar uploads automáticos com o comando XenDesktopServerSetup.exe ou XenDesktopVDASetup.exe, inclua a opção
/disableexperiencemetrics
.Para habilitar uploads automáticos com o comando XenDesktopServerSetup.exe ou XenDesktopVDASetup.exe, inclua a opção
/sendexperiencemetrics
.
Programa de Melhoria da Experiência do Cliente Citrix
Quando você participa do Programa de Melhoria da Experiência do Cliente (CEIP) da Citrix, estatísticas anônimas e informações de uso são enviadas à Citrix para ajudar a Citrix a melhorar a qualidade e o desempenho dos produtos Citrix. Para obter mais informações, consulte https://more.citrix.com/XD-CEIP.
Inscrição durante a criação ou atualização do site
Você é automaticamente inscrito no CEIP ao criar um Site (depois de instalar o primeiro Delivery Controller). O primeiro upload de dados ocorre aproximadamente sete dias após a criação do Site. Você pode interromper sua participação a qualquer momento após a criação do Site. Selecione o nó Configuração no painel de navegação do Studio (guiaSuporte ao produto ) e siga as orientações.
Ao atualizar uma implantação do Citrix Virtual Apps and Desktops:
- Se você atualizar de uma versão que não suportava o CEIP, será perguntado se você deseja participar.
- Se você atualizar de uma versão compatível com o CEIP e a participação estiver habilitada, o CEIP será habilitado no Site atualizado.
- Se você atualizar de uma versão compatível com o CEIP e a participação tiver sido desabilitada, o CEIP será desabilitado no Site atualizado.
- Se você atualizar de uma versão compatível com CEIP e a participação for desconhecida, será perguntado se você deseja participar.
As informações coletadas são anônimas, portanto, não podem ser visualizadas depois de carregadas no Citrix Insight Services.
Inscrição na instalação de um VDA
Por padrão, você é automaticamente inscrito no CEIP ao instalar um Windows VDA. Você pode alterar esse padrão em uma configuração de registro. Se você alterar a configuração do registro antes de instalar o VDA, esse valor será usado.
Configuração do registro que controla a inscrição automática no CEIP (padrão = 1):
Localização: HKLM: \Software\Citrix\Telemetry\CEIP Nome: Habilitado Valor: 0 = desabilitado, 1 = habilitado
Por padrão, a propriedade Habilitado
fica oculta no registro. Quando não especificado, o recurso de upload automático é habilitado.
Usando o PowerShell, o seguinte cmdlet desabilita o registro no CEIP:
New-ItemProperty -Path HKLM:\SOFTWARE\Citrix\Telemetry\CEIP -Name Enabled -PropertyType DWORD -Value 0
<!--NeedCopy-->
Os pontos de dados de tempo de execução coletados são gravados periodicamente como arquivos em uma pasta de saída (padrão %programdata%/Citrix/VdaCeip).
O primeiro upload de dados ocorre aproximadamente sete dias após a instalação do VDA.
Inscrição na instalação de outros produtos e componentes
Você também pode participar do CEIP ao instalar produtos, componentes e tecnologias Citrix relacionados, como Citrix Provisioning, AppDNA, Citrix License Server, aplicativo Citrix Workspace para Windows, Universal Print Server e Session Recording. Consulte a documentação para obter detalhes sobre os valores padrão de instalação e participação.
Citrix Ligue para casa
Ao instalar determinados componentes e recursos no Citrix Virtual Apps and Desktops, você tem a oportunidade de participar do Citrix Call Home. O Call Home coleta dados de diagnóstico e, periodicamente, carrega pacotes de telemetria contendo esses dados diretamente para o Citrix Insight Services (via HTTPS na porta padrão 443) para análise e solução de problemas.
No Citrix Virtual Apps and Desktops, o Call Home é executado como um serviço em segundo plano sob o nome Citrix Telemetry Service. Para obter mais informações, consulte https://more.citrix.com/XD-CALLHOME.
A funcionalidade de agendamento do Call Home também está disponível no Citrix Scout. Para obter detalhes, consulte Citrix Scout.
O que é coletado
O Citrix Diagnostic Facility (CDF) rastreia informações de logs que podem ser úteis para solução de problemas. O Call Home coleta um subconjunto de rastreamentos de CDF que podem ser úteis na solução de problemas de falhas comuns, por exemplo, registros de VDA e inicializações de aplicativos/desktop. Essa tecnologia é conhecida como rastreamento sempre ativo (AOT). Os logs AOT são salvos no disco em C:\Users\CitrixTelemetryService\Appdata\Local\CitrixAOT.
O Call Home não coleta nenhuma outra informação de Rastreamento de Eventos para Windows (ETW), nem pode ser configurado para fazer isso.
A Call Home também coleta outras informações, como:
- Registros criados pelo Citrix Virtual Apps and Desktops em
HKEY_LOCAL_MACHINE\SOFTWARE\Citrix
. - Informações do Windows Management Instrumentation (WMI) no namespace Citrix.
- Lista de processos em execução.
- Crash dumps de processos Citrix armazenados em %PROGRAM DATA%\Citrix\CDF.
- Informações sobre instalação e atualização. Isso pode incluir o log completo do metainstalador do produto, logs MSI com falhas, saída do analisador de log MSI, logs do StoreFront, logs de verificação de compatibilidade de licenciamento e resultados de testes preliminares de atualização do site.
As informações de rastreamento são compactadas à medida que são coletadas. O Citrix Telemetry Service retém no máximo 10 MB de informações de rastreamento recentes compactadas, com um limite de tempo máximo de oito dias.
- A compactação de dados permite que o Call Home mantenha uma pequena pegada no VDA.
- Os rastreamentos são mantidos na memória para evitar IOPs em máquinas provisionadas.
- O buffer de rastreamento usa um mecanismo circular para reter rastreamentos na memória.
O Call Home coleta os principais pontos de dados listados em Principais pontos de dados do Call Home.
Configurar e gerenciar resumo
Você pode se registrar no Call Home usando o assistente de instalação completo do produto ou posteriormente, usando cmdlets do PowerShell. Quando você se inscreve, por padrão, os diagnósticos são coletados e enviados ao Citrix todos os domingos, aproximadamente às 3h00, horário local. O upload é aleatório com um intervalo de duas horas a partir do horário especificado. Isso significa que um upload usando a programação padrão ocorre entre 3h e 5h.
Se não quiser carregar informações de diagnóstico de forma programada (ou se quiser alterar uma programação), você pode usar cmdlets do PowerShell para coletar e carregar diagnósticos manualmente ou armazená-los localmente.
Ao se inscrever em uploads agendados do Call Home e ao carregar manualmente informações de diagnóstico para a Citrix, você fornece credenciais da conta Citrix ou do Citrix Cloud. A Citrix troca as credenciais por um token de upload que é usado para identificar o cliente e carregar os dados. As credenciais não são salvas.
Quando ocorre um upload, uma notificação é enviada por e-mail para o endereço associado à conta Citrix.
Se você habilitar o Call Home ao instalar um componente, poderá desabilitá-lo mais tarde.
Pré-requisitos
- A máquina deve estar executando o PowerShell 3.0 ou posterior.
- O Citrix Telemetry Service deve estar em execução na máquina.
- A variável do sistema
PSModulePath
deve ser definida como o caminho de instalação do Telemetry, por exemplo, C:\Program Files\Citrix\Telemetry Service\.
Habilitar Call Home durante a instalação do componente
Durante a instalação ou atualização do VDA: Ao instalar ou atualizar um Virtual Delivery Agent usando a interface gráfica no instalador completo do produto, você será perguntado se deseja participar do Call Home. Existem duas opções:
- Participe do Call Home.
- Não participe do Call Home.
Se você estiver atualizando um VDA e já estiver inscrito no Call Home, essa página do assistente não aparecerá.
Durante a instalação ou atualização do Controlador: Quando você instala ou atualiza um Controlador de Entrega usando a interface gráfica, é perguntado se você deseja participar do Call Home. Existem três opções:
Ao instalar um Controlador, você não pode configurar informações na página Call Home no assistente de instalação se esse servidor tiver um GPO do Active Directory com a configuração de política “Fazer logon como um serviço” aplicada. Para mais detalhes, veja CTX218094.
Se você estiver atualizando um Controlador e já estiver inscrito no Call Home, não será perguntado sobre sua participação.
Cmdlets do PowerShell
A ajuda do PowerShell fornece uma sintaxe abrangente, incluindo descrições de cmdlets e parâmetros que não são usados nesses casos de uso comuns.
Para usar um servidor proxy para uploads, consulte Configurar um servidor proxy.
-
Habilitar uploads agendados: As coleções de diagnóstico são carregadas automaticamente no Citrix. Se você não inserir cmdlets adicionais para uma programação personalizada, a programação padrão será usada.
$cred = Get-Credential Enable-CitrixCallHome -Credential $cred <!--NeedCopy-->
Para confirmar se os uploads agendados estão habilitados, digite
Get-CitrixCallHome
. Se habilitado, o retorno éIsEnabled=True
eIsMasterImage=False
. -
Habilitar uploads agendados para máquinas criadas a partir de uma imagem mestre: Habilitar uploads agendados em uma imagem mestre elimina a necessidade de configurar cada máquina criada no catálogo de máquinas.
Enable-CitrixCallHome -Credential $cred -MasterImage
Para confirmar se os uploads agendados estão habilitados, digite Get-CitrixCallHome. Se habilitado, o retorno é
IsEnabled=True
eIsMasterImage=True
. -
Crie uma programação personalizada: Crie uma programação diária ou semanal para coletas e uploads de diagnóstico.
$timespan = New-TimeSpan –Hours hours -Minutes minutes Set-CitrixCallHomeSchedule –TimeOfDay $timespan –DayOfWeek day -UploadFrequency {Daily|Weekly} <!--NeedCopy-->
Exemplos:
O cmdlet a seguir cria uma programação para agrupar e carregar dados às 22h20 todas as noites. O parâmetro Horas usa um relógio de 24 horas. Quando o valor do parâmetro UploadFrequency
é Diário, o parâmetro DayOfWeek
é ignorado, se especificado.
$timespan – New-TimeSpan –Hours 22 –Minutes 20
Set-CitrixCallHomeSchedule –TimeOfDay $timespan -UploadFrequency Daily
<!--NeedCopy-->
Para confirmar o agendamento, digite Get-CitrixCallHomeSchedule
. No exemplo anterior, ele retorna StartTime=22:20:00, DayOfWeek=Sunday (ignorado), Upload Frequency=Daily
.
O cmdlet a seguir cria uma programação para agrupar e carregar dados às 22h20 todas as quartas-feiras.
$timespan – New-TimeSpan –Hours 22 –Minutes 20
Set-CitrixCallHomeSchedule –TimeOfDay $timespan –DayOfWeek Wed -UploadFrequency Weekly
<!--NeedCopy-->
Para confirmar o agendamento, digite Get-CitrixCallHomeSchedule
. No exemplo anterior, ele retorna StartTime=22:20:00, DayOfWeek=Wednesday, Upload Frequency=Weekly
.
Desativar chamada para casa
Você pode desabilitar o Call Home usando um cmdlet do PowerShell ou por meio do Citrix Scout.
Os logs AOT são coletados e salvos no disco, mesmo quando os uploads agendados do Call Home estão desabilitados. (Quando os uploads agendados são desabilitados, os logs AOT não são carregados automaticamente no Citrix.) Você pode desabilitar a coleta e o armazenamento local de logs AOT.
Desabilitar Call Home com PowerShell
Após executar o cmdlet a seguir, os dados de diagnóstico não serão carregados no Citrix automaticamente. (Você ainda pode carregar dados de diagnóstico usando o Citrix Scout ou os cmdlets do PowerShell de telemetria.)
Disable-CitrixCallHome
Para confirmar que o Call Home está desabilitado, digite Get-CitrixCallHome
. Se desabilitado, o retorno é IsEnabled=False
e IsMasterImage=False
.
Desabilitar uma programação de coleta usando o Citrix Scout
Para desabilitar um agendamento de coleta de diagnóstico usando o Citrix Scout, siga as orientações em Agendar coletas. Na etapa 3, clique em Desligado para cancelar a programação das máquinas selecionadas.
Desabilitar coleta de logs AOT
Após executar o seguinte cmdlet (com o campo Habilitado
definido como falso
), os logs AOT não serão coletados.
Enable-CitrixTrace -Listen‘{“trace”:{“enabled”:false,“persistDirectory”:“C:\Users\Public”,”maxSizeBytes”:1000000, “sliceDurationSeconds”:300}}’
O parâmetro Listen
contém argumentos no formato JSON.
Configurar um servidor proxy para uploads do Call Home
Conclua as seguintes tarefas na máquina onde o Call Home está habilitado. Os diagramas de exemplo no procedimento a seguir contêm o endereço do servidor e a porta 10.158.139.37:3128. Suas informações serão diferentes.
-
Adicione informações do servidor proxy no seu navegador. No Internet Explorer, selecione Opções da Internet > Conexões > Configurações de LAN. Selecione Usar um servidor proxy para sua LAN” e insira o endereço do servidor proxy e o número da porta.
-
No PowerShell, execute
netsh winhttp import proxy source=ie
. -
Usando um editor de texto, edite o arquivo de configuração TelemetryService.exe, que está localizado em C:\Program Files\Citrix\Telemetry Service. Adicione as informações mostradas na caixa vermelha.
-
Reinicie o Serviço de Telemetria.
Execute os cmdlets Call Home no PowerShell.
Coletar e carregar manualmente informações de diagnóstico
Você pode usar o site do CIS para enviar um pacote de informações de diagnóstico para o CIS. Você também pode usar cmdlets do PowerShell para coletar e carregar informações de diagnóstico no CIS.
Para fazer upload de um pacote usando o site do CIS:
- Faça login no Citrix Insight Services usando as credenciais da sua conta Citrix.
- Selecione Meu Espaço de Trabalho.
- Selecione Healthcheck e navegue até o local dos seus dados.
O CIS oferece suporte a vários cmdlets do PowerShell que gerenciam uploads de dados. Esta documentação abrange os cmdlets para dois casos comuns:
- Use o cmdlet
Start-CitrixCallHomeUpload
para coletar e carregar manualmente um pacote de informações de diagnóstico no CIS. (O pacote não é salvo localmente.) - Use o cmdlet
Start-CitrixCallHomeUpload
para coletar dados manualmente e armazenar um pacote de informações de diagnóstico localmente. Isso permite que você visualize os dados. Mais tarde, use o cmdletSend-CitrixCallHomeBundle
para carregar manualmente uma cópia desse pacote no CIS. (Os dados que você salvou originalmente permanecem localmente.)
A ajuda do PowerShell fornece uma sintaxe abrangente, incluindo descrições de cmdlets e parâmetros que não são usados nesses casos de uso comuns.
Ao inserir um cmdlet para carregar dados no CIS, você será solicitado a confirmar o carregamento. Se o tempo limite do cmdlet expirar antes da conclusão do upload, verifique o status do upload no log de eventos do sistema. A solicitação de upload pode ser rejeitada se o serviço já estiver executando um upload.
Coletar dados e enviar o pacote para o CIS:
Start-CitrixCallHomeUpload [-Credential] PSCredential [-InputPath string] [-Description string] [-IncidentTime string] [-SRNumber string] [-Name string] [-UploadHeader string] [-AppendHeaders string] [-Collect string] [<CommonParameters>]
<!--NeedCopy-->
Colete dados e salve-os localmente:
Start-CitrixCallHomeUpload -OutputPath <String> [-InputPath string] [-Description string] [-IncidentTime string] [-SRNumber string] [-Name string] [-UploaderHeader string] [-AppendHeaders string] [-Collect strings] [<CommonParameters>]
<!--NeedCopy-->
Os seguintes parâmetros são válidos:
- Credencial: Direciona o upload para o CIS.
- InputPath: Localização do arquivo zip a ser incluído no pacote. Este pode ser um arquivo adicional solicitado pelo Suporte da Citrix. Não se esqueça de incluir a extensão .zip.
- OutputPath: Local onde as informações de diagnóstico são salvas. Este parâmetro é necessário ao salvar dados do Call Home localmente.
- Descrição e hora do incidente: Informações de formato livre sobre o upload.
- SRNumber: Número do incidente do Suporte Técnico da Citrix.
- Nome: Nome que identifica o pacote.
- UploadHeader: String no formato JSON especificando os cabeçalhos de upload enviados para o CIS.
- AppendHeaders: String no formato JSON especificando os cabeçalhos anexados enviados ao CIS.
-
Coletar: string em formato JSON especificando quais dados coletar ou omitir, no formato {‘coletor’:{‘enabled’:Boolean}}, onde Boolean é verdadeiro ou falso. Os valores válidos do coletor são:
- ‘wmi’
- ‘processo’
- ‘registro
- ‘relatório de acidente’
- ‘traço’
- ‘arquivo’
- ‘msi’
- ‘dados locais’
- ‘dados do site’
- ‘sfb’
Por padrão, todos os coletores, exceto ‘sfb’, estão habilitados.
O coletor ‘sfb’ foi projetado para ser usado sob demanda para diagnosticar problemas do Skype for Business. Além do parâmetro ‘enabled’, o coletor ‘sfb’ suporta os parâmetros ‘account’ e ‘accounts’ para especificar usuários de destino. Utilize um dos formulários:
- “-Coletar “{‘sfb’:{‘conta’:’domínio\\usuário1’}}”
- “-Coletar “{‘sfb’:{‘contas’:[‘domínio\\usuário1’, ‘domínio\\usuário2’]}}”
- Parâmetros comuns: Veja a ajuda do PowerShell.
Carregar dados que foram salvos localmente anteriormente:
Send-CitrixCallHomeBundle -Credential <PSCredentia\> -Path string [<CommonParameters>]
O parâmetro Caminho
especifica o local do pacote salvo anteriormente.
Exemplos:
O cmdlet a seguir solicita um upload de dados do Call Home (excluindo dados do coletor WMI) para o CIS. Esses dados estão relacionados a falhas de registro de VDAs de provisionamento da Citrix, que foram observadas às 14h30 para o caso de suporte da Citrix 123456. Além dos dados do Call Home, o arquivo “c:\Diagnostics\ExtraData.zip” é incorporado ao pacote carregado.
C:\PS\>Start-CitrixCallHomeUpload -InputPath "c:\Diagnostics\ExtraData.zip" -Description "Registration failures with Citrix Provisioning VDAs" -IncidentTime "14:30" -SRNumber 123456 -Name "RegistrationFailure-021812016" -Collect "{'wmi':{'enabled':false}}" -UploadHeader "{'key1':'value1'}" -AppendHeaders "{'key2':'value2'}"
<!--NeedCopy-->
O cmdlet a seguir salva dados do Call Home relacionados ao caso de suporte da Citrix 223344, registrado às 8h15. Os dados são salvos no arquivo mydata.zip em um compartilhamento de rede. Além dos dados do Call Home, o arquivo “c:\Diagnostics\ExtraData.zip” será incorporado ao pacote salvo.
C:\PS\>Start-CitrixCallHomeUpload -OutputPath \\mynetwork\myshare\mydata.zip -InputPath "c:\Diagnostics\ExtraData.zip" -Description "Diagnostics for incident number 223344" -IncidentTime "8:15" -SRNumber 223344
<!--NeedCopy-->
O cmdlet a seguir carrega o pacote de dados que você salvou anteriormente.
$cred=Get-Credential
C:\PS>Send-CitrixCallHomeBundle –Credential $cred -Path \\mynetwork\myshare\mydata.zip
<!--NeedCopy-->