Sessões

Nesta página, descrevemos o conceito avançado de sessões no Spanner, incluindo as 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.

Com as sessões é possível executar apenas uma transação por vez. Leituras, gravações e consultas independentes usam uma transação internamente e contam para o limite de uma transação.

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, ou seja, um conjunto de sessões disponíveis prontas para uso. O pool armazenará as sessões atuais e retornará o tipo adequado de sessão quando solicitado, além de lidar com a limpeza de sessões não usadas. 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 são 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 Spanner para comunicação. Um canal gRPC é aproximadamente equivalente a uma conexão TCP. Um canal gRPC pode processar até 100 solicitações simultâneas. Isso significa que um aplicativo precisará de, no mínimo, o número de canais gRPC que o aplicativo executará, dividido por 100.

O cliente Spanner vai criar um pool de canais gRPC quando for criado.

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 pool de sessões e um número padrão de canais gRPC no pool de canais. Os dois 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.

C++

MinSessions: 100
MaxSessions: 400
NumChannels: 4

C#

MinSessions: 100
MaxSessions: 400
NumChannels: 4

Go

MinSessions: 100
MaxSessions: 400
NumChannels: 4

Java

MinSessions: 100
MaxSessions: 400
NumChannels: 4

Node.js

O cliente Node.js não oferece suporte a vários canais gRPC. Portanto, é recomendável criar vários clientes em vez de aumentar o tamanho do pool de sessões além de 100 sessões para um único cliente.

MinSessions: 25
MaxSessions: 100

PHP

O cliente PHP não oferece suporte a um número configurável de canais gRPC.

MinSessions: 1
MaxSessions: 500

Python

O Python é compatível com quatro tipos de pool de sessões que podem ser usados para gerenciar sessões.

Ruby

O cliente Ruby não oferece suporte a vários canais gRPC. Portanto, é recomendável criar vários clientes em vez de aumentar o tamanho do pool de sessões além de 100 sessões para um único cliente.

MinSessions: 10
MaxSessions: 100

O número de sessões usadas pelo aplicativo é 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 você espera que uma única instância de aplicativo execute mais transações simultâneas do que o pool de sessão padrão pode processar.

Para aplicativos de alta simultaneidade, recomenda-se 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 impede que o pool de sessões aumente ou diminua. O escalonamento do pool de sessões para mais ou para menos 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 alta latência de cauda (latência P95/p99), porque isso pode ser uma indicação de congestionamento do canal do 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 conjunto de sessões em vez de 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 receber um burst de solicitações que exceda o número de sessões no pool, elas serão colocadas em fila enquanto aguardam a disponibilização de uma sessão.

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

1. Cada canal gRPC usa uma conexão TCP.
2. Cada invocação do 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. Essas linhas de execução ocorrem em 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/gravação, chamada 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.

C++

Todas as sessões em C ++ são iguais. Não há sessões somente de leitura ou sessões de leitura e gravação.

C#

A fração padrão de sessões de gravação para C# é 0,2. É possível alterar a fração usando o campo WriteSessionsFraction de SessionPoolOptions.

Go

Todas as sessões do Go são iguais. Não há sessões somente de leitura ou sessões de leitura e gravação.

Java

Todas as sessões do Java são iguais. Não há sessões somente de leitura ou sessões de leitura e gravação.

Node.js

Todas as sessões do Node.js são iguais. Não há sessões somente de leitura ou sessões de leitura e gravação.

PHP

Todas as sessões do PHP são as mesmas. Não há sessões somente de leitura ou sessões de leitura e gravação.

Python

O Python é compatível com quatro tipos diferentes de tipos de pool de sessões, que podem ser usados para gerenciar sessões de leitura e sessões de leitura e gravação.

Ruby

A fração padrão de sessões de gravação para Ruby é 0.3. Para alterar a fração, use o método de inicialização do cliente.

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 as 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 de cliente, defina o limite inferior para o número de transações simultâneas esperadas e 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 as 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 nova sessão ao pool e remova a sessão excluída dele.

Manter uma sessão inativa operante

O serviço de banco de dados do Spanner reserva-se 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 em curto prazo, deixe o Spanner encerrar a sessão e, em seguida, crie 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, é possível deixar 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. 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 ver um exemplo de uma biblioteca de cliente que oculta os detalhes da sessão do consumidor da biblioteca de cliente, 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 é alterada, o Spanner pode cancelar a transação ativa na sessão e causar uma pequena quantidade de carga extra no banco de dados enquanto ele 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ê usar um proxy entre o cliente e o Spanner, precisará 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 banco de dados a partir da linha de comando, com a API REST ou com a API RPC. ListSessions mostra as sessões ativas de um determinado banco de dados. Isso é útil se você precisa 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 o recurso ListSessions, você visualiza metadados sobre suas sessões ativas, incluindo quando uma sessão foi criada e quando uma sessão foi usada pela última vez. Analisar esses dados vai lhe mostrar a direção certa na hora de solucionar problemas. 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 seu aplicativo. Veja a Referência da API RPC para mais informações sobre approximate_last_use_time campo.

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 da sessão.

Visualização — Automatic cleanup of session leaks

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Quando você usa todas as sessões no seu 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 presas indefinidamente e bloqueiam o aplicativo. Os vazamentos de sessão geralmente são causados por transações problemáticas que estão em execução há 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%, você precisará aumentar o número máximo de sessões permitidas no pool de sessões ou poderá ter vazamento de sessão. Os registros de avisos 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 por push dependendo da configuração do exportador de registros.

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

É possível permitir que a biblioteca de cliente envie registros de aviso e resolva automaticamente transações inativas ou permitir que a biblioteca de cliente receba apenas registros de aviso.

Java

Para receber registros de aviso e remover transações inativas, use setWarnAndCloseIfInactiveTransactions.

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

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

Para receber apenas registros de avisos, use setWarnIfInactiveTransactions.

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

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

Go

Para receber registros de aviso e remover transações inativas, use SessionPoolConfig com InactiveTransactionRemovalOptions.

 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()

Para receber apenas registros de aviso, use customLogger.

 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)