スループットを最適化した書き込み

このページでは、Spanner で書き込みのスループットを最適化するために、commit（書き込み）の最大遅延時間を構成する方法について説明します。

概要

データの整合性を維持するために、Spanner はデータベース内のすべての投票レプリカに書き込みリクエストを送信します。このレプリケーション プロセスには、計算のオーバーヘッドが発生する可能性があります。詳細については、レプリケーションをご覧ください。

スループットが最適化された書き込みには、一群の書き込みを同時に実行してこうした計算コストを平均化するオプションがあります。このオプションを実行すると、Spanner ではわずかな遅延が発生し、同じ投票参加者に送信する必要がある一群の書き込みがまとめられます。この方法で書き込みを実行すると、レイテンシはわずかに増加しますが、スループットを大幅に向上させることができます。

デフォルトの動作

commit の遅延時間を設定しない場合、Spanner によって書き込みのコストが平均化すると判断されるとわずかな遅延が設定されることがあります。

一般的なユースケース

書き込みリクエストの遅延時間は、アプリケーションのニーズに応じて手動で設定できます。commit の最大遅延時間を 0 ミリ秒に設定して、レイテンシの影響を受けやすいアプリケーションの commit の遅延を無効にすることもできます。

レイテンシの許容度が高いアプリケーションでスループットを最適化する場合、commit の遅延時間を長く設定すると、各書き込みのレイテンシが大きくなる一方でスループットが大幅に向上します。たとえば、大量のデータを一括で読み込む際に Spanner が個々のデータを書き込む速度が、アプリケーションにとって気にするものでない場合は、commit 遅延時間をより長い値（100 ミリ秒など）に設定できます。最初は 100 ミリ秒の値から始めて、レイテンシとスループットのトレードオフでニーズが満たされるまで増減して調整することをおすすめします。ほとんどのアプリケーションでは、20～100 ミリ秒の値が最適です。

レイテンシの影響を受けやすいアプリケーションの場合、Spanner もデフォルトではレイテンシの影響を受けます。ワークロードが急増すると、Spanner によってわずかな遅延が設定されることがあります。値を 0 ミリ秒に設定してテストすると、スループットは低下してもレイテンシの低減がアプリケーションにとって妥当なかどうかを判断できます。

commit 遅延時間が混在した設定を行う

書き込みのサブセットに対してさまざまな最大 commit 遅延時間を構成できます。これを行うと、Spanner は一連の書き込みで構成されている最短の遅延時間を使用します。ただし、ほとんどのユースケースでは、動作が予測しやすくなるため、単一の値を選択することをおすすめします。

制限事項

commit の遅延時間は 0～500 ミリ秒の間で設定できます。commit の遅延を 500 ミリ秒より長く設定するとエラーが発生します。

commit リクエストに最大 commit 遅延を設定する

最大 commit 遅延パラメータは、CommitRequest メソッドの一部です。このメソッドにアクセスするには、RPC API、REST API、または Cloud Spanner クライアント ライブラリを使用します。

Go

import (
	"context"
	"fmt"
	"io"
	"time"

	"cloud.google.com/go/spanner"
)

// maxCommitDelay sets the maximum commit delay for a transaction.
func maxCommitDelay(w io.Writer, db string) error {
	// db = `projects/<project>/instances/<instance-id>/database/<database-id>`
	ctx := context.Background()
	client, err := spanner.NewClient(ctx, db)
	if err != nil {
		return fmt.Errorf("maxCommitDelay.NewClient: %w", err)
	}
	defer client.Close()

	// Set the maximum commit delay to 100ms.
	// This is the amount of latency this request is willing to incur in order
	// to improve throughput. If this field is not set, Spanner assumes requests
	// are relatively latency sensitive and automatically determines an
	// appropriate delay time. You can specify a batching delay value between 0 and 500 ms.
	// The transaction will also return the commit statistics.
	commitDelay := 100 * time.Millisecond
	resp, err := client.ReadWriteTransactionWithOptions(ctx, func(ctx context.Context, txn *spanner.ReadWriteTransaction) error {
		stmt := spanner.Statement{
			SQL: `INSERT Singers (SingerId, FirstName, LastName)
					VALUES (111, 'Virginia', 'Watson')`,
		}
		rowCount, err := txn.Update(ctx, stmt)
		if err != nil {
			return err
		}
		fmt.Fprintf(w, "%d record(s) inserted.\n", rowCount)
		return nil
	}, spanner.TransactionOptions{CommitOptions: spanner.CommitOptions{MaxCommitDelay: &commitDelay, ReturnCommitStats: true}})
	if err != nil {
		return fmt.Errorf("maxCommitDelay.ReadWriteTransactionWithOptions: %w", err)
	}
	fmt.Fprintf(w, "%d mutations in transaction\n", resp.CommitStats.MutationCount)
	return nil
}

