Ativar o Tableau Catalog

O Tableau Catalog(O link abre em nova janela) descobre e indexa todo o conteúdo no site do seu Tableau Online ou Tableau Server, incluindo pastas de trabalho, fontes de dados, planilhas, métricas e fluxos. A indexação é usada para coletar informações sobre o conteúdo, ou metadados, o esquema e a linhagem do conteúdo. Em seguida, com os metadados, o Catalog identifica todos os bancos de dados, arquivos e tabelas usadas pelo conteúdo no site do Tableau Online ou no Tableau Server.

O Catalog está disponível com o Data Management Add-on. Para obter mais informações, consulte Sobre o Data Management Add-On.

Além do Catalog, os metadados sobre seu conteúdo também podem ser acessados na API de metadados do Tableau(O link abre em nova janela) e na REST API do Tableau usando Métodos de metadados(O link abre em nova janela).

Antes de ativar o Catalog

Como administrador do Tableau Server, há algumas coisas que você precisa considerar antes e durante a ativação do Catalog, para assegurar o desempenho ideal do Catalog no ambiente do Tableau Server.

Versões obrigatórias

Antes de ativar o Catalog, verifique se você está executando uma das seguintes versões do Tableau Server:

  • No mínimo, o Tableau Server 2019.3.4 ou posterior
  • No mínimo, o Tableau Server 2019.4.2 ou posterior
  • No mínimo, o Tableau Server 2020.1.0 ou posterior
  • No mínimo, o Tableau Server 2020.2.15 ou posterior
  • Tableau Server 2020.3 e posterior

Para obter mais informações sobre por que essas versões são obrigatórias, consulte a Base de dados de conhecimento do Tableau.

O que esperar ao ativar o Catalog

Quando o Catalog é ativado, o conteúdo já existente no Tableau Server é indexado imediatamente.

Ingestão inicial

O processo de indexação é composto por dois componentes primários, um deles é denominado ingestão inicial. A ingestão inicial pode ser dividida em outros dois componentes:

  • Backfill de conteúdo
  • Backfill de linhagem

É importante observar o status de backfill de conteúdo e linhagem mais tarde, ao monitorar o andamento e confirmar se o Catalog foi ligado com sucesso e está funcionando no ambiente do Tableau Server.

Velocidade de ingestão inicial

O tempo necessário para o Catalog indexar o conteúdo pela primeira vez depende de alguns fatores:

  • Quantidade de conteúdo no Tableau Server: a quantidade de conteúdo é medida pelo número total de pastas de trabalho, métricas, fontes de dados publicadas e fluxos publicados no Tableau Server. Para obter mais informações, consulte Espaço em disco para armazenar metadados.

  • Número de contêineres de microsserviços não interativos: O Catalog usa o contêiner de microsserviços não interativo para indexar todo o conteúdo no Tableau Server. Para obter mais informações, consulte Memória para contêineres de microsserviços não interativos.

Entender os fatores que afetam a ingestão inicial pode ajudar a medir o tempo de ativação e execução do Catalog no ambiente.

Espaço em disco para armazenar metadados

Durante a ingestão inicial, os metadados são gerados e armazenados no repositório do Tableau Server (banco de dados PostgreSQL “relationship”). A quantidade de espaço em disco necessária para armazenar os metadados é aproximadamente metade do espaço em disco atualmente usado pelo repositório (banco de dados PostgreSQL "workgroup").

Por exemplo, suponha que o repositório use 50 GB de espaço em disco antes de habilitar o Catalog, o repositório pode usar até 75 GB de espaço em disco após ativar o Catalog.

Memória para contêineres de microsserviços não interativos

A ingestão inicial é executada dentro do contêiner de microsserviços não interativo. O contêiner de microsserviços não interativo é um dos dois processos de contêineres de microsserviços do Tableau Server(O link abre em nova janela). Por padrão, uma instância dos microsserviços não interativos é adicionada a cada nó que possui um processador em segundo plano.

