Como importar arquivos Avro do Cloud Spanner

Esta página descreve como importar bancos de dados do Cloud Spanner para o Cloud Spanner usando o Console do Google Cloud. Para importar arquivos Avro de outra fonte, consulte Como importar dados de bancos de dados que não são Cloud Spanner.

O processo usa o Dataflow. Ele importa dados de uma pasta de bucket do Cloud Storage que contém um conjunto de arquivos Avro (em inglês) e arquivos de manifesto JSON. O processo de importação só é compatível com arquivos Avro exportados do Cloud Spanner.

Para importar um banco de dados do Cloud Spanner usando a API REST ou a ferramenta de linha de comando gcloud, conclua as etapas na seção Antes de começar nesta página e, em seguida, consulte as instruções detalhadas em Cloud Storage Avro para Cloud Spanner.

Antes de começar

Para importar um banco de dados do Cloud Spanner, primeiro você precisa ativar as APIs Cloud Spanner, Cloud Storage, Compute Engine e Dataflow:

Ative as APIs

É preciso também ter cota suficiente e as permissões necessárias do IAM.

Requisitos de cota

Os requisitos de cota para jobs de importação, do serviço do Google Cloud, são os seguintes:

  • Cloud Spanner: é necessário ter nós suficientes para suportar o volume de dados que estão sendo importados. Não é necessário incluir qualquer outro nó para importar um banco de dados. No entanto, talvez seja necessário adicionar nós para que o job seja concluído dentro de um prazo razoável. Consulte Como otimizar jobs para saber mais detalhes.
  • Cloud Storage: para importar, é preciso ter um bucket contendo os arquivos exportados anteriormente. Não é necessário definir um tamanho para o bucket.
  • Dataflow: os jobs de importação estão sujeitos às mesmas cotas do Compute Engine para endereço IP, uso da CPU e do disco aplicadas a outros jobs do Dataflow.
  • Compute Engine: antes de executar um job de importação, é necessário configurar cotas iniciais para o Compute Engine, que serão usadas pelo Dataflow. Essas cotas representam o número máximo de recursos que você permite que o Dataflow use para seu job. Os valores iniciais recomendados são:

    • CPUs: 200
    • Endereços IP em uso: 200
    • Disco permanente padrão: 50 TB

    Geralmente, não é necessário fazer nenhum outro ajuste. O Dataflow fornece escalonamento automático para que você pague apenas pelos recursos efetivamente utilizados durante a importação. Se seu job puder usar mais recursos, a IU do Dataflow exibirá um ícone de aviso. O job será concluído, mesmo que um ícone de aviso seja exibido.

Requisitos do IAM

Para importar um banco de dados, é preciso também ter papéis do IAM com permissões suficientes para usar todos os serviços envolvidos em um job de importação. Para informações sobre como conceder papéis e permissões, consulte Como aplicar papéis do IAM.

Para importar um banco de dados, você precisa dos seguintes papéis:

  • No nível do projeto do Google Cloud:
    • Visualizador do Cloud Spanner
    • Administrador do Dataflow
    • Administrador do Storage
  • No nível do banco de dados ou da instância do Cloud Spanner, ou no nível do projeto do Google Cloud:
    • Leitor do Cloud Spanner
    • Administrador de banco de dados do Cloud Spanner (obrigatório apenas para jobs de importação)

Opcional: como localizar sua pasta de banco de dados no Cloud Storage

Para encontrar a pasta que contém o banco de dados exportado no Console do Cloud, vá até o navegador do Cloud Storage e clique no bucket que contém a pasta exportada.

Acessar o navegador do Cloud Storage (em inglês)

O nome da pasta que contém os dados exportados começa com o código da instância, o nome do banco de dados e o carimbo de data/hora do job de exportação. A pasta contém:

  • Um arquivo spanner-export.json
  • Um arquivo TableName-manifest.json para cada tabela do banco de dados exportado
  • Um ou mais arquivos TableName.avro-#####-of-##### O primeiro número na extensão .avro-#####-of-##### representa o índice do arquivo Avro, a partir de zero. O segundo representa o número de arquivos Avro gerados para cada tabela.

    Por exemplo, Songs.avro-00001-of-00002 é o segundo de dois arquivos que contêm os dados da tabela Songs.

Como importar um banco de dados

