Ir para conteúdo principal Pular para conteúdo complementar

Configurando e solucionando problemas do Qlik Data Gateway - Acesso direto

Este tópico descreve várias ações que você pode executar para configurar e solucionar problemas do Direct Access gateway.

Nota informativaTodas as opções de configuração descritas neste tópico também podem ser realizadas por meio da API pública do Direct Access gateway. Para obter mais informações, consulte https://qlik.dev/apis/rest/direct-access-agents/

Configurando o Direct Access gateway a partir do seu locatário do Qlik Cloud

Embora as configurações padrão do Direct Access gateway sejam apropriadas para a maioria dos ambientes, pode ser necessário substituí-las para melhorar o desempenho, solucionar um problema (por meio das configurações de registro) ou superar vários problemas de conectividade.

Nota informativa
  • A configuração do Direct Access gateway no Qlik Cloud é compatível com a versão 1.7.2 ou posterior, embora seja recomendável atualizar para a versão mais recente para aproveitar o conjunto completo de opções de configuração.

  • Embora a maioria das configurações do Direct Access gateway possa ser configurada no centro de atividades do Qlik Cloud ou do Administração, algumas configurações só podem ser alteradas com a edição dos arquivos de configuração diretamente na máquina do Direct Access gateway

Para poder editar as configurações no Qlik Cloud, é necessário ter uma das seguintes permissões:

  • Administrador de locatários e proprietário do espaço do gateway

  • Membro locatário com Pode consumir dados no espaço do gateway

Para abrir as configurações do gateway:

  1. Em seu locatário do Qlik Cloud, navegue até Administração > Gateways de dados e localize seu Direct Access gateway.

  2. Clique na Mais no final da linha e selecione Configurações do gateway.

    O diálogo Configurações de gateway para <nome> é aberto.

    As configurações são divididas em configurações gerais (abaixo) e configurações do conector. Observe que a alteração das configurações também pode exigir que você reinicie o serviço do Direct Access gateway.

Configurações gerais

Essas configurações são relevantes para a funcionalidade geral do Direct Access gateway, independentemente do conector que você estiver usando.

ID do agente

O ID do agente a ser usado com a API pública do Direct Access gateway.

Porta do agente do Conector

A porta a ser usada ao conectar-se ao agente do conector. Essa configuração não pode ser alterada.

Limite de falha de integridade do agente do conector

Verificações periódicas de integridade são realizadas nos componentes do Direct Access gateway. Às vezes, as verificações de integridade falham inicialmente e depois são bem-sucedidas. Se as verificações de integridade continuarem falhando após o limite especificado, o serviço do Direct Access gateway será reiniciado. Você só deve alterar essa configuração se for solicitado pelo Suporte Qlik.

Tempo limite da solicitação de carga

Quando ocorrem interrupções de rede, as recargas podem falhar com os seguintes erros:

Connector error: The session does not exist (DirectAccess-1509)

Connector error: The stream session expired for the load data request (DirectAccess-1012)

Se você encontrar frequentemente os erros acima, tente estender o tempo limite para 5 a 10 minutos.

Nível de registro em log do agente do conector

Para fins de solução de problemas, talvez seja necessário alterar o nível de registro dos componentes do agente do conector. Você só deve alterar essa configuração se for solicitado pelo Suporte Qlik.

Opções de registro em log do agente do conector

Para solucionar problemas com um componente específico do agente do conector, talvez seja necessário selecionar o arquivo de log correspondente. Você só deve alterar essa configuração se for solicitado pelo Suporte Qlik.

Memória para blocos de dados em cache

Para cada operação de recarga, o Direct Access gateway pode armazenar em cache dados na memória e descarregá-los no disco (quando o tamanho alocado para o armazenamento em cache for excedido). Isso é especialmente útil se você não usa a recuperação automática e frequentemente encontra erros 4025, 4020 e 4021. Quando o threshold especificado for atingido, o gateway descarregará os próximos pedaços criptografados no disco da máquina do Direct Access gateway.

Limite de duração da recuperação de blocos

