Como exportar bancos de dados do Cloud Spanner para o Avro

Esta página descreve como exportar bancos de dados do Cloud Spanner com o Console do Google Cloud.

O processo usa o Dataflow e exporta dados para uma pasta em um bucket do Cloud Storage. A pasta resultante contém um conjunto de arquivos Avro e arquivos de manifesto JSON.

Para exportar 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, consulte as instruções detalhadas em Cloud Spanner para Cloud Storage Avro.

Antes de começar

Para exportar 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 exportação, do serviço do Google Cloud, são os seguintes:

  • Cloud Spanner: não é necessário incluir qualquer outro nó para exportar 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 exportar, crie um bucket para os arquivos exportados, caso ainda não tenha um. Faça isso no Console do Cloud, por meio da página do Cloud Storage ou ao criar sua exportação por meio da página do Cloud Spanner. Não é necessário definir um tamanho para o bucket.
  • Cloud Dataflow: os jobs de exportaçã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 exportaçã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 exportaçã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 exportar 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 exportação. Para informações sobre como conceder papéis e permissões, consulte Como aplicar papéis do IAM.

Para exportar 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)

Como exportar um banco de dados

Depois de atender aos requisitos de cota e do Cloud IAM descritos acima, é possível exportar um banco de dados já existente do Cloud Spanner.

Para exportar seu banco de dados do Cloud Spanner para um bucket do Cloud Storage, siga as seguintes etapas.

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

    Acessar a página "Instâncias"

  2. Clique no nome da instância que contém o banco de dados.

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

  4. Em Escolha onde armazenar sua exportação, clique em Procurar.

  5. Caso ainda não tenha um bucket do Cloud Storage para sua exportação, siga estas etapas:

    1. Clique em Novo bucket Captura de tela do novo elemento do bucket da IU.
    2. Digite um nome para o bucket. Os nomes de intervalos precisam ser exclusivos no Cloud Storage.
    3. Selecione uma classe e um local de armazenamento padrão e clique em Criar.
    4. Clique no bucket para selecioná-lo.

    Se você já tiver um bucket, selecione-o na lista inicial ou clique em Pesquisar Captura de tela do elemento de pesquisa da IU para filtrar a lista. Depois, clique no seu bucket para selecioná-lo.

  6. Clique em Selecionar.

  7. Selecione o banco de dados que você quer exportar no menu suspenso Escolher um banco de dados para exportar.

  8. Selecione uma região no menu suspenso Escolha uma região para o job de exportação.

  9. 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.

  10. Clique em Exportar.

    O Console do Cloud exibe a página Detalhes do banco de dados, que agora exibe uma caixa que descreve o job de exportação, incluindo 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 exportação

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

Mensagem de falha do job de exportação

Se o job falhar, verifique os registros do Dataflow do job para ter acesso aos detalhes do erro.

Para evitar cobranças do Cloud Storage por arquivos criados por um job que falhou, exclua a pasta e os arquivos dela. Consulte Como visualizar sua exportação para informações sobre como encontrar a pasta.

Como visualizar sua exportação no Cloud Storage

Para visualizar 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 selecionado anteriormente:

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

O bucket agora contém uma pasta com o banco de dados exportado. O nome da pasta começa com o código da instância, o nome do banco de dados e o carimbo de data e hora do seu 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 escolher uma região para seu job de exportação

Convém escolher uma região diferente, dependendo de sua instância do Cloud Spanner usar uma configuração regional ou multirregional. Para evitar cobranças de saída de rede, escolha uma região que se sobreponha ao local da sua instância do Cloud Spanner.

Configurações de instâncias regionais

Se a configuração da sua instância do Cloud Spanner for regional, escolha a mesma região para o job de exportação para aproveitar a saída gratuita dentro de uma mesma região.

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

Configurações de instâncias multirregionais

Se a configuração da instância do Cloud Spanner for multirregional, escolha uma das regiões que compõem a configuração multirregional para aproveitar a saída gratuita em uma mesma região.

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 Spanner para escolher uma região que gerará 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 exportaçã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 exportaçã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 leitura de 99% na guia Monitoramento do banco de dados do Cloud Spanner no Console do Cloud. Se ele mostra valores altos (vários segundos), indica que a instância está sobrecarregada, fazendo com que as leituras atinjam o tempo limite 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 em relação ao 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 exportação usando o Dataflow Modelo Cloud Spanner para Cloud Storage Avro 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-export-job \
    --gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
    --region=us-central1 \
    --parameters='instanceId=test-instance,databaseId=example-db,outputDir=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 exportaçã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 exportação

Vários fatores influenciam o tempo necessário para concluir um job de exportaçã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 exportação.

  • 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 existente no Cloud Spanner: um job de exportação normalmente adiciona uma carga leve a 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.