会话

本页面介绍了 Spanner 中的会话高级概念,包括创建客户端库、使用 REST 或 RPC API 或使用 Google 客户端库时的会话最佳实践。

会话概览

会话代表与 Spanner 数据库服务的通信渠道。会话用于执行事务来读取、写入或修改 Spanner 数据库中的数据。每个会话只应用于单个数据库。

会话一次只能执行一个事务。独立读取、写入和查询在内部使用事务,并计入一个事务限制。

会话池的性能优势

创建会话的开销很大。为了避免每次进行数据库操作时导致性能下降,客户端应保留一个会话池,这是可供使用的可用会话池。该池应存储现有会话,并在请求时返回适当类型的会话,并清理未使用的会话。如需查看有关如何实现会话池的示例,请参阅其中一个 Spanner 客户端库(例如 Go 客户端库Java 客户端库)的源代码。

会话设计为长期有效,因此在某个会话用于数据库操作之后,客户端应将会话返回池中以供重复使用。

gRPC 渠道概览

Spanner 客户端使用 gRPC 通道进行通信。一个 gRPC 通道大致相当于 TCP 连接。一个 gRPC 通道最多可处理 100 个并发请求。这意味着应用需要的 gRPC 通道数至少为应用将执行的并发请求数量除以 100 所得的值。

Spanner 客户端会在创建时创建 gRPC 通道池。

使用 Google 客户端库时的最佳做法

下面介绍了使用适用于 Spanner 的 Google 客户端库时的最佳实践。

配置池中的会话数和 gRPC 通道数

客户端库在会话池中具有默认会话数,在渠道池中具有默认 gRPC 通道数。在大多数情况下,这两个默认值已经足够。以下是默认的最小和最大会话数,以及每种编程语言的默认 gRPC 通道数。

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

Node.js 客户端不支持多个 gRPC 通道。因此,建议您创建多个客户端,而不是将单个客户端的会话池大小增加到超过 100 个。

MinSessions: 25
MaxSessions: 100

PHP

PHP 客户端不支持可配置数量的 gRPC 通道。

MinSessions: 1
MaxSessions: 500

Python

Python 支持四种不同的会话池类型,可用于管理会话。

Ruby

Ruby 客户端不支持多个 gRPC 通道。因此,建议您创建多个客户端,而不是将单个客户端的会话池大小增加到超过 100 个。

MinSessions: 10
MaxSessions: 100

应用使用的会话数等于应用执行的并发事务数量。仅当您希望单个应用实例执行的并发事务数量超出默认会话池能够处理的事务数量时,才应修改默认会话池设置。

对于高并发应用,建议执行以下操作:

  1. MinSessions 设置为单个客户端将执行的预期并发事务数量。
  2. MaxSessions 设置为单个客户端可以执行的并发事务数上限。
  3. 如果预期的并发设置在应用生命周期内没有发生太大变化,请设置 MinSessions=MaxSessions。这可以防止会话池纵向扩容或缩容。扩大或缩小会话池也会消耗一些资源。
  4. NumChannels 设置为 MaxSessions / 100。一个 gRPC 通道最多可同时处理 100 个请求。如果您观察到高尾延迟时间(p95/p99 延迟时间),请增加此值,因为这可能表明 gRPC 通道拥塞。

增加活跃会话数会使用 Spanner 数据库服务和客户端库中的更多资源。如果增加的会话数超出应用的实际需求,可能会降低系统的性能。

增加会话池与增加客户端数量

应用的会话池大小决定了单个应用实例可以执行的并发事务数量。建议不要将会话池大小增加到单个应用实例可以处理的最大并发数上限。如果应用收到的大量请求超过了会话池中的会话数,系统就会在等待会话可用时将这些请求排入队列。

客户端库使用的资源如下:

  1. 每个 gRPC 通道都使用一个 TCP 连接。
  2. 每次 gRPC 调用都需要一个线程。客户端库使用的最大线程数等于应用执行的最大并发查询数。这些线程位于应用用于自身业务逻辑的任何线程之上。

建议不要将会话池的大小增加到单个应用实例可以处理的最大线程数之外。而应增加应用实例的数量。

管理写入会话比例

对于某些客户端库,Spanner 会为读写事务预留一部分会话,称为写入会话比例。如果您的应用用尽所有读取会话,则 Spanner 会使用读写会话,即使对于只读事务也是如此。读写会话需要 spanner.databases.beginOrRollbackReadWriteTransaction 权限。如果用户具有 spanner.databaseReader IAM 角色,则调用失败,并且 Spanner 会返回以下错误消息:

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

对于维持写入会话比例的客户端库,您可以对其进行设置。

C++

所有 C ++ 会话都相同。没有只读或只读写会话。

C#

C# 的默认写入会话比例是 0.2。您可以使用 SessionPoolOptions 的 WriteSessionsFraction 字段更改比例。

Go

所有 Go 会话都是相同的。没有只读或只读写会话。

Java

所有 Java 会话都相同。没有只读或只读写会话。

Node.js

所有 Node.js 会话都相同。没有只读或只读写会话。

PHP

所有 PHP 会话都是相同的。没有只读或只读写会话。

Python

Python 支持四种不同的会话池类型,可用于管理读取和读写会话。

Ruby

Ruby 的默认写入会话比例是 0.3。您可以使用 client 初始化方法更改比例。

创建客户端库或使用 REST/RPC 时的最佳做法

下文介绍了在 Spanner 客户端库中实现会话或通过 RESTRPC API 使用会话的最佳实践。

这些最佳做法仅在您开发客户端库或使用 REST/RPC API 的情况下适用。如果您使用的是 Spanner 的某个 Google 客户端库,请参阅使用 Google 客户端库时的最佳做法

创建会话池并确定其大小