Este é o limite (em minutos) para a duração da recuperação de blocos. Se o recarregamento não tiver sido retomado até o momento em que o threshold de duração da recuperação for atingido, ele falhará com uma mensagem apropriada.

Essa opção é útil para recargas que, de outra forma, poderiam exceder o limite de três horas, após uma longa recuperação. Por exemplo, digamos que você leve 90 minutos para recuperar os dados do banco de dados, mas, assim que a recarga começa, um dos blocos é corrompido. Nesse caso, todos os blocos serão armazenados no cache e enviados do cache. Nesse cenário, todo o processo de recarga (armazenamento no cache + recarga real) pode levar três horas para ser concluído.

Porta DCaaS

A porta a ser usada ao se conectar-se ao DCaaS. Essa configuração não pode ser alterada.

Nível de registro em log do DCaaS

Para fins de solução de problemas, talvez seja necessário alterar o nível de registro dos logs do DCaaS. Você só deve alterar essa configuração se for solicitado pelo Suporte Qlik.

Configurações do conector

Para alterar as configurações do conector, selecione o tipo de conector à esquerda e, em seguida, altere as configurações conforme necessário.

Porta

A porta a ser usada na conexão com a fonte de dados. Essa configuração não pode ser alterada.

Nível de registro em log

Para fins de solução de problemas, talvez seja necessário alterar o nível de registro dos logs do conector. Você só deve alterar essa configuração se for solicitado pelo Suporte Qlik.

Isolamento do processo

Nota informativa

Requer o Direct Access gateway 1.6.1 ou mais recente.

O isolamento de processos permite que administradores com acesso ao sistema operacional do servidor do Direct Access gateway controlem quantos processos estão disponíveis para recargas e/ou comandos de metadados por tipo de conector. A distribuição dos comandos de recarga e/ou metadados por vários processos de conector aumenta o nível de isolamento, reduzindo o número de comandos de recarga e/ou metadados executados simultaneamente em cada processo de conector. Isso, por sua vez, pode melhorar a estabilidade geral do Direct Access gateway nos casos em que ocorreram falhas no conector.

Com uma instalação limpa, o isolamento do processo é habilitado por padrão. O número padrão de recarregamentos/ou comandos de metadados simultâneos para cada tipo de conector é 9. Você pode alterar o padrão conforme descrito em Número de processos de recarregamento/comando simultâneos abaixo.

Estão disponíveis as seguintes opções:

  • Desabilitado: O Suporte Qlik poderá solicitar que você desabilite o isolamento do processo para fins de solução de problemas.

  • Metadados: Habilitar isolamento de processos apenas para comandos de metadados. Isso pode ser útil, por exemplo, para clientes com drivers ODBC que não suportam multi-threading, mas que desejam executar comandos de metadados simultaneamente (principalmente para fins de visualização).

    Nota informativaCom suporte a partir do Direct Access gateway 1.7.9.
  • Recarga (padrão): Habilitar isolamento de processos apenas para comandos de recarga.

  • Tudo: Habilitar isolamento de processos para comandos de recarga e metadados.

    Nota informativaCom suporte a partir do Direct Access gateway 1.7.9.

Número de processos de recarga simultânea/comando

O número de processos de recarga simultânea/comando alocados para o conector, incluindo o processo de comando. Assim, por exemplo, um valor 30 significaria um máximo de 29 recargas simultâneas/comandos. Observe que essa configuração só é relevante quando o isolamento do processo está habilitado.

Nota informativaA partir da Direct Access gateway versão 1.6.7, esse valor pode exceder 10 sem a necessidade de alterar outras configurações. Para isolar completamente as recargas com um tipo de conector específico (ou seja, não mais do que uma recarga por processo de conector), esse valor deve ser definido como um mínimo de 30, mas pode ser necessário defini-lo como um valor tão alto quanto 60, dependendo da carga de trabalho.

Vida útil da sessão de recarga

Nota informativaRelevante apenas para o conector ODBC (via Direct Access gateway).

Se a conexão entre o Direct Access gateway e o Qlik Cloud estiver ociosa por 20 segundos ou mais, a operação de recarregamento poderá falhar com o seguinte erro:

Invalid object name '#<TempTableName>' (indicating that the Direct Access gateway temp tables are unavailable).

A duração padrão da sessão é de 20 segundos, mas se esse erro ocorrer com frequência, você poderá estender a duração da sessão conforme necessário.

Número máximo de tabelas para descarregar

Nota informativa
  • Relevante apenas para o conector ODBC (via Direct Access gateway).

  • Requer Direct Access gateway 1.7.1 ou mais recente.

Por padrão, no máximo 10.000 tabelas são recuperadas do banco de dados. Você pode substituir o padrão quando seu banco de dados tiver mais de 10.000 tabelas.

Limitando as URLs que o Direct Access gateway pode acessar usando o conector REST

Você pode limitar o acesso a URLs específicas ou caminhos de URL que podem ser acessados com o conector REST.

Nota informativaQuaisquer alterações que você fizer (adicionar, editar ou excluir URLs) só entrarão em vigor após a reinicialização do serviço Direct Access gateway.

Para limitar o acesso a uma URL específica, insira a URL no campo URLs permitidas e clique em Adicionar. Faça o mesmo para limitar o acesso a um caminho de URL, mas adicione um asterisco (*) à URL. Repita conforme necessário.

No exemplo a seguir, a lista URLs permitidas contém duas entradas:

  • A primeira entrada permite acesso apenas a https://mypublicrestservice.com/restricted/source.

  • A segunda entrada permite acesso a https://mypublicrestservice.com/open e a qualquer caminho abaixo dela, como https://mypublicrestservice.com/open/shared

Para editar uma URL, clique no botão no final da linha e edite a URL conforme desejado. Em seguida, clique em para salvar suas alterações ou em para cancelar.

Para excluir um URL, clique no botão no final da linha.

Consulte também: Criar uma conexão REST (somente em inglês).

Limitando os caminhos que o Direct Access gateway pode acessar usando o conector de Arquivo

Você pode limitar o acesso aos caminhos que podem ser acessados com o conector de Arquivo. Você também pode emparelhar um caminho com um ou mais espaços para restringir ainda mais o acesso ao caminho especificado.

Nota informativa
  • Espaços emparelhados são aceitos a partir do Direct Access gateway 1.7.6.

  • Ao usar o Direct Access gateway 1.7.4 ou 1.7.5, quaisquer alterações feitas (adicionar, editar ou excluir caminhos ou espaços) só entrarão em vigor após a reinicialização do serviço Direct Access gateway.

  • Somente usuários com a função Pode consumir dados ou superior (Pode editar, Pode editar dados em aplicativos, Pode gerenciar) poderão acessar os caminhos.

  • Todos os sistemas de arquivos Windows e unidades de rede são suportados, incluindo caminhos DOS padrão e caminhos UNC.

Para limitar o acesso a um caminho específico, insira o caminho no campo Caminhos de arquivo e clique em Adicionar. Repita conforme necessário.

Para emparelhar um espaço com um caminho, depois de adicionar o caminho, clique no botão no final da linha e selecione um ou mais espaços na lista suspensa na coluna Espaços emparelhados . Se um caminho for emparelhado com espaços, somente usuários que pertencem a pelo menos um dos espaços poderão acessar o caminho especificado. Note que os membros dos espaços especificados poderão acessar o caminho a partir de qualquer espaço ao qual pertençam (mesmo que não esteja explicitamente definido), incluindo seu espaço pessoal.

No exemplo a seguir, a lista Caminhos de arquivo contém duas entradas:

  • A primeira entrada permite que qualquer usuário com a função necessária acesse C:\mypath\source.

  • A segunda entrada permite apenas que membros do espaço mosheSharedSpace acessem C:\restricted.

Para editar uma entrada, clique no botão no final da linha e edite a entrada como desejar. Em seguida, clique em para salvar as alterações ou em para desfazer as alterações.

Para excluir uma entrada, clique no botão no final da linha.

Consulte também: Arquivo (via Direct Access gateway) (somente em inglês).

Reiniciando o Direct Access gateway após alterar as configurações

