Sessões

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Nesta página, descrevemos o conceito avançado de sessões no Spanner, incluindo práticas recomendadas para sessões ao criar uma biblioteca de cliente, usar as APIs REST ou RPC ou usar as bibliotecas de cliente do Google.

Visão geral das sessões

Uma sessão representa um canal de comunicação com o serviço de banco de dados do Spanner. Uma sessão é usada para executar transações que leem, gravam ou modificam dados em um banco de dados do Spanner. Cada sessão aplica-se a um único banco de dados.

As sessões podem executar uma ou várias transações de uma só vez. Ao executar várias transações, a sessão é chamada de sessão multiplexada.

Leituras, gravações e consultas independentes usam uma transação internamente.

Benefícios de desempenho de um pool de sessões

Criar uma sessão é algo caro. Para evitar o custo de desempenho sempre que uma operação de banco de dados é feita, os clientes precisam manter um pool de sessões, que é um conjunto de sessões disponíveis prontas para uso. O pool deve armazenar as sessões atuais e retornar o tipo apropriado de sessão quando solicitado, além de lidar com a limpeza das sessões não utilizadas. Para um exemplo de como implementar um pool de sessões, consulte o código-fonte de uma das bibliotecas de cliente do Spanner, como a biblioteca de cliente Go ou a biblioteca de cliente Java.

As sessões devem ser de longa duração. Portanto, depois que uma sessão é usada para uma operação de banco de dados, o cliente precisa retornar a sessão ao pool para reutilização.

Visão geral dos canais gRPC

Os canais gRPC são usados pelo cliente do Spanner para comunicação. Um canal gRPC é, aproximadamente, equivalente a uma conexão TCP. Um canal gRPC pode lidar com até 100 solicitações simultâneas. Isso significa que um aplicativo precisará de pelo menos o mesmo número de canais gRPC que o número de solicitações simultâneas que o aplicativo executará, dividido por 100.

O cliente Spanner cria um pool de canais gRPC quando você o cria.

Práticas recomendadas ao usar bibliotecas de cliente do Google

Veja a seguir as práticas recomendadas ao usar as bibliotecas de cliente do Google para o Spanner.

Configurar o número de sessões e canais gRPC nos pools

As bibliotecas de cliente têm um número padrão de sessões no conjunto e um número padrão de canais gRPC no pool de canais. Ambos os padrões são adequados na maioria dos casos. Veja a seguir as sessões mínima e máxima padrão e o número padrão de canais gRPC para cada linguagem de programação.

MinSessions: 100
MaxSessions: 400
NumChannels: 4

MinSessions: 100
MaxSessions: 400
NumChannels: 4

MinSessions: 100
MaxSessions: 400
NumChannels: 4

MinSessions: 100
MaxSessions: 400
NumChannels: 4

MinSessions: 25
MaxSessions: 100

MinSessions: 1
MaxSessions: 500

MinSessions: 10
MaxSessions: 100

O número de sessões que o aplicativo usa é igual ao número de transações simultâneas executadas pelo aplicativo. Modifique as configurações do pool de sessões padrão somente se esperar que uma única instância de aplicativo execute mais transações simultâneas do que o pool de sessões padrão pode processar.

Para aplicativos de alta simultaneidade, recomendamos o seguinte:

1. Defina MinSessions como o número esperado de transações simultâneas que um único cliente executará.
2. Defina MaxSessions como o número máximo de transações simultâneas que um único cliente pode executar.
3. Defina MinSessions=MaxSessions se a simultaneidade esperada não mudar muito durante o ciclo de vida do aplicativo. Isso evita que o pool de sessões seja escalonado verticalmente. Aumentar ou diminuir o pool de sessões também consome alguns recursos.
4. Defina NumChannels como MaxSessions / 100. Um canal gRPC pode processar até 100 solicitações simultaneamente. Aumente esse valor se você observar uma latência de cauda alta (latência p95/p99), porque isso pode ser uma indicação de congestionamento do canal gRPC.

