Key Visualizer は、Spanner でデフォルトで有効になっています。
始める前に
Key Visualizer を表示するには、次の Identity and Access Management（IAM）権限が必要です。
spanner.databases.read
細かいアクセス制御をするユーザーの場合は、以下に対するアクセス権が付与されている必要があります。
spanner_sys_readerシステムロールまたはそのメンバーのロールのいずれか。
詳細については、細かいアクセス制御についてと細かいアクセス制御システムのロールをご覧ください。
Key Visualizer インターフェースにアクセスする
Key Visualizer ツールには、Google Cloud コンソールからアクセスできます。
Key Visualizer にアクセスするには、次のようにします。
Google Cloud コンソールの Spanner ページで、インスタンスを選択します。
調査するデータベースを選択します。
左側ナビゲーション メニューの [オブザーバビリティ] で、[Key Visualizer] を選択します。
Key Visualizer の無効化
Key Visualizer は、enable_key_visualizer データベース オプションで制御します。デフォルト値は true です。
Key Visualizer を無効にするには、enable_key_visualizer データベース オプションの値を false に設定します。Key Visualizer を無効にする DDL 構文は次のとおりです。
ALTER DATABASE `database_id` SET OPTIONS (enable_key_visualizer=false)
データベース ID に文字、数字、アンダースコア以外の文字が含まれている場合は、ID をバッククォート（`）で囲んでください。
ステートメントは、gcloud コマンドか、UpdateDatabaseDdl gRPC / REST リクエストで送信できます。次に例を示します。
gcloud spanner databases ddl update database_id --instance=instance_id \
--ddl='ALTER DATABASE `database_id` SET OPTIONS ( enable_key_visualizer=false )'
enable_key_visualizer の値を明示的に設定したら、概要ページで [同等のDDLを表示] をクリックするか、ddl describe gcloud コマンドを使用すると、値を確認できます。
gcloud spanner databases ddl describe `database_id` --instance=instance_id
Key Visualizer の再有効化
Key Visualizer を再度有効にするには、前述の手順に沿って、enable_key_visualizer データベース オプションの値を true に設定します。
データベースに対して初めて再度有効にすると、Key Visualizer ヒートマップは、Cloud Spanner が指標を収集する最初の数分間、空になります。
次のステップ
- ヒートマップの共通パターンを認識する。
- ヒートマップの確認方法を学習する。
- ヒートマップで確認できる指標について読む。