Algumas configurações só serão aplicadas depois que o serviço do Direct Access gateway for reiniciado. Nesse caso, você será solicitado a reiniciar o serviço quando salvar as configurações. Se houver recargas ativas, você não poderá reiniciar o serviço até que elas sejam concluídas. Quando não houver recargas ativas, você pode reiniciar o serviço a qualquer momento, conforme a seguir:

  1. Em seu locatário do Qlik Cloud, navegue até Administração > Gateways de dados e localize seu Direct Access gateway.

  2. Clique na Mais no final da linha e selecione Reiniciar serviço.

Você também pode reiniciar o serviço diretamente na máquina do Direct Access gateway, conforme descrito em Iniciando, interrompendo ou reiniciando o serviço

Configurando o Direct Access gateway diretamente na máquina do Direct Access gateway

Embora a maioria das configurações do Direct Access gateway possa ser configurada no Qlik Cloud, algumas configurações só podem ser alteradas editando os arquivos de configuração diretamente na máquina do Direct Access gateway.

Substituindo o diretório de cache de blocos padrão

Nota informativaRequer Direct Access gateway 1.7.1 ou mais recente.

Para cada operação de recarga, o Direct Access gateway pode armazenar em cache dados na memória e descarregá-los no disco (quando o tamanho alocado para o armazenamento em cache for excedido). Você pode substituir o diretório padrão do cache de blocos (C:\ProgramData\Qlik\Gateway\tmp) se não tiver espaço suficiente em disco na unidade do sistema.

Nota informativaPara garantir a estabilidade e otimizar o desempenho, a prática recomendada é usar apenas caminhos locais.

Para fazer:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado.
  2. Localize a propriedade OVERRIDE_CHUNKS_CACHE_DIR e defina-a como o diretório de sua escolha.

    Exemplo:

    OVERRIDE_CHUNKS_CACHE_DIR=C:\tmp

    Nota informativaNão coloque o caminho entre aspas.
  3. Salve o arquivo configuration.properties e reinicie o serviço Qlik Data Gateway - Acesso direto.

Consulte também: Memória para blocos de dados em cache

Substituindo o tipo de dados padrão do Qlik Cloud ao trabalhar com o conector ODBC (via Direct Access gateway)

Nota informativaRequer Direct Access gateway 1.7.1 ou mais recente.

Às vezes, devido a um problema com o tratamento dos tipos de dados da fonte pelo driver ODBC do fornecedor, ocorrerá um erro durante o recarregamento ou serão carregados dados incorretos em Qlik Cloud. Nesses casos, você pode substituir o tipo de dados Qlik Cloud ou sua especificação (escala ou precisão, por exemplo).

Nota de advertênciaEmbora muitos problemas possam ser resolvidos com a simples alteração de QlikDataType para String, se não for possível fazer isso, recomendamos entrar em contato com o Suporte Qlik para obter orientação sobre os tipos de dados do Qlik Cloud para os quais o tipo de dados da fonte pode ser mapeado.

Para fazer:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\custom_type_mappings.json como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado. Esse arquivo contém um exemplo de fonte de dados para os tipos de dados do Qlik Cloud.
  2. Adicione uma seção que mapeia o tipo de dados problemático para o tipo de dados desejado do Qlik Cloud.

    No exemplo a seguir (que está incluído no arquivo custom_type_mappings.json), o cliente precisa alterar o tamanho do tipo de dados do Qlik Cloud DateTime em 27.

     

    Exemplo:

    {
    "Identifier": "Amazon Athena ODBC (x64)",
    "NativeDataType": "timestamp with time zone",
    "QlikDataType": "DateTime",
    "Size": 27,
    "IsBit": false
    }

  3. Salve o arquivo custom_type_mappings.json e reinicie o serviço Qlik Data Gateway - Acesso direto.
  4. Recarregue os dados.

Forçando o Direct Access gateway a se reconectar ao Qlik Cloud

Por padrão, se o Direct Access gateway for desconectado do Qlik Cloud, ele deverá se reconectar após 45 segundos. Se você perceber que está demorando muito mais, pode forçar o gateway a se reconectar mais cedo.