Aumentar o número de sessões ativas usa recursos extras no serviço de banco de dados do Spanner e na biblioteca de cliente. Aumentar o número de sessões além da necessidade real do aplicativo pode prejudicar o desempenho do sistema.

Aumentar o pool de sessões versus aumentar o número de clientes

O tamanho do pool de sessões de um aplicativo determina quantas transações simultâneas uma única instância do aplicativo pode executar. Não é recomendável aumentar o tamanho do pool de sessões além da simultaneidade máxima que uma única instância de aplicativo pode processar. Se o aplicativo recebe um burst de solicitações que ultrapassam o número de sessões no pool, elas são enfileiradas enquanto aguardam uma sessão ficar disponível.

Os recursos consumidos pela biblioteca de cliente são os seguintes:

1. Cada canal gRPC usa uma conexão TCP.
2. Cada invocação gRPC requer uma linha de execução. O número máximo de linhas de execução usadas pela biblioteca de cliente é igual ao número máximo de consultas simultâneas que o aplicativo executa. Elas são colocadas sobre todas as linhas de execução que o aplicativo usa para a própria lógica de negócios.

Não é recomendável aumentar o tamanho do pool de sessões além do número máximo de linhas de execução que uma única instância de aplicativo pode processar. Em vez disso, aumente o número de instâncias do aplicativo.

Gerenciar a fração de sessões de gravação

Para algumas bibliotecas de cliente, o Spanner reserva uma parte das sessões para transações de leitura e gravação, chamadas de fração de sessões de gravação. Se o app usar todas as sessões de leitura, o Spanner usará as sessões de leitura e gravação, mesmo para transações somente leitura. As sessões de leitura e gravação exigem spanner.databases.beginOrRollbackReadWriteTransaction. Se o usuário estiver no papel do IAM spanner.databaseReader, a chamada falhará e o Spanner retornará esta mensagem de erro:

generic::permission_denied: Resource %resource% is missing IAM permission:
spanner.databases.beginOrRollbackReadWriteTransaction

É possível definir a fração de sessões de gravação para as bibliotecas de cliente que mantêm uma fração de sessões de gravação.

Práticas recomendadas ao criar uma biblioteca de cliente ou usar REST/RPC

Veja a seguir as práticas recomendadas para implementar sessões em uma biblioteca de cliente do Spanner ou para usar sessões com as APIs REST ou RPC.

Essas práticas recomendadas se aplicam somente se você estiver desenvolvendo uma biblioteca de cliente ou se estiver usando APIs REST/RPC. Se você estiver usando uma das bibliotecas de cliente do Google para o Spanner, consulte Práticas recomendadas ao usar bibliotecas de cliente do Google.

Criar e dimensionar o pool de sessões

Para determinar um tamanho ideal do pool de sessões para um processo do cliente, defina o limite inferior para o número de transações simultâneas esperadas e defina o limite superior como um número de teste inicial, como 100. Se o limite superior não for adequado, aumente-o. Aumentar o número de sessões ativas usa recursos extras no serviço de banco de dados do Spanner. Portanto, não limpar sessões não utilizadas pode prejudicar o desempenho. Para usuários que trabalham com a API RPC, recomendamos não ter mais de 100 sessões por canal gRPC.

Lidar com sessões excluídas

Há três maneiras de excluir uma sessão:

• Um cliente pode excluir uma sessão.
• O serviço de banco de dados do Spanner pode excluir uma sessão quando ela fica inativa por mais de uma hora.
• O serviço de banco de dados do Spanner poderá excluir uma sessão se ela tiver mais de 28 dias.

As tentativas de usar uma sessão excluída resultam em NOT_FOUND. Se você encontrar esse erro, crie e use uma nova sessão, adicione-a ao pool e remova a sessão excluída do pool.

Manter uma sessão inativa operante