Para importar um banco de dados do Cloud Spanner do Cloud Storage para sua instância, siga estas etapas.

  1. Acesse a página Instâncias do Cloud Spanner.

    Acessar a página "Instâncias" (em inglês)

  2. Clique no nome da instância que conterá o banco de dados importado.

  3. Clique na guia Importar/Exportar e, em seguida, no botão Importar.

  4. Em Escolher uma pasta de origem, clique em Procurar.

  5. Encontre o bucket que contém a exportação na lista inicial ou clique em Pesquisar Captura de tela do elemento de pesquisa da IU para filtrar a lista e localizar o bucket. Clique duas vezes no bucket para ver as pastas dele.

  6. Encontre a pasta com os arquivos exportados e clique para selecioná-la.

  7. Clique em Selecionar.

  8. Digite um nome para o novo banco de dados que o Cloud Spanner cria durante o processo de importação. O nome escolhido para o banco de dados não pode ser um que já exista em sua instância.

  9. Selecione uma região no menu suspenso Escolha uma região para o job de importação.

  10. Marque a caixa de seleção em Confirmar cobranças para confirmar que há cobranças além das referentes aos nós atuais no Cloud Spanner.

  11. Clique em Importar.

    O Console do Cloud exibe a página Detalhes do banco de dados, que agora exibe uma caixa que descreve o job de importação, inclusive o tempo decorrido para sua realização:

    Captura de tela do job em andamento

Quando o job é finalizado ou encerrado, o Console do Cloud exibe uma mensagem na página Detalhes do banco de dados. Se o job for bem-sucedido, será exibida uma mensagem de sucesso:

Mensagem de sucesso do job de importação

Se o job não for bem-sucedido, será exibida uma mensagem de falha:

Mensagem de falha do job de importação

Se o job falhar, verifique os registros do Dataflow do job para ver os detalhes do erro e consulte a solução de problemas de jobs de importação com falha.

Como escolher uma região para o job de importação

Convém escolher uma região diferente dependendo da configuração que o bucket do Cloud Storage usa: regional ou multirregional. Para evitar cobranças de saída de rede, escolha uma região que se sobreponha ao local do seu intervalo do Cloud Storage.

Locais de intervalos regionais

Se o local do bucket do Cloud Storage for regional, escolha a mesma região para o job de importação, caso esteja disponível, para aproveitar o uso gratuito da rede.

Se a mesma região não estiver disponível, haverá cobranças de saída. Consulte os preços de saída de rede do Cloud Storage para escolher uma região que incorra tarifas de saída de rede mais baixas.

Locais de intervalos multirregionais

Se o local do bucket do Cloud Storage for multirregional, escolha uma das regiões que o compõem para aproveitar o uso gratuito da rede.

Se não houver uma região sobreposta disponível, haverá cobranças de saída. Consulte os preços de saída de rede do Cloud Storage para escolher uma região que incorra tarifas de saída de rede mais baixas.

Como visualizar ou solucionar problemas de jobs na IU do Dataflow

Depois de iniciar um job de importação, é possível ver os detalhes dele, incluindo registros, na seção do Dataflow do Console do Cloud.

Como visualizar detalhes do job do Dataflow

Para ver detalhes de um job que está sendo executado, siga estas etapas:

  1. Navegue até a página Detalhes do banco de dados.
  2. Clique em Visualizar detalhes do job no Dataflow na mensagem de status do job, que é semelhante a esta:

    Mensagem de status do job em andamento

    O Console do Cloud exibe detalhes do job do Dataflow.

Para visualizar um job executado recentemente, siga estas etapas:

  1. Navegue até a página Detalhes do banco de dados.
  2. Clique na guia Importar/Exportar.
  3. Clique no nome do seu job na lista.

    O Console do Cloud exibe detalhes do job do Dataflow.

Para visualizar um job executado há mais de uma semana, siga estas etapas:

  1. Acesse a página de jobs do Dataflow no Console do Cloud.

    Acessar a página de jobs (em inglês)

  2. Encontre seu job na lista e clique no nome dele.

    O Console do Cloud exibe detalhes do job do Dataflow.

Como visualizar registros do Dataflow para seu job

Para visualizar os registros de um job do Dataflow, navegue até a página de detalhes do job, conforme descrito acima. Em seguida, clique em Registros, à direita do nome do job.

Se um job falhar, procure erros nos registros. Se houver erros, a contagem de erros será exibida ao lado de Registros:

Exemplo de contagem de erros ao lado do botão Registros

Para ver os erros do job, siga estas etapas:

  1. Clique na contagem de erros, ao lado de Registros.

    O Console do Cloud exibe os registros do job. Pode ser necessário rolar para visualizar os erros.

  2. Localize entradas com o ícone de erro Ícone de erro.

  3. Clique em uma entrada de registro individual para expandir seu conteúdo.

Para mais informações sobre como solucionar problemas de jobs do Dataflow, consulte Solução de problemas do pipeline.

Solução de problemas de jobs de importação com falha

Se você vir os seguintes erros nos registros do job:

com.google.cloud.spanner.SpannerException: NOT_FOUND: Session not found

--or--

com.google.cloud.spanner.SpannerException: DEADLINE_EXCEEDED: Deadline expired before operation could complete.