Para fazer:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado. Esse arquivo contém um exemplo de fonte de dados para os tipos de dados do Qlik Cloud.
  2. Adicione AGENT_PONG_TIMEOUT_SECONDS=<time-in-seconds> à seção # Connector Agent no início do arquivo.

    AGENT_PONG_TIMEOUT_SECONDS=30

    Nota informativaO tempo mínimo é de 30 segundos.
  3. Salve o arquivo configuration.properties e reinicie o serviço Qlik Data Gateway - Acesso direto.

Executando solicitações de carga de dados de forma assíncrona

Nota informativa

Requer o Direct Access gateway 1.7.5 ou posterior.

A execução da solicitação de carga de dados de forma assíncrona no agente reduz significativamente o tempo que o serviço em nuvem precisa esperar pelas respostas do agente.

Para ativar as solicitações assíncronas de carga de dados:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado.
  2. Adicione a linha a seguir ao arquivo, se ela ainda não existir:

    OPTIONAL_CAPABILITIES=AsyncLoadDataRequest

    Se OPTIONAL_CAPABILITIES= já existir com outro parâmetro (AsyncLoadSlotRequest, por exemplo), basta anexá-lo ao parâmetro existente, separado por uma vírgula sem espaço.

    OPTIONAL_CAPABILITIES=AsyncLoadSlotRequest,AsyncLoadDataRequest

  3. Salve o arquivo configuration.properties.
Nota de dicaAs alterações são capturadas na próxima recarga, portanto, não é necessário reiniciar o serviço do Direct Access gateway. Todas as alterações serão registradas no arquivo connector-agent_logs_[date].txt .

Para desativar as solicitações assíncronas de carga de dados:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado.
  2. Defina OPTIONAL_CAPABILITIES=None, ou simplesmente exclua AsyncLoadDataRequest se houver outros parâmetros OPTIONAL_CAPABILITIES.

  3. Salve o arquivo configuration.properties.

Solicitando slots de carga de forma assíncrona

Nota informativa

Requer o Direct Access gateway 1.7.7 ou mais recente.

A solicitação de slots de carga de forma assíncrona alivia o congestionamento temporário do canal de comando para o Direct Access gateway durante a criação do WebSocket de dados de recarga para o Qlik Cloud. Isso pode ser útil ao realizar um número considerável de recargas simultâneas.

Nota informativaVocê só deve habilitar esse recurso se for instruído pelo Suporte Qlik.

Para habilitar solicitações de slot de carga assíncronas:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado.
  2. Adicione a linha a seguir ao arquivo, se ela ainda não existir:

    OPTIONAL_CAPABILITIES=AsyncLoadSlotRequest

    Se OPTIONAL_CAPABILITIES= já existir com outro parâmetro (AsyncLoadDataRequest , por exemplo), basta anexá-lo ao parâmetro existente, separado por uma vírgula sem espaço:

    OPTIONAL_CAPABILITIES=AsyncLoadDataRequest,AsyncLoadSlotRequest

  3. Salve o arquivo configuration.properties.
Nota de dicaAs alterações são capturadas na próxima recarga, portanto, não é necessário reiniciar o serviço do Direct Access gateway. Todas as alterações serão registradas no arquivo connector-agent_logs_[date].txt .

Para desabilitar solicitações de slot de carga assíncronas:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado.
  2. Defina OPTIONAL_CAPABILITIES=None, ou simplesmente exclua AsyncLoadSlotRequest se houver outros parâmetros OPTIONAL_CAPABILITIES.

  3. Salve o arquivo configuration.properties.

Configurando a inicialização do conector

Você pode aumentar o valor do tempo limite e o número de tentativas de inicialização do conector. Isso pode ser útil ao realizar um número considerável de recargas simultâneas. Aumentar esses parâmetros dará ao Direct Access gateway mais tempo e tentativas para executar o conector antes de sair com falha e exigir uma reinicialização.

Nota informativaVocê só deve habilitar esse recurso se for instruído pelo Suporte Qlik.
Nota informativa