O serviço de banco de dados do Spanner reserva o direito de encerrar uma sessão não utilizada. É possível impedir que a sessão seja encerrada, se você precisar mesmo manter uma sessão inativa operante, por exemplo, se for esperado um aumento significativo de curto prazo no uso do banco de dados. Realizar uma operação de baixo custo, como executar a consulta SQL SELECT 1 para manter a sessão ativa. Se você tiver uma sessão inativa que não é necessária para uso a curto prazo, deixe o Spanner encerrar a sessão e criar uma nova sessão na próxima vez que for necessária.

Um cenário para manter as sessões ativas é lidar com a demanda de pico regular no banco de dados. Se ocorre um uso intenso do banco de dados diariamente das 9h às 18h, mantenha algumas sessões inativas disponíveis durante esse período, uma vez que elas provavelmente serão necessárias para o uso no horário de pico. Após as 18h, deixe o Spanner encerrar sessões inativas. Todos os dias, antes das 9h, crie algumas sessões novas para que elas estejam prontas para a demanda esperada.

Outro cenário é se você tem um aplicativo que usa o Spanner, mas precisa evitar a sobrecarga de conexão quando isso acontece. Mantenha um conjunto de sessões ativas para evitar que a sobrecarga de conexão aconteça.

Ocultar detalhes da sessão do usuário da biblioteca de cliente

Se você estiver criando uma biblioteca de cliente, não exponha sessões ao consumidor da biblioteca de cliente. Permita que o cliente faça chamadas de banco de dados sem a complexidade de criar e manter sessões. Para um exemplo de uma biblioteca de cliente que oculta os detalhes da sessão do consumidor, consulte a biblioteca de cliente do Spanner para Java.

Lidar com erros de transações de gravação que não sejam idempotentes

As transações de gravação sem proteção de repetição podem aplicar mutações mais de uma vez. Se uma mutação não é idempotente, uma mutação que é aplicada mais de uma vez pode resultar em uma falha. Por exemplo, uma inserção pode apresentar falha com ALREADY_EXISTS mesmo que a linha não exista antes da tentativa de gravação. Isso pode ocorrer se o servidor de back-end confirmou a mutação, mas não conseguiu comunicar o sucesso ao cliente. Nesse caso, a mutação poderia ser tentada novamente, resultando na falha ALREADY_EXISTS.

Estas são as formas possíveis de abordar esse cenário quando você implementa sua própria biblioteca de cliente ou usa a API REST:

• Estruturar suas gravações para que sejam idempotentes.
• Usar gravações com proteção contra repetição.
• Implementar um método que execute a lógica "upsert": inserir se for novo ou atualizar se existir.
• Lidar com o erro em nome do cliente.

Manter conexões estáveis

Para melhor desempenho, a conexão utilizada para hospedar uma sessão deve permanecer estável. Quando a conexão que hospeda uma sessão muda, o Spanner pode cancelar a transação ativa na sessão e causar uma pequena quantidade de carga extra no banco de dados enquanto atualiza os metadados da sessão. Não há problema se algumas conexões mudarem esporadicamente, mas devem ser evitadas situações em que um grande número de conexões mudam ao mesmo tempo. Se você usa um proxy entre o cliente e o Spanner, é necessário manter a estabilidade da conexão em cada sessão.

Monitorar sessões ativas

É possível usar o comando ListSessions para monitorar sessões ativas no seu banco de dados a partir da linha de comando, com a API REST ou a API RPC. ListSessions mostra as sessões ativas para um determinado banco de dados. Isso é útil se você precisar encontrar a causa de um vazamento de sessão. Um vazamento de sessão é um incidente em que as sessões estão sendo criadas, mas não retornadas a um pool de sessões para reutilização.

Com ListSessions, é possível ver metadados das suas sessões ativas, incluindo quando uma sessão foi criada e quando ela foi usada pela última vez. A análise desses dados o direcionará para a solução de problemas das sessões. Se a maioria das sessões ativas não tiver um approximate_last_use_time recente, isso pode indicar que as sessões não estão sendo reutilizadas corretamente pelo aplicativo. Consulte a referência da API RPC para mais informações sobre o campo approximate_last_use_time.