Verifique a latência de gravação de 99% na guia Monitoramento do banco de dados do Cloud Spanner no Console do Cloud. Se estiver exibindo valores altos (vários segundos), isso indicará que a instância está sobrecarregada, fazendo com que as gravações expirem e falhem.

Uma causa da alta latência é que o job do Dataflow está sendo executado usando muitos workers, colocando muita carga na instância do Cloud Spanner.

Para especificar um limite para o número de workers do Dataflow, em vez de usar a guia "Importar/Exportar" na página de detalhes da instância do banco de dados do Cloud Spanner no Console do Cloud, inicie a importação usando o Modelo do Cloud Storage Avro para Cloud Spanner do Dataflow e especifique o número máximo de workers conforme descrito abaixo:
  • Se você estiver usando o console do Dataflow, o parâmetro Workers máximos estará localizado na seção Parâmetros opcionais da página Criar job a partir do modelo.

  • Se você estiver usando o gcloud, especifique o argumento max-workers. Exemplo:

    gcloud dataflow jobs run my-import-job \
    --gcs-location='gs://dataflow-templates/latest/GCS_Avro_to_Cloud_Spanner' \
    --region=us-central1 \
    --parameters='instanceId=test-instance,databaseId=example-db,inputDir=gs://my-gcs-bucket' \
    --max-workers=10
    

O número máximo de workers depende muito do tamanho dos dados, mas o ideal é que a utilização total da CPU do Spanner esteja entre 70% e 90%. Isso fornece um bom equilíbrio entre a eficiência do Spanner e a conclusão de jobs sem erros.

Para atingir essa meta de utilização na maioria dos esquemas/cenários, recomendamos um número máximo de vCPUs de trabalho entre 4 e 6 vezes o número de nós do Spanner.

Por exemplo, para uma instância do Spanner de 10 nós, usando workers n1-standard-2, defina o máximo de workers como 25, fornecendo 50 vCPUs.

Como otimizar jobs de importação de execução lenta

Se as sugestões das configurações iniciais forem seguidas, geralmente não será necessário fazer nenhum outro ajuste. Se o job estiver sendo executado lentamente, é possível tentar outras otimizações:

  • Otimize o local do job e dos dados: execute o job do Cloud Dataflow na mesma região em que estão localizados o bucket do Cloud Storage e a instância do Cloud Spanner.

  • Garanta recursos suficientes do Dataflow: se as cotas relevantes do Compute Engine limitarem os recursos do job do Dataflow, a página do Dataflow no Console do Google Cloud exibirá um ícone de aviso Ícone de aviso e mensagens de registro:

    Captura de tela do aviso de limite de cota

    Nessa situação, é possível reduzir o ambiente de execução do job aumentando as cotas (em inglês) para CPUs, endereços IP em uso e disco permanente padrão. Porém, isso pode resultar em mais cobranças do Compute Engine.

  • Verifique a utilização da CPU do Cloud Spanner: é possível aumentar o número de nós de uma instância caso a utilização da CPU para ela seja superior a 65%. Os nós extras adicionam mais recursos do Cloud Spanner e isso pode acelerar o job, mas resultará em cobranças adicionais do Cloud Spanner.

Fatores que afetam o desempenho do job de importação

Vários fatores influenciam o tempo necessário para concluir um job de importação.

  • Tamanho do banco de dados do Cloud Spanner: o processamento de mais dados leva mais tempo e exige mais recursos.

  • Esquema do banco de dados do Cloud Spanner: o número de tabelas, o tamanho das linhas, o número de índices secundários e o número de chaves estrangeiras influenciam o tempo necessário para executar um job de importação. Observe que a criação do índice e da chave externa continua após a conclusão do job de importação do Dataflow.

  • Local dos dados: os dados são transferidos entre o Cloud Spanner e o Cloud Storage usando o Dataflow. O ideal é que os três componentes estejam localizados na mesma região. Se não estiverem, a movimentação dos dados pelas regiões prejudica a velocidade de execução do job.

  • Número de workers do Dataflow: usando o escalonamento automático, o Dataflow escolhe o número de workers para o job, dependendo da quantidade de trabalho que precisa ser feita. O número de workers, no entanto, será limitado pelas cotas para CPUs, endereços IP em uso e disco permanente padrão. A IU do Dataflow exibirá um ícone de aviso caso encontre limites de cotas. Nessa situação, o progresso será mais lento, mas ainda assim o job será concluído.

  • Carga atual no Cloud Spanner: um job de importação adiciona carga significativa da CPU em uma instância do Cloud Spanner. Se a instância já tiver uma carga atual substancial, a execução do job será mais lenta.

  • Número de nós do Cloud Spanner: se a utilização da CPU para a instância for superior a 65%, o job será executado mais lentamente.