Requer o Direct Access gateway 1.7.7 ou mais recente.

Para ajustar os parâmetros de inicialização do conector:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado.
  2. Adicione as seguintes linhas ao arquivo:

    # CONNECTOR STARTUP TIMEOUT between 30 and 120 seconds

    CONNECTOR_STARTUP_TIMEOUT_SECONDS=your-value

    # CONNECTOR STARTUP MAX ATTEMPTS between 1 and 5

    CONNECTOR_STARTUP_MAX_ATTEMPTS=your-value

    Nota informativa Para evitar congestionamento do pipe de comando, o ajuste desses valores requer que AsyncLoadDataRequest esteja habilitado, conforme descrito em Solicitando slots de carga de forma assíncrona acima. Essas configurações retornarão aos valores fixos de 30 e 3, respectivamente, quando AsyncLoadSlotRequest estiver desabilitado.
  3. Salve o arquivo configuration.properties.

Substituindo a porta inicial padrão definida pelo isolamento de processo

Quando o isolamento de processo está ativado, agora você pode substituir a porta inicial padrão (49152) que o Direct Access gateway usa para comunicação entre processos com todos os processos de conector isolados. Isso pode ser útil quando a porta padrão está em uso por outro processo.

Nota informativa
  • Você só deve habilitar esse recurso se for instruído pelo Suporte Qlik.

  • Requer o Direct Access gateway 1.7.8 ou mais recente.

  • Esta capacidade também é compatível com a API Pública.

Para fazer:

  1. Usando um editor de texto, abra C:\ProgramData\Qlik\Gateway\configuration.properties como admin. Se você estiver fazendo isso por meio do Windows Explorer, certifique-se de que Mostrar> Itens ocultos esteja selecionado.
  2. Na seção # Connector Agent, adicione a seguinte linha ao arquivo:

    DATA_PORT_RANGE_START=port-value

    onde port-value é a porta de início padrão.

  3. Salve o arquivo configuration.properties e reinicie o serviço Qlik Data Gateway - Acesso direto.

Aumentando os detalhes da mensagem de erro ao se conectar a fontes de dados ODBC

Devido a questões de segurança, a mensagem de erro padrão retornada pelo driver ODBC contém informações mínimas. No entanto, em determinados cenários, você pode precisar de mais informações para solucionar um problema específico. Para obter uma mensagem de erro mais detalhada, adicione a propriedade ShowErrorDetailMessage à seção Avançado no diálogo do conector e defina-a como True. Depois que você tiver resolvido o problema, para otimizar a segurança, é altamente recomendável excluir a propriedade ou defini-la como False.

Coletor de métricas

Em um ambiente típico de cliente, inúmeras recargas de dados passam pelo Direct Access gateway para o Qlik Cloud Analytics diariamente. A capacidade de registrar e monitorar o consumo e a utilização de recursos impactados por essas recargas ajudará os clientes a planejar suas recargas de acordo.

O novo coletor de métricas (que é executado em segundo plano na máquina do Direct Access gateway) oferece registro e monitoramento básicos da utilização de recursos pelo Direct Access gateway, conectores e o sistema operacional. O coletor de métricas pode ser configurado localmente em um arquivo JSON ou por meio da API pública.

Configurando o coletor de métricas

Na máquina do Direct Access gateway, abra o seguinte arquivo e configure-o conforme necessário:

<INSTALL_DIR>\ConnectorAgent\MetricsCollector\metricscollectorsettings.json

Configurando as configurações do coletor (MetricsCollectorSettings)

  • Enabled: defina como true (padrão) para habilitar a coleta de métricas ou false para desabilitá-la.

  • BaseScrapeIntervalSeconds: com que frequência pesquisar por métricas do conector em segundos. Cada conector tem seu próprio intervalo de pesquisa.

  • Port: a porta usada pela API ou conector de métricas (REST via Direct Access gateway).

  • LocalDataRetentionDays: dados com mais do que o valor especificado serão excluídos do banco de dados local.

  • DataRetentionCheckIntervalMinutes: a frequência da verificação de retenção.

  • LocalDatabaseFileLocation: a localização do banco de dados local. Também pode ser um caminho UNC. O local padrão é C:\ProgramData\Qlik\Gateway\tmp.