Por padrão, a ingestão inicial em uma única instância do contêiner de microsserviços não interativo pode usar até 4 GB de memória no nó de segundo plano. Se a quantidade de conteúdo no Tableau Server exceder 10.000, um contêiner de microsserviços não interativo pode exigir até 16 GB de memória no nó de segundo plano. Portanto, ao habilitar o Catalog, certifique-se de que cada nó de segundo plano tenha a capacidade disponível para suportar cada contêiner de microsserviços não interativo durante o processo inicial de ingestão. Se a capacidade precisar ser aumentada, você deve atualizar o tamanho do heap JVM para contêineres não interativos para alocar até 16 GB de memória nos nós de segundo plano. Para obter mais informações, consulte noninteractivecontainer.vmopts.

Se estiver planejando adicionar mais contêineres de microsserviços não interativos para diminuir o tempo de ingestão inicial, primeiro determine quantos contêineres totais são necessários (usando Etapa 2: estimar quanto tempo a ingestão inicial levará, abaixo) e, em seguida, verifique se o ambiente do Tableau Server está configurado com capacidade suficiente para suportar todos os contêineres de microsserviços não interativos. Dependendo de como o ambiente do Tableau Server está configurado, pode não ser possível adicionar todos os contêineres que não são de microsserviços adicionais necessários para diminuir o tempo inicial de ingestão.

Práticas recomendadas para ativar o Catalog

Como a velocidade da ingestão inicial e os requisitos são exclusivos para cada ambiente do Tableau Server, o Tableau recomenda que você faça o seguinte ao ativar o Catalog:

  • Certifique-se de que há espaço em disco suficiente que o repositório do Tableau Server possa usar para suportar os metadados adicionais que a ingestão inicial vai gerar e armazenar. Como regra geral, o repositório precisará de um espaço adicional de 50% do disco atualmente usado pelo repositório. Para obter mais informações sobre o uso do disco do Tableau Server, consulte Espaço em disco do servidor.

  • Dependendo da quantidade de conteúdo no Tableau Server, certifique-se de que cada nó do processador em segundo plano tenha pelo menos de 4 a 16 GB de memória disponível para cada instância de um contêiner de microsserviços não interativo durante a ingestão inicial.

  • Realize o processo durante o fim de semana para permitir que a ingestão inicial seja concluída antes que os usuários comecem a utilizar os recursos do Catalog.

  • Realize o processo em um ambiente de teste com conteúdo de produção primeiro. Isso porque o tipo de conteúdo que precisa ser ingerido pode desempenhar um papel significativo na velocidade de ingestão.

Resumo das etapas para ativar o Catalog

As etapas a seguir resumem o processo para ativar e executar o Catalog no Tableau Server. As etapas devem ser realizadas em sequência.

  1. Determinar a quantidade de conteúdo no Tableau Server
  2. Estimar o tempo de ingestão inicial
  3. Diminuir o tempo de ingestão inicial
  4. Ativar o Data Management Add-on
  5. Desativar os recursos do Catalog
  6. Executar o comando tsm maintenance metadata-services
  7. Monitorar o andamento da ingestão inicial e validar o status
  8. Configurar o SMTP
  9. Ativar os recursos do Catalog

Observação: como a indexação de metadados sobre o conteúdo do Tableau no Tableau Sever é alimentada pela API de Metadados, é necessário habilitar a API de Metadados para executar e usar o Catalog.

Ativar o Catalog

Etapa 1: determinar a quantidade de conteúdo no Tableau Server

Para determinar a quantidade de conteúdo no Tableau Server, faça o seguinte:

  1. Entre no Tableau Server usando as credenciais de administrador.

  2. Vá para a página Explorar.

  3. Clique no menu suspenso Projeto de nível superior e adicione os números ao lado de Todas as pastas de trabalho, Todas as métricas, Todas as fontes de dados e Todos os fluxos juntos. Essa é a quantidade total de conteúdo no Tableau Server.

Etapa 2: estimar o tempo de ingestão inicial

Para estimar o tempo que o Catalog levará para ingerir conteúdo no Tableau Server pela primeira vez (ingestão inicial), compare a configuração do seu Tableau Server com uma configuração do Tableau Server de linha de base.

Para o Tableau Server com a seguinte configuração, a ingestão inicial pode levar cerca de 6 horas para ser concluída.