Para mais informações sobre como usar ListSessions, consulte a referência da API REST, a referência da API RPC ou a referência da ferramenta de linha de comando gcloud.

Limpeza automática de vazamentos de sessão.

Quando você usa todas as sessões no pool de sessões, cada nova transação aguarda até que uma sessão seja retornada ao pool. Quando as sessões são criadas, mas não retornadas ao pool de sessões para reutilização, isso é chamado de vazamento de sessão. Quando há um vazamento de sessão, as transações que aguardam uma sessão aberta ficam travadas indefinidamente e bloqueiam o aplicativo. Os vazamentos de sessões geralmente são causados por transações problemáticas que são executadas por muito tempo e não são confirmadas.

É possível configurar seu pool de sessões para resolver automaticamente essas transações inativas. Quando você ativa a biblioteca de cliente para resolver automaticamente a transição inativa, ela identifica transações problemáticas que podem causar um vazamento de sessão, as remove do pool de sessões e as substitui por uma nova sessão.

A geração de registros também pode ajudar a identificar essas transações problemáticas. Se a geração de registros estiver ativada, os registros de aviso serão compartilhados por padrão quando mais de 95% do pool de sessão estiver em uso. Se o uso da sessão for maior que 95%, será necessário aumentar o número máximo de sessões permitidas no pool de sessões ou pode ter um vazamento de sessão. Os registros de aviso contêm stack traces de transações que são executadas por mais tempo do que o esperado e podem ajudar a identificar a causa da alta utilização do pool de sessões. Os registros de aviso são enviados dependendo da configuração do exportador de registros.

Ative a biblioteca de cliente para resolver automaticamente transações inativas

É possível ativar a biblioteca de cliente para enviar registros de aviso e resolver automaticamente transações inativas ou permitir que a biblioteca de cliente receba apenas registros de avisos.

 final SessionPoolOptions sessionPoolOptions = SessionPoolOptions.newBuilder().setWarnAndCloseIfInactiveTransactions().build()

 final Spanner spanner =
         SpannerOptions.newBuilder()
             .setSessionPoolOption(sessionPoolOptions)
             .build()
             .getService();
 final DatabaseClient client = spanner.getDatabaseClient(databaseId);

 final SessionPoolOptions sessionPoolOptions = SessionPoolOptions.newBuilder().setWarnIfInactiveTransactions().build()

 final Spanner spanner =
         SpannerOptions.newBuilder()
             .setSessionPoolOption(sessionPoolOptions)
             .build()
             .getService();
 final DatabaseClient client = spanner.getDatabaseClient(databaseId);

 client, err := spanner.NewClientWithConfig(
     ctx, database, spanner.ClientConfig{SessionPoolConfig: spanner.SessionPoolConfig{
         InactiveTransactionRemovalOptions: spanner.InactiveTransactionRemovalOptions{
         ActionOnInactiveTransaction: spanner.WarnAndClose,
         }
     }},
 )
 if err != nil {
     return err
 }
 defer client.Close()

 customLogger := log.New(os.Stdout, "spanner-client: ", log.Lshortfile)
 // Create a logger instance using the golang log package
 cfg := spanner.ClientConfig{
         Logger: customLogger,
     }
 client, err := spanner.NewClientWithConfig(ctx, db, cfg)

Sessões multiplexadas

As sessões multiplexadas permitem criar um grande número de solicitações simultâneas em uma única sessão. Uma sessão multiplexada é um identificador que você usa em vários canais gRPC. Isso não gera outros gargalos. As sessões multiplexadas têm as seguintes vantagens:

• Consumo reduzido de recursos de back-end devido a um protocolo de gerenciamento de sessão mais simples. Por exemplo, elas evitam atividades de manutenção de sessão associadas à manutenção da propriedade da sessão e à coleta de lixo.
• Sessão de longa duração que não requer solicitações de sinal de atividade quando está inativa.

As sessões multiplexadas são compatíveis com os seguintes itens:

• as bibliotecas de cliente Java e Go