Definindo as configurações do conector (ConnectorConfigurations)

Para todos os conectores do Direct Access gateway, você pode definir o intervalo de sondagem de métricas (ScrapeIntervalSeconds) e habilitar (true) ou desabilitar (false) a coleta de métricas.

Exemplo de arquivo metricscollectorsettings.json

{
  "MetricsCollectorSettings": {
    "Enabled": true,
    "BaseScrapeIntervalSeconds": 1,
    "Port": 5052,
    "LocalDataRetentionDays": 30,
    "DataRetentionCheckIntervalMinutes": 60,
    "LocalDatabaseFileLocation": ""
  },
  "ConnectorConfigurations": {
    "OdbcConnector": {
      "MetricsCollectionEnabled": true,
      "ScrapeIntervalSeconds": 30
    },
    "SystemMetrics": {
      "MetricsCollectionEnabled": true,
      "ScrapeIntervalSeconds": 30
    },
    "ConnectorAgent": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "RestConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "SapSqlConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "SapBwConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "SapPackageConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "FileConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    }
  }
}

Carregando métricas

Use o conector REST (via Direct Access gateway) para coletar as métricas da máquina do Direct Access gateway.

Para fazer:

  1. Nas configurações de conexão REST (via Direct Access gateway), habilite Permitir trabalhar com conexão localhost.

    Para obter detalhes, consulte Criar uma conexão REST (somente em inglês).

  2. Adicione http://localhost:5052/api/metrics à lista de URLs permitidas.

    Consulte Limitando as URLs que o Direct Access gateway pode acessar usando o conector REST acima.

  3. Reinicie o serviço do Direct Access gateway.

  4. Crie um aplicativo e carregue as métricas de http://localhost:5052/api/metrics via conexão REST (via Direct Access gateway).

Métricas compatíveis

  • Métricas do sistema:

    • network_bytes_sent_total: o número total de bytes transmitidos através do Direct Access gateway desde que o sistema foi iniciado

    • network_bytes_received_total: O número total de bytes recebidos através do Direct Access gateway desde que o sistema foi iniciado

  • Métricas do conector:

    • process_start_time_seconds: tempo decorrido desde o início do processo em segundos.

    • process_cpu_seconds_total: o número cumulativo de segundos que uma CPU esteve em um estado específico

    • process_virtual_memory_bytes: o tamanho atual, em bytes, da memória virtual consumida pelo processo.

    • process_working_set_bytes: O tamanho atual, em bytes, do conjunto de trabalho do processo.

    • process_private_memory_bytes: o tamanho atual, em bytes, da memória privada consumida pelo processo.

    • process_num_threads: O número de threads usados pelo processo.

Visualizando e fazendo download de arquivos de log

Os arquivos de log fornecem informações sobre as operações do Direct Access gateway. Qlik O suporte pode solicitar que você forneça arquivos de log para fins de solução de problemas. Você pode visualizar ou baixar os arquivos de log no visualizador de log. Em circunstâncias normais, não há motivo para examinar os arquivos de log, mas se você tiver falhas repetidas ou outros problemas, os arquivos de log geralmente ajudarão a identificar a causa.

Nota informativaA visualização e o download dos logs exigem a função Pode consumir dados.