Componentes Valores de linha de base
Conteúdo 17.000 pastas de trabalho, fontes de dados publicadas e fluxos
Contêineres de microsserviços não interativos 10
Ingestão ~6 horas

Se você tiver aproximadamente metade do conteúdo no ambiente do Tableau Server, a ingestão inicial pode levar metade do tempo para ser concluída.

Por exemplo: 8.500 (pastas de trabalho, métricas, fontes de dados publicadas e fluxos) + 10 contêineres de microsserviços não interativos = ~3 horas (ingestão inicial)

Se você tiver aproximadamente o dobro do conteúdo no ambiente do Tableau Server, a ingestão inicial pode levar o dobro do tempo para ser concluída.

Por exemplo: 34.500 (pastas de trabalho, métricas, fontes de dados publicadas e fluxos) + 10 contêineres de microsserviços não interativos = ~12 horas (ingestão inicial)

Etapa 3: diminuir o tempo de ingestão inicial

Como regra geral, o tempo que o Catalog leva para realizar a ingestão inicial está correlacionado com o número de contêineres de microsserviços não interativos. Para ajudar a diminuir o tempo de ingestão inicial, é possível aumentar o número de contêineres de microsserviços não interativos.

Aumentar o número de contêineres de microsserviços não interativos

Por padrão, um contêiner de microsserviços não interativo é adicionado a cada nó que possui um processador em segundo plano. Para ajudar a diminuir o tempo de ingestão inicial, o Tableau recomenda aumentar o número de contêineres de microsserviços não interativos usando o comando tsm topology set-process.

  1. Abra um prompt de comando como administrador no nó inicial (onde o TSM está instalado) no cluster.

  2. Execute o comando: tsm topology set-process --count <process_count> --node <node_ID> --process <process_name>

    Por exemplo, para aumentar os contêineres de microsserviços não interativos no nó inicial para 4 contêineres, execute o seguinte comando:

    tsm topology set-process --count 4 –-node node1 --process noninteractive

    Para obter mais informações sobre a execução do comando e suas opções globais, consulte tsm topology.

Importante: antes de aumentar o número de contêineres de microsserviços não interativos, analise o seguinte: 

  • A recomendação de aumentar os contêineres de microsserviços não interativos é para o número total de contêineres de microsserviços não interativos, e não para o total de contêineres de microsserviços não interativos por nó. Por exemplo, suponha que você tem 4 nós, mas deseja aumentar o número de contêineres não interativos para 8. O valor --count usando no comando tsm é 2.

  • Para cada contêiner de microsserviços não interativo adicionado, 4 GB de memória adicional serão usados no nó e a carga será incluída no repositório do Tableau Server (banco de dados PostreSQL).

    • O Tableau recomenda que você aumente gradativamente os contêineres de microsserviços não interativos, no máximo, em 2 de cada vez, enquanto monitora de perto o ambiente do Tableau Server para evitar problemas com a utilização da CPU do repositório do Tableau Server (banco de dados PostgreSQL).

    • Esteja ciente de que, quando muitos microsserviços não interativos são adicionados, a utilização da CPU do banco de dados PostgreSQL pode apresentar picos e failover. Os sintomas a serem observadas incluem erros de SQLException nos registros do vizportal. Para obter mais informações, consulte o tópico Failover do repositório(O link abre em nova janela).

Etapa 4: ativar o Data Management Add-on

(Requer o Data Management Add-on)

Se ainda não tiver sido feito, você pode ativar o Data Management Add-on. Para obter mais informações, consulte Licença do Data Management Add-On.

Etapa 5 (opcional): desativar os recursos do Catalog de cada site

(Requer o Data Management Add-on)

Como parte da ativação do Data Management Add-on, os recursos do Catalog são ativados por padrão. Devido ao processo de indexação e ao tempo de conclusão estimado, considere desativar temporariamente os recursos do Catalog de cada site para que os usuários do Tableau Server não possam acessar os recursos do Catalog, até que o Catalog esteja pronto e apto para fornecer resultados completos e precisos.

  1. Entre no Tableau Server usando as credenciais de administrador.

  2. No painel de navegação esquerdo, clique em Configurações.

  3. Na guia Geral, em Tableau Catalog, desmarque a caixa de seleção Ativar Tableau Catalog.

  4. Repita as etapas 2-3 para cada site no Tableau Server.