• Ferramentas do ecossistema do Spanner que dependem das bibliotecas de cliente Java e Go, como PGAdapter, JDBC, Hibernate, driver de banco de dados/sql e GORM.

• Ferramentas do ecossistema do Spanner que dependem das bibliotecas de cliente Java e Go, como PGAdapter, JDBC, Hibernate, driver de banco de dados ou SQL e GORM. Use as métricas do OpenTelemetry para ver como o tráfego é dividido entre o pool de sessões atual e a sessão multiplexada. O OpenTelemetry tem um filtro de métrica, is_multiplexed, que mostra sessões multiplexadas quando definido como true.

As sessões multiplexadas são compatíveis com todos os tipos de transações.

As bibliotecas de cliente alternam sessões multiplexadas a cada sete dias para evitar o envio de transações em sessões desatualizadas.

As sessões multiplexadas ficam desativadas por padrão. Você precisa usar variáveis de ambiente para ativar sessões multiplexadas antes de usá-las nos aplicativos clientes. Para ativar sessões multiplexadas usando Java ou Go, consulte Ativar sessões multiplexadas.

Considerações

Se você estiver tentando confirmar um corpo de transação de leitura ou gravação vazio ou uma transação em que todas as consultas ou instruções DML falharam, há alguns cenários a serem considerados com as sessões multiplexadas. As sessões multiplexadas exigem que você inclua um token de pré-confirmação gerado pelo servidor em cada solicitação de confirmação. Para transações que contenham consultas ou DML, é necessário que haja pelo menos uma consulta ou transação DML anterior bem-sucedida para que o servidor retorne um token válido à biblioteca de cliente. Se não houver consultas ou transações DML bem-sucedidas, a biblioteca de cliente adicionará SELECT 1 implicitamente antes de uma confirmação.

Para uma transação de leitura ou gravação em uma sessão multiplexada que tenha apenas mutações, se uma das mutações for para uma tabela ou uma coluna que NÃO existe no esquema, o cliente pode retornar um erro INVALID_ARGUMENT em vez de um erro NOT_FOUND.

Ativar sessões multiplexadas

Para usar sessões multiplexadas nos aplicativos cliente, primeiro defina uma variável de ambiente para ativá-la.

Para ativar sessões multiplexadas, defina a variável de ambiente GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS como TRUE. Essa sinalização também ativa a compatibilidade de sessões multiplexadas com transações ReadOnly.

export GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS=TRUE

Para ativar o suporte a operações particionadas para sessões multiplexadas, defina a variável de ambiente GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_PARTITIONED_OPS como TRUE.

export GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_PARTITIONED_OPS=TRUE

Para ativar o suporte a transações de leitura e gravação para sessões multiplexadas, defina a variável de ambiente GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_FOR_RW como TRUE.

export GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_FOR_RW=True

Defina GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS como TRUE como um pré-requisito para aceitar uma transação em uma sessão multiplexada.

Ver o tráfego de sessões regulares e multiplexadas

O Opentelemetry tem o filtro is_multiplexed para mostrar o tráfego de sessões multiplexadas. Defina esse filtro como true to view multiplexed sessions andfalse` para ver as sessões normais.

1. Configure a Opentelemetry do Spanner usando os procedimentos na seção Antes de começar.

2. Acesse o Metrics Explorer.

   Acessar o Metrics Explorer

3. No menu suspenso Métrica, filtre por generic.

4. Clique em Tarefa genérica e navegue até Spanner > Spanner/num_acquired_sessions.

5. No campo Filtro, selecione uma das seguintes opções:

   a. is_multiplexed = false para acessar as sessões normais. b. is_multiplexed = true para ver sessões multiplexadas.

   A imagem a seguir mostra a opção Filtrar com as sessões multiplexadas selecionadas.

Para mais informações sobre como usar o OpenTelemetry com o Spanner, consulte Como usar o OpenTelemetry para democratizar a observabilidade do Spanner e Examinar a latência em um componente do Spanner com o OpenTelemetry.