Para abrir o visualizador de log:

  1. No centro de atividades de Administração, acesse Gateways de dados e localize seu Direct Access gateway.

  2. Clique no Mais no final da linha e selecione Exibir logs.

    A janela Visualizador de log é aberta.

  3. Na lista suspensa no canto superior esquerdo, escolha o tipo de log que o Suporte Qlik solicitou que você visualizasse ou baixasse.

    Os seguintes registros estão disponíveis:

    • Logs do Direct Access gateway (DirectAccessAgent)
    • Logs do DCaaS (dcaas_logs)
    • Logs do conector baseado em ODBC (odbc-connector_logs)
    • Logs do conector do SAP BW (QvSAPBwConnector-<data + carimbo de data/hora>)
    • Logs do conector do SAP SQL (QvSqlBwConnector-<data + carimbo de data/hora)
    • Logs do agente do conector (connector-agent_logs_<date>)

    • Logs dos conectores SAP ODP e SAP Report (QvSapConnectorPackage-<process_id>)

    • Logs do conector REST (rest-connector_logs_<timestamp>)

    • Logs do conector de arquivo (file-connector_logs_<timestamp>)

    Nota informativaA partir do Direct Access gateway 1.7.1, os eventos de início, saída e reinício do conector serão gravados no arquivo de log do Direct Access gateway(DirectAccessAgent). Nas versões anteriores, eles eram gravados no arquivo de log Logs do agente do conector (connector-agent_logs_<date>).
  4. Na lista suspensa adjacente, selecione o registro que deseja visualizar ou baixar. Os arquivos de log são ordenados do mais novo (o arquivo de log atualmente ativo) para o mais antigo. Depois de selecionar um arquivo de log, você pode usar os botões Seta para rolar até o topo e Seta para rolar para a parte inferior para pular para o início ou o fim do arquivo de log, respectivamente.

    Nota de dicaA exibição do arquivo de log não é atualizada automaticamente com as mensagens mais recentes. Para atualizar a visualização, clique em Seta para rolar para a parte inferior para pular para o final do arquivo de log, que será atualizado com as últimas mensagens.
  5. Para baixar o arquivo de log, clique em Download.

    O arquivo será baixado para o seu computador ou você será solicitado a salvá-lo, dependendo das configurações do seu navegador.

Abrindo logs do Direct Access gateway na máquina do Direct Access gateway

Além de poder baixar os logs do Direct Access gateway (DirectAccessAgent) do centro de atividades de Administração, você também pode abri-los diretamente da máquina do Direct Access gateway. Com uma instalação padrão, esses registros estão localizados em:

C:\Program Files\Qlik\ConnectorAgent\data\logs

Alterando o nível de registro de DirectAccessAgent

Para fins de solução de problemas, talvez seja necessário alterar o nível de registro dos logs do DirectAccessAgent. DirectAccessAgent é responsável pela conexão com os serviços do Qlik Cloud. Para visualizar e alterar o nível de detalhes de log dos logs do DirectAccessAgent, execute os seguintes comandos na subpasta do ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent com uma instalação padrão):

  • Para visualizar o nível de registro em log atual, execute:

    connectoragent configuration getloggers
  • Para definir o nível de registro em log para Rastreio, execute:

    connectoragent configuration setloggers -l Root -v DEBUG
  • Para definir o nível de registro em log para Detalhado, execute:

    connectoragent configuration setloggers -l Root –v DETAILED_DEBUG

Para opções adicionais de registro em log, consulte Configurando o Direct Access gateway no Qlik Cloud abaixo.

Atualizando a chave de registro

Pode ser necessário alterar a chave de registro no caso improvável de que essa chave esteja corrompida ou se você suspeitar de que o servidor do gateway de dados foi acessado por um usuário não autorizado.

Para atualizar a chave de registro:

  1. Na servidor do Direct Access gateway, abra um Prompt de Comando como administrador e altere o diretório de trabalho para a subpasta ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent com uma instalação padrão).
  2. Execute os seguintes comandos:

    • Gere a nova chave:

      connectoragent qcs generate_keys

    • Mostre a chave:

      connectoragent qcs get_registration

      A chave é mostrada:

      Imagem da chave de registro do Direct Access

  3. Copie a chave inteira, conforme mostrado no exemplo acima.

  4. No centro de atividades de Administração, abra as configurações do gateway de dados clicando no botão Mais no final da linha relevante e selecionando Editar.

  5. Cole a chave no campo Chave(substituindo a chave atual) e salve as configurações.

  6. Retorne ao servidor do gateway Direct Access e reinicie o serviço do Qlik Data Gateway - Acesso direto, conforme descrito em Gerenciando o serviço Qlik Data Gateway - Acesso direto.

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo – um erro de digitação, uma etapa ausente ou um erro técnico – avise-nos!