Node.js

// Imports the Google Cloud client library.
const {Spanner, protos} = require('@google-cloud/spanner');

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// const projectId = 'my-project-id';
// const instanceId = 'my-instance';
// const databaseId = 'my-database';

// Creates a client.
const spanner = new Spanner({
  projectId: projectId,
});

async function spannerSetMaxCommitDelay() {
  // Gets a reference to a Cloud Spanner instance and database.
  const instance = spanner.instance(instanceId);
  const database = instance.database(databaseId);

  database.runTransaction(async (err, transaction) => {
    if (err) {
      console.error(err);
      return;
    }
    try {
      const [rowCount] = await transaction.runUpdate({
        sql: 'INSERT Singers (SingerId, FirstName, LastName) VALUES (111, @firstName, @lastName)',
        params: {
          firstName: 'Virginia',
          lastName: 'Watson',
        },
      });

      console.log(
        `Successfully inserted ${rowCount} record into the Singers table.`
      );

      await transaction.commit({
        // The maximum amount of time to delay the transaction to improve
        // throughput.
        maxCommitDelay: protos.google.protobuf.Duration({
          seconds: 0, // 0 seconds
          nanos: 100000000, // 100,000,000 nanoseconds = 100 milliseconds
        }),
      });
    } catch (err) {
      console.error('ERROR:', err);
    } finally {
      // Close the database when finished.
      database.close();
    }
  });
}
spannerSetMaxCommitDelay();

Python

# instance_id = "your-spanner-instance"
# database_id = "your-spanner-db-id"
spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

def insert_singers(transaction):
    row_ct = transaction.execute_update(
        "INSERT Singers (SingerId, FirstName, LastName) "
        " VALUES (111, 'Grace', 'Bennis')"
    )

    print("{} record(s) inserted.".format(row_ct))

database.run_in_transaction(
    insert_singers, max_commit_delay=datetime.timedelta(milliseconds=100)
)

Ruby

require "google/cloud/spanner"

##
# This is a snippet for showcasing how to pass max_commit_delay in  commit_options.
#
# @param project_id  [String] The ID of the Google Cloud project.
# @param instance_id [String] The ID of the spanner instance.
# @param database_id [String] The ID of the database.
#
def spanner_set_max_commit_delay project_id:, instance_id:, database_id:
  # Instantiates a client
  spanner = Google::Cloud::Spanner.new project: project_id
  client  = spanner.client instance_id, database_id

  records = [
    { SingerId: 1, AlbumId: 1, MarketingBudget: 200_000 },
    { SingerId: 2, AlbumId: 2, MarketingBudget: 400_000 }
  ]
  # max_commit_delay is the amount of latency in millisecond, this request
  # is willing to incur in order to improve throughput.
  # The commit delay must be at least 0ms and at most 500ms.
  # Default value is nil.
  commit_options = {
    return_commit_stats: true,
    max_commit_delay: 100
  }
  resp = client.upsert "Albums", records, commit_options: commit_options
  puts "Updated data with #{resp.stats.mutation_count} mutations."
end

書き込みリクエストのレイテンシをモニタリングする

Google Cloud コンソールを使用して、Spanner の CPU 使用率とレイテンシをモニタリングできます。書き込みリクエストの遅延時間を長く設定すると、レイテンシが増加するのに対し、CPU 使用率は減少する可能性があります。Spanner リクエストのレイテンシの詳細については、Spanner API リクエストのレイテンシをキャプチャして可視化するをご覧ください。