概要
Key Visualizer は、デフォルトで有効になっています。
データが Key Visualizer ですぐに利用できないこともあります。
- 新しく作成されたデータベースのストレージとトラフィックの統計情報は、すぐに利用できない場合があります。
- 新しく挿入された行のトラフィックの統計情報は、既存のキー範囲に起因している場合があります。
始める前に
Key Visualizer を表示するには、次のものが必要です。
きめ細かいアクセス制御ユーザーの場合、
spanner_sys_readerシステムロールまたはそのメンバーのロールのいずれかへのアクセス権が付与されている必要があります。きめ細かいアクセス制御ユーザーでない場合は、次の Identity and Access Management（IAM）権限が必要です。
spanner.databases.read
詳細については、きめ細かいアクセス制御についてときめ細かいアクセス制御システムのロールをご覧ください。
Key Visualizer のインターフェース
Key Visualizer ツールは、Google Cloud コンソールからアクセスします。
Key Visualizer にアクセスするには、次のようにします。
Google Cloud コンソールの Spanner ページで、インスタンスを選択します。
調査するデータベースを選択します。
きめ細かいアクセス制御ユーザーのみ: データベースの [概要] ページの [現在のロール] フィールドに、
spanner_sys_readerシステムロールまたはspanner_sys_readerのメンバー（またはメンバーの子）であるロールを指定します。詳細については、きめ細かいアクセス制御についてときめ細かいアクセス制御システムのロールをご覧ください。
左側のナビゲーション メニューの [オブザーバビリティ] で、[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 を再度有効にするには、Key Visualizer の無効化の手順に沿って、enable_key_visualizer データベース オプションの値を true に設定します。
データベースに対して初めて再度有効にすると、Key Visualizer ヒートマップは、Cloud Spanner が指標を収集する最初の数分間、空になります。
次のステップ
- ヒートマップの共通パターンを認識する。
- ヒートマップの確認方法を学習する。
- ヒートマップで確認できる指標について読む。