如需确定客户端进程的最佳会话池大小,请将下限设置为预期的并发事务数,并将上限设置为初始测试数,例如 100。如果上限不够,请提高上限。增加活跃会话数会消耗 Spanner 数据库服务上的更多资源,因此未能清理未使用的会话可能会降低性能。对于使用 RPC API 的用户,我们建议每个 gRPC 通道的会话数不超过 100。

处理已删除的会话

可以通过以下三种方式删除会话:

  • 客户端可以删除会话。
  • Spanner 数据库服务可以在会话闲置超过 1 小时后删除会话。
  • 如果会话的存在时间超过 28 天,则 Spanner 数据库服务可能会删除会话。

尝试使用已删除的会话会导致 NOT_FOUND。如果遇到此错误,请创建并使用新的会话,将新会话添加到池中,并从池中移除已删除的会话。

使空闲会话保持活跃状态

Spanner 数据库服务保留删除未使用的会话的权利。如果您确实需要让空闲会话保持活跃状态,例如,在预计数据库使用近期内会显著增长的情况下,您可以防止会话被删除。执行开销较小的操作(例如,执行 SQL 查询 SELECT 1)可使会话保持活跃状态。如果您有近期不需要的空闲会话,请让 Spanner 丢弃该会话,然后在下次需要会话时创建一个新会话。

让会话保持活跃状态的一种情形是应对数据库上的常规峰值需求。如果每天的上午 9:00 到下午 6:00 大量使用数据库,则应在这段时间内保留一些空闲会话,因为高峰使用期间可能需要这些会话。下午 6:00 之后,您可以让 Spanner 删除空闲会话。在每天上午 9:00 之前,请创建一些新会话,以便它们能够满足预期需求。

另一种情况是,您的应用使用 Spanner,但在使用 Spanner 时必须避免连接开销。您可以将一组会话保持活动状态以避免连接开销。

向客户端库用户隐藏会话详细信息

如果您要创建客户端库,请勿向客户端库使用方公开会话。让客户端能够进行数据库调用,但无需涉及会话创建和维护的复杂性。如需查看对客户端库使用者隐藏会话详细信息的客户端库示例,请参阅 Java 版 Spanner 客户端库。

处理非幂等写入事务的错误

没有重试保护的写入事务可能会多次应用变更。 如果某一变更不具有幂等性,则多次应用变更可能会导致失败。例如,即使在写入尝试之前某行不存在,插入操作也可能会失败并出现 ALREADY_EXISTS 错误。如果后端服务器提交了变更但无法将成功信息传达给客户端,则可能发生这种情况。在这种情况下,可能会重试变更,导致 ALREADY_EXISTS 失败。

在实现您自己的客户端库或使用 REST API 时,可以采用以下方法来应对这种情况:

  • 设计您的写入代码结构,使其具有幂等性。
  • 对写入使用重试保护。
  • 实现一个执行“upsert”逻辑的方法:若是新的则插入,若已存在则更新。
  • 代替客户端处理错误。

保持稳定连接

为获得最佳性能,用于承载会话的连接应保持稳定。当托管会话的连接发生更改时,Spanner 可能会中止会话上的活动事务,并在更新会话元数据时给数据库造成少量的额外负载。少数连接偶尔发生变化是无关紧要的,但应避免同时更改大量连接的情况。如果您在客户端和 Spanner 之间使用代理,则应保持每个会话的连接稳定性。

监控活跃会话

您可以从命令行、通过 REST APIRPC API 使用 ListSessions 命令,监控数据库中的活跃会话。ListSessions 可显示给定数据库的活跃会话。如果您需要查明会话泄漏的原因,这一命令非常有用。(会话泄漏是指系统创建会话但未将其返回到会话池以供重复使用的事件。)

借助 ListSessions,您能够查看有关活跃会话的元数据,包括创建会话的时间以及上次使用会话的时间。在排查会话问题时,分析此数据可以为您指明正确的方向。如果大多数活跃会话没有最近的 approximate_last_use_time,这可能表明会话没有被您的应用合理地重复使用。如需详细了解 approximate_last_use_time 字段,请参阅 RPC API 参考文档

如需详细了解如何使用 ListSessions,请参阅 REST API 参考文档RPC API 参考文档gcloud 命令行工具参考文档

自动清理会话泄露

使用会话池中的所有会话时,每个新事务都会等待会话返回池。如果会话已创建但未返回到会话池以供重复使用,这种情况称为会话泄露。发生会话泄漏时,等待打开会话的事务将无限期地卡住并阻止应用。会话泄漏通常是由运行时间过长且未提交的有问题事务所导致。

您可以设置会话池来自动解决这些非活跃事务。如果您启用客户端库来自动解决非活跃转换,它会识别可能导致会话泄露的有问题的事务,将其从会话池中移除,并将它们替换为新会话。

Logging 还可以帮助识别这些有问题的事务。如果启用了日志记录,则当会话池的使用量超过 95% 时,系统会默认分享警告日志。如果您的会话使用率超过 95%,则需要提高会话池中允许的会话数上限,或者可能会出现会话泄露。警告日志包含运行时间超出预期时间的事务的堆栈轨迹,有助于确定会话池利用率过高的原因。系统会根据您的日志导出器配置推送警告日志。

启用客户端库以自动解决非活跃事务

您可以启用客户端库以发送警告日志并自动解决非活跃事务,也可以使客户端库仅接收警告日志。

Java

如需接收警告日志并移除非活跃事务,请使用 setWarnAndCloseIfInactiveTransactions

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

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

如需仅接收警告日志,请使用 setWarnIfInactiveTransactions

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

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

Go

如需接收警告日志并移除非活跃事务,请结合使用 SessionPoolConfigInactiveTransactionRemovalOptions

 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

 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)