Etapa 6: executar o comando tsm maintenance metadata-services

Execute o comando tsm maintenance metadata-services para habilitar a API de metadados do Tableau. A execução do comando instaura a ingestão inicial. Se o Tableau Server estiver licenciado com o Data Management Add-On, a execução do comando também ativa os recursos do Catalog (se não tiver sido desativado anteriormente).

  1. Abra um prompt de comando como administrador no nó inicial (onde o TSM está instalado) no cluster.

  2. Execute o comando: tsm maintenance metadata-services enable

    Para obter mais informações sobre como executar o comando tsm, consulte tsm maintenance(O link abre em nova janela).

Observações: ao executar este comando, lembre-se dos seguintes pontos:

  • Esse comando interrompe e inicia alguns serviços usados pelo Tableau Server, que faz com que determinadas funcionalidades, como os recursos de Recomendações, fiquem temporariamente indisponíveis.

  • Um novo índice de metadados é criado neste momento. A execução deste comando nos momentos subsequentes criará e substituirá o índice anterior.

Etapa 7: monitorar o andamento da ingestão inicial e validar o status

A execução do comando tsm acima instaura o processo de ingestão inicial. Para garantir que o processo de ingestão inicial ocorra sem problemas, você pode monitorar o andamento dele, usando a API de Backfill. Para obter mais informações, consulte Obter o status de ingestão inicial.

Etapa 8: configurar o SSL

Se ainda não estiver configurado para o Tableau Server, configure a instalação do SMTP. O SMTP oferece suporte ao envio de e-mail aos proprietários que precisam ser contatados sobre alterações nos dados. Para obter mais informações sobre a configuração do SMTP, consulte Configurar o SMTP(O link abre em nova janela).

Etapa 9 (opcional): ativar os recursos do Catalog de cada site

(Requer o Data Management Add-on)

Se você desativou os recursos do Catalog antes da ativação do Catalog em um dos procedimentos acima, você deve ativar o Catalog para tornar seus recursos acessíveis aos usuários.

  1. Entre no Tableau Server usando as credenciais de administrador.

  2. No painel de navegação esquerdo, clique em Configurações.

  3. Na guia Geral, em Tableau Catalog, marque a caixa de seleção Ativar Tableau Catalog.

  4. Repita as etapas 2-3 para cada site no Tableau Server.

Solucionar problemas do Catalog

Você ou os usuários podem encontrar um dos seguintes problemas ao usar o Catalog.

Mensagens de tempo limite e limite de nós excedidos

Para garantir que as tarefas do Catalog que precisam retornar um grande número de resultados, não esgotem todos os recursos do sistema do Tableau Server, o Catalog implementa tempo limite e limite de nós.

  • Tempo limite

    Quando as tarefas do Catalog atingem o tempo limite, você e seus usuários veem a seguinte mensagem:

    Mostrando resultados parciais, o limite de tempo da solicitação foi excedido. Tente novamente mais tarde.” ou TIME_LIMIT_EXCEEDED

    Para resolver esse problema, como administrador do Tableau Server, você pode aumentar o tempo limite usando o comando tsm configuration set –k metadata.query.limits.time. Para obter mais informações, veja os tópicos tsm configuration(O link abre em nova janela) e a Opções do tsm configuration set(O link abre em nova janela).

    Importante: o aumento do tempo limite pode utilizar mais CPU por mais tempo, o que pode afetar o desempenho de outros processos no Tableau Server.

  • Limite de nós

    Quando as tarefas do Catalog atingem o limite do nó, você e seus usuários veem a seguinte mensagem:

    NODE_LIMIT_EXCEEDED

    Para resolver esse problema, como administrador do Tableau Server, você pode aumentar o limite de nós usando o comando tsm configuration set –k metadata.query.limits.count. Para obter mais informações, veja os tópicos tsm configuration(O link abre em nova janela) e a Opções do tsm configuration set(O link abre em nova janela).

    Importante: o aumento do tempo limite pode afetar a memória do sistema.

Conteúdo ausente

  • Se você suspeitar, após a ingestão inicial, que está faltando conteúdo no Catalog, você pode usar a API de eventos para ajudar a solucionar problemas. Eventos manipula o conteúdo de indexação no Tableau Server após a ingestão inicial. Para obter mais informações, consulte Obter status de eventos.

  • Quando a conexão entre um ativo externo inserido e seu conteúdo downstream do Tableau é removida, ele permanece no Catalog (ou na API de metadados do Tableau) até que seja automaticamente excluído por um processo em segundo plano executado todos os dias às 22:00:00 UTC (horário universal coordenado) . Por exemplo, suponha que uma pasta de trabalho, inicialmente publicada com um arquivo de texto inserido A, seja republicada com um arquivo de texto inserido B. O arquivo A permanece visível (ou passível de consulta) como um ativo externo até que os processos em segundo plano possam excluí-lo.

    Você pode desativar a execução desse processo em segundo plano se não quiser remover esses tipos de ativos externos ou se acreditar que ele consome recursos do sistema que você não deseja dedicar a esse processo. Como alternativa, você pode ajustar o número de ativos integrados externos que são excluídos. Para obter mais informações, veja os tópicos features.DeleteOrphanedEmbeddedDatabaseAsset e a databaseservice.max_database_deletes_per_run.

    É possível monitorar esse processo de uma das duas formas:

    • O filtro no trabalho único canoniza novamente os ativos de banco de dados/tabela existentes após um tipo de tarefa de alteração de lógica de canonização na exibição do administrador Tarefas em segundo plano para não extrações.

    • Consulte Remoção concluída de bancos de dados inseridos órfãos ou eventos database_service_canonicalization_changenos arquivos de registro do Tableau Server.

Desempenho após ingestão inicial

Em alguns ambientes do Tableau Server, onde conteúdo específico é atualizado com muita frequência (por exemplo, através de horários de alta frequência ou linhas de comando ou solicitações de API), o processo de indexação pode superar a saturação. Nesses casos, como administrador do servidor, você pode considerar permitir que a limitação de eventos preserve melhor o desempenho do Catalog. Para obter mais informações, consulte metadata.ingestor.pipeline.throttleEventsEnable.

Observação: quando a limitação de eventos é habilitada, os usuários podem notar um atraso pretendido nas alterações de conteúdo no Catalog.

Erros de falta de memória

Em alguns casos, os erros de falta de memória do Tableau Server podem ocorrer como resultado de problemas com a ingestão de conteúdo complexo. Se você suspeitar que a ingestão é a causa dos erros de falta de memória no Tableau Server, entre em contato e trabalhe com o Suporte do Tableau para opter metadata.ingestor.blocklist para evitar a ingestão e ajudar a resolver o problema.

Desativar o Catalog

Como administrador do Tableau Server, você pode desativar o Catalog de duas maneiras.

Desativar os recursos do Catalog de cada site

(Requer o Data Management Add-on)

Você pode desativar os recursos do Catalog a qualquer momento. Quando os recursos do Catalog estão desabilitados, os recursos do Catalog, como a adição de avisos de qualidade de dados ou a capacidade de gerenciar as permissões de ativos de banco de dados e tabela de forma explícita, não são acessíveis pelo Tableau Server. No entanto, o Catalog continua a indexar conteúdo publicado e os metadados são acessíveis a partir da API de metadados do Tableau e dos métodos de metadados na REST API do Tableau.

  1. Entre no Tableau Server usando as credenciais de administrador.

  2. No painel de navegação esquerdo, clique em Configurações.

  3. Na guia Geral, em Tableau Catalog, desmarque a caixa de seleção Ativar Tableau Catalog.

Interromper a indexação de metadados no Tableau Server

Para interromper a indexação do conteúdo publicado no Tableau Server, você pode desativar a API de metadados do Tableau. Para desabilitar a API de metadados, execute o comando tsm maintenance metadata-services disable. Para obter mais informações, consulte tsm maintenance(O link abre em nova janela).

Outros artigos nesta seção

Agradecemos